mirror of
https://github.com/navidrome/navidrome.git
synced 2026-05-03 06:51:16 +00:00
157 lines
4.3 KiB
Markdown
157 lines
4.3 KiB
Markdown
# 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 XTP CLI (recommended)
|
|
|
|
```bash
|
|
xtp plugin build
|
|
```
|
|
|
|
### Using TinyGo
|
|
|
|
```bash
|
|
tinygo build -target wasip1 -buildmode=c-shared -o dist/plugin.wasm .
|
|
```
|
|
|
|
### Using the Makefile
|
|
|
|
From the `plugins/examples` directory:
|
|
|
|
```bash
|
|
make wikimedia.wasm
|
|
```
|
|
|
|
## Installation
|
|
|
|
Copy the `.wasm` file to your Navidrome plugins folder:
|
|
|
|
```bash
|
|
cp dist/plugin.wasm /path/to/navidrome/plugins/wikimedia.wasm
|
|
```
|
|
|
|
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,spotify,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
|
|
```
|
|
|
|
Run these commands from the `plugins/examples` directory.
|
|
|
|
### Test the manifest
|
|
|
|
```bash
|
|
extism call wikimedia.wasm nd_manifest --wasi
|
|
```
|
|
|
|
Expected output:
|
|
```json
|
|
{"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","allowedHosts":["query.wikidata.org","dbpedia.org","en.wikipedia.org"]}}}
|
|
```
|
|
|
|
### Test artist URL lookup
|
|
|
|
```bash
|
|
# 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 |
|
|
|
|
## License
|
|
|
|
Same as Navidrome - GPL-3.0
|