initial commit
This commit is contained in:
@@ -0,0 +1,56 @@
|
||||
name: Build and Push Docker Image
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main, master]
|
||||
tags: ['v*']
|
||||
pull_request:
|
||||
branches: [main, master]
|
||||
|
||||
env:
|
||||
REGISTRY: ghcr.io
|
||||
IMAGE_NAME: ${{ github.repository }}
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Log in to Container Registry
|
||||
if: github.event_name != 'pull_request'
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ${{ env.REGISTRY }}
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Extract metadata
|
||||
id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
||||
tags: |
|
||||
type=ref,event=branch
|
||||
type=ref,event=pr
|
||||
type=semver,pattern={{version}}
|
||||
type=semver,pattern={{major}}.{{minor}}
|
||||
type=sha
|
||||
|
||||
- name: Build and push
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
context: .
|
||||
push: ${{ github.event_name != 'pull_request' }}
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
@@ -0,0 +1,5 @@
|
||||
node_modules/
|
||||
dist/
|
||||
*.log
|
||||
.env
|
||||
.DS_Store
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
FROM node:20-slim AS builder
|
||||
WORKDIR /app
|
||||
COPY package.json tsconfig.json ./
|
||||
RUN npm install
|
||||
COPY src/ ./src/
|
||||
RUN npm run build
|
||||
|
||||
FROM node:20-slim
|
||||
WORKDIR /app
|
||||
COPY package.json ./
|
||||
RUN npm install --omit=dev
|
||||
COPY --from=builder /app/dist ./dist
|
||||
EXPOSE 8080
|
||||
HEALTHCHECK --interval=30s --timeout=5s --start-period=5s --retries=3 \
|
||||
CMD node -e "require('http').get('http://localhost:8080/health', (r) => process.exit(r.statusCode === 200 ? 0 : 1))"
|
||||
CMD ["node", "dist/index.js"]
|
||||
@@ -0,0 +1,76 @@
|
||||
# MetaMesh Plugin: Jellyfin NFO
|
||||
|
||||
A MetaMesh plugin that parses Jellyfin/Kodi NFO metadata files.
|
||||
|
||||
## Description
|
||||
|
||||
This plugin parses XML-based NFO metadata files used by Jellyfin, Kodi, and other media managers. It extracts:
|
||||
|
||||
- **Movie/TV show metadata**: title, year, rating, plot
|
||||
- **External IDs**: IMDB, TMDB, AniDB
|
||||
- **Categories**: genres, studios, tags
|
||||
|
||||
The plugin looks for:
|
||||
- `{filename}.nfo` - File-specific metadata
|
||||
- `tvshow.nfo` - Series-level metadata in the same directory
|
||||
|
||||
## Metadata Fields
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| `videoType` | `movie` or `tvshow` |
|
||||
| `originalTitle` | Original title from NFO |
|
||||
| `season` | Season number |
|
||||
| `episode` | Episode number |
|
||||
| `movieYear` | Release year |
|
||||
| `rating` | User rating |
|
||||
| `imdbid` | IMDB ID |
|
||||
| `tmdbid` | TMDB ID |
|
||||
| `anidbid` | AniDB ID |
|
||||
| `plot/{lang}` | Plot description (language detected) |
|
||||
| `genres` | Genre set |
|
||||
| `studio` | Production studio set |
|
||||
| `tags` | Tag set |
|
||||
|
||||
## Dependencies
|
||||
|
||||
- Requires `file-info` and `filename-parser` plugins
|
||||
|
||||
## Configuration
|
||||
|
||||
No configuration required.
|
||||
|
||||
## API Endpoints
|
||||
|
||||
| Endpoint | Method | Description |
|
||||
|----------|--------|-------------|
|
||||
| `/health` | GET | Health check |
|
||||
| `/manifest` | GET | Plugin manifest |
|
||||
| `/configure` | POST | Update configuration |
|
||||
| `/process` | POST | Process a file |
|
||||
|
||||
## Running Locally
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run build
|
||||
npm start
|
||||
```
|
||||
|
||||
## Docker
|
||||
|
||||
```bash
|
||||
docker build -t metamesh-plugin-jellyfin-nfo .
|
||||
docker run -p 8080:8080 metamesh-plugin-jellyfin-nfo
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
| Variable | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `PORT` | `8080` | HTTP server port |
|
||||
| `HOST` | `0.0.0.0` | HTTP server host |
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"name": "@metazla/plugin-jellyfin-nfo",
|
||||
"version": "1.0.0",
|
||||
"description": "MetaMesh plugin: Parses Jellyfin/Kodi NFO files",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
"scripts": { "build": "tsc", "start": "node dist/index.js" },
|
||||
"dependencies": { "fastify": "^5.0.0", "xml2js": "^0.6.2", "franc-min": "^6.2.0" },
|
||||
"devDependencies": { "@types/node": "^20.0.0", "@types/xml2js": "^0.4.14", "typescript": "^5.3.0" }
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
import Fastify from 'fastify';
|
||||
import type { HealthResponse, ProcessRequest, ProcessResponse, CallbackPayload, ConfigureRequest, ConfigureResponse } from './types.js';
|
||||
import { manifest, process as processFile } from './plugin.js';
|
||||
|
||||
const app = Fastify({ logger: true });
|
||||
let ready = false;
|
||||
|
||||
app.get('/health', async (): Promise<HealthResponse> => ({ status: 'healthy', ready, version: manifest.version }));
|
||||
app.get('/manifest', async () => manifest);
|
||||
app.post<{ Body: ConfigureRequest }>('/configure', async (request): Promise<ConfigureResponse> => {
|
||||
console.log(`[${manifest.id}] Configuration updated`);
|
||||
return { status: 'ok' };
|
||||
});
|
||||
app.post<{ Body: ProcessRequest }>('/process', async (request, reply) => {
|
||||
const { taskId, cid, filePath, callbackUrl, metaCoreUrl } = request.body;
|
||||
if (!taskId || !cid || !filePath || !callbackUrl || !metaCoreUrl) {
|
||||
return reply.send({ status: 'rejected', error: 'Missing required fields' } as ProcessResponse);
|
||||
}
|
||||
processFile(request.body, async (payload: CallbackPayload) => {
|
||||
try { await fetch(callbackUrl, { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify(payload) }); }
|
||||
catch (error) { console.error(`[${manifest.id}] Callback error:`, error); }
|
||||
}).catch(console.error);
|
||||
return reply.send({ status: 'accepted' } as ProcessResponse);
|
||||
});
|
||||
|
||||
const port = parseInt(process.env.PORT || '8080', 10);
|
||||
app.listen({ port, host: '0.0.0.0' }).then(() => { ready = true; console.log(`[${manifest.id}] Listening on port ${port}`); });
|
||||
process.on('SIGTERM', async () => { ready = false; await app.close(); process.exit(0); });
|
||||
@@ -0,0 +1,73 @@
|
||||
/**
|
||||
* meta-core API Client for writing metadata
|
||||
* Fails gracefully if meta-core is unavailable (logs warning, returns without throwing)
|
||||
*/
|
||||
|
||||
export class MetaCoreClient {
|
||||
constructor(private baseUrl: string) {}
|
||||
|
||||
private async safeFetch(url: string, options: RequestInit): Promise<Response | null> {
|
||||
try {
|
||||
return await fetch(url, { ...options, signal: AbortSignal.timeout(5000) });
|
||||
} catch (error) {
|
||||
console.warn(`[MetaCoreClient] Warning: meta-core unavailable at ${this.baseUrl}`);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
async setProperty(hashId: string, key: string, value: string): Promise<void> {
|
||||
const response = await this.safeFetch(`${this.baseUrl}/meta/${hashId}/${key}`, {
|
||||
method: 'PUT',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ value }),
|
||||
});
|
||||
if (response && !response.ok) {
|
||||
console.warn(`[MetaCoreClient] Failed to set property: ${response.status}`);
|
||||
}
|
||||
}
|
||||
|
||||
async getProperty(hashId: string, key: string): Promise<string | null> {
|
||||
const response = await this.safeFetch(`${this.baseUrl}/meta/${hashId}/${key}`, { method: 'GET' });
|
||||
if (!response || response.status === 404) return null;
|
||||
if (!response.ok) return null;
|
||||
const data = await response.json() as { value?: string };
|
||||
return data.value ?? null;
|
||||
}
|
||||
|
||||
async mergeMetadata(hashId: string, metadata: Record<string, string>): Promise<void> {
|
||||
const response = await this.safeFetch(`${this.baseUrl}/meta/${hashId}`, {
|
||||
method: 'PATCH',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify(metadata),
|
||||
});
|
||||
if (response && !response.ok) {
|
||||
console.warn(`[MetaCoreClient] Failed to merge metadata: ${response.status}`);
|
||||
}
|
||||
}
|
||||
|
||||
async deleteProperty(hashId: string, key: string): Promise<void> {
|
||||
const response = await this.safeFetch(`${this.baseUrl}/meta/${hashId}/${key}`, { method: 'DELETE' });
|
||||
if (response && !response.ok && response.status !== 404) {
|
||||
console.warn(`[MetaCoreClient] Failed to delete property: ${response.status}`);
|
||||
}
|
||||
}
|
||||
|
||||
async addToSet(hashId: string, key: string, value: string): Promise<void> {
|
||||
const response = await this.safeFetch(`${this.baseUrl}/meta/${hashId}/_add/${key}`, {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ value }),
|
||||
});
|
||||
if (response && !response.ok) {
|
||||
console.warn(`[MetaCoreClient] Failed to add to set: ${response.status}`);
|
||||
}
|
||||
}
|
||||
|
||||
async getMetadata(hashId: string): Promise<Record<string, string>> {
|
||||
const response = await this.safeFetch(`${this.baseUrl}/meta/${hashId}`, { method: 'GET' });
|
||||
if (!response || response.status === 404) return {};
|
||||
if (!response.ok) return {};
|
||||
const data = await response.json() as { metadata?: Record<string, string> };
|
||||
return data.metadata ?? {};
|
||||
}
|
||||
}
|
||||
+169
@@ -0,0 +1,169 @@
|
||||
/**
|
||||
* Jellyfin NFO Plugin
|
||||
* Parses Jellyfin/Kodi NFO files for movies and TV shows
|
||||
*/
|
||||
|
||||
import { readFile, access } from 'fs/promises';
|
||||
import { dirname, join } from 'path';
|
||||
import { Parser } from 'xml2js';
|
||||
import { franc } from 'franc-min';
|
||||
import type { PluginManifest, ProcessRequest, CallbackPayload } from './types.js';
|
||||
import { MetaCoreClient } from './meta-core-client.js';
|
||||
|
||||
export const manifest: PluginManifest = {
|
||||
id: 'jellyfin-nfo',
|
||||
name: 'Jellyfin NFO Parser',
|
||||
version: '1.0.0',
|
||||
description: 'Parses Jellyfin/Kodi NFO files for movies and TV shows',
|
||||
author: 'MetaMesh',
|
||||
dependencies: ['file-info', 'filename-parser'],
|
||||
priority: 25,
|
||||
color: '#9C27B0',
|
||||
defaultQueue: 'fast',
|
||||
timeout: 30000,
|
||||
schema: {
|
||||
videoType: { label: 'Video Type', type: 'string' },
|
||||
originalTitle: { label: 'Original Title', type: 'string' },
|
||||
season: { label: 'Season Number', type: 'string' },
|
||||
episode: { label: 'Episode Number', type: 'string' },
|
||||
movieYear: { label: 'Release Year', type: 'number' },
|
||||
rating: { label: 'Rating', type: 'string' },
|
||||
imdbid: { label: 'IMDB ID', type: 'string' },
|
||||
tmdbid: { label: 'TMDB ID', type: 'string' },
|
||||
},
|
||||
config: {},
|
||||
};
|
||||
|
||||
async function fileExists(path: string): Promise<boolean> {
|
||||
try {
|
||||
await access(path);
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
async function parseNfoFile(nfoPath: string): Promise<any> {
|
||||
const content = await readFile(nfoPath, 'utf8');
|
||||
const parser = new Parser({ explicitArray: false, mergeAttrs: true });
|
||||
return parser.parseStringPromise(content);
|
||||
}
|
||||
|
||||
function normalizeArray(value: any): string[] {
|
||||
if (!value) return [];
|
||||
if (typeof value === 'string') return [value];
|
||||
if (Array.isArray(value)) return value;
|
||||
return [];
|
||||
}
|
||||
|
||||
export async function process(
|
||||
request: ProcessRequest,
|
||||
sendCallback: (payload: CallbackPayload) => Promise<void>
|
||||
): Promise<void> {
|
||||
const startTime = Date.now();
|
||||
const metaCore = new MetaCoreClient(request.metaCoreUrl);
|
||||
|
||||
try {
|
||||
const { cid, filePath, existingMeta } = request;
|
||||
|
||||
if (existingMeta?.fileType !== 'video') {
|
||||
await sendCallback({
|
||||
taskId: request.taskId,
|
||||
status: 'skipped',
|
||||
duration: Date.now() - startTime,
|
||||
reason: 'Not a video file',
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
const metadata: Record<string, string> = {};
|
||||
const sets: Array<{ key: string; value: string }> = [];
|
||||
|
||||
// Try file-specific NFO
|
||||
const nfoPath = filePath.replace(/\.[^.]+$/, '.nfo');
|
||||
if (await fileExists(nfoPath)) {
|
||||
try {
|
||||
const parsed = await parseNfoFile(nfoPath);
|
||||
const root = parsed.episodedetails || parsed.movie || parsed.tvshow;
|
||||
if (root) {
|
||||
extractNfoData(root, metadata, sets, parsed.movie ? 'movie' : 'tvshow');
|
||||
}
|
||||
} catch (e) {
|
||||
console.log(`[jellyfin-nfo] Error parsing ${nfoPath}`);
|
||||
}
|
||||
}
|
||||
|
||||
// Try tvshow.nfo in directory
|
||||
const tvshowNfo = join(dirname(filePath), 'tvshow.nfo');
|
||||
if (await fileExists(tvshowNfo)) {
|
||||
try {
|
||||
const parsed = await parseNfoFile(tvshowNfo);
|
||||
if (parsed.tvshow) {
|
||||
extractNfoData(parsed.tvshow, metadata, sets, 'tvshow');
|
||||
}
|
||||
} catch (e) {
|
||||
console.log(`[jellyfin-nfo] Error parsing ${tvshowNfo}`);
|
||||
}
|
||||
}
|
||||
|
||||
if (Object.keys(metadata).length > 0) {
|
||||
await metaCore.mergeMetadata(cid, metadata);
|
||||
}
|
||||
|
||||
for (const { key, value } of sets) {
|
||||
await metaCore.addToSet(cid, key, value);
|
||||
}
|
||||
|
||||
await sendCallback({
|
||||
taskId: request.taskId,
|
||||
status: 'completed',
|
||||
duration: Date.now() - startTime,
|
||||
});
|
||||
} catch (error) {
|
||||
await sendCallback({
|
||||
taskId: request.taskId,
|
||||
status: 'failed',
|
||||
duration: Date.now() - startTime,
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
function extractNfoData(
|
||||
root: any,
|
||||
metadata: Record<string, string>,
|
||||
sets: Array<{ key: string; value: string }>,
|
||||
videoType: string
|
||||
): void {
|
||||
metadata.videoType = videoType;
|
||||
|
||||
if (root.originaltitle) metadata.originalTitle = root.originaltitle;
|
||||
if (root.title && !metadata.originalTitle) metadata.originalTitle = root.title;
|
||||
if (root.episode) metadata.episode = String(root.episode);
|
||||
if (root.season) metadata.season = String(root.season);
|
||||
if (root.year) metadata.movieYear = String(root.year);
|
||||
if (root.rating) metadata.rating = String(root.rating);
|
||||
if (root.imdbid) metadata.imdbid = root.imdbid;
|
||||
if (root.tmdbid) metadata.tmdbid = String(root.tmdbid);
|
||||
if (root.anidbid) metadata.anidbid = String(root.anidbid);
|
||||
if (root.mpaa) metadata.mpaa = root.mpaa;
|
||||
if (root.releasedate) metadata.releasedate = root.releasedate;
|
||||
|
||||
// Plot with language detection
|
||||
if (root.plot) {
|
||||
const lang = franc(root.plot);
|
||||
const langKey = lang && lang !== 'und' ? lang : 'eng';
|
||||
metadata[`plot/${langKey}`] = root.plot;
|
||||
}
|
||||
|
||||
// Sets
|
||||
for (const genre of normalizeArray(root.genre)) {
|
||||
sets.push({ key: 'genres', value: genre });
|
||||
}
|
||||
for (const studio of normalizeArray(root.studio)) {
|
||||
sets.push({ key: 'studio', value: studio });
|
||||
}
|
||||
for (const tag of normalizeArray(root.tag || root.tags)) {
|
||||
sets.push({ key: 'tags', value: tag });
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,70 @@
|
||||
/**
|
||||
* MetaMesh Plugin Types
|
||||
*/
|
||||
|
||||
export interface PluginManifest {
|
||||
id: string;
|
||||
name: string;
|
||||
version: string;
|
||||
description?: string;
|
||||
author?: string;
|
||||
dependencies?: string[];
|
||||
schema?: Record<string, SchemaField>;
|
||||
config?: Record<string, ConfigField>;
|
||||
priority?: number;
|
||||
color?: string;
|
||||
defaultQueue?: 'fast' | 'background';
|
||||
timeout?: number;
|
||||
}
|
||||
|
||||
export interface SchemaField {
|
||||
label: string;
|
||||
type?: 'string' | 'number' | 'boolean' | 'select' | 'text' | 'array' | 'json' | 'cid';
|
||||
readonly?: boolean;
|
||||
hint?: string;
|
||||
}
|
||||
|
||||
export interface ConfigField {
|
||||
type: 'string' | 'number' | 'boolean' | 'select';
|
||||
label?: string;
|
||||
required?: boolean;
|
||||
default?: unknown;
|
||||
secret?: boolean;
|
||||
}
|
||||
|
||||
export interface HealthResponse {
|
||||
status: 'healthy' | 'unhealthy';
|
||||
ready: boolean;
|
||||
version: string;
|
||||
}
|
||||
|
||||
export interface ProcessRequest {
|
||||
taskId: string;
|
||||
cid: string;
|
||||
filePath: string;
|
||||
callbackUrl: string;
|
||||
metaCoreUrl: string;
|
||||
existingMeta?: Record<string, string>;
|
||||
}
|
||||
|
||||
export interface ProcessResponse {
|
||||
status: 'accepted' | 'rejected';
|
||||
error?: string;
|
||||
}
|
||||
|
||||
export interface CallbackPayload {
|
||||
taskId: string;
|
||||
status: 'completed' | 'failed' | 'skipped';
|
||||
duration: number;
|
||||
error?: string;
|
||||
reason?: string;
|
||||
}
|
||||
|
||||
export interface ConfigureRequest {
|
||||
config: Record<string, unknown>;
|
||||
}
|
||||
|
||||
export interface ConfigureResponse {
|
||||
status: 'ok' | 'error';
|
||||
error?: string;
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"lib": ["ES2022"],
|
||||
"outDir": "./dist",
|
||||
"rootDir": "./src",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"skipLibCheck": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"declaration": true,
|
||||
"sourceMap": true
|
||||
},
|
||||
"include": ["src/**/*"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
Reference in New Issue
Block a user