From 03403db5967d09264a327b9b35f1ece85ba03375 Mon Sep 17 00:00:00 2001 From: Pierre Date: Sat, 10 Jan 2026 15:34:26 +0100 Subject: [PATCH] initial commit --- .github/workflows/docker.yml | 56 ++++++++++++++++++++++ .gitignore | 5 ++ Dockerfile | 22 +++++++++ README.md | 66 +++++++++++++++++++++++++ package.json | 13 +++++ src/index.ts | 28 +++++++++++ src/meta-core-client.ts | 73 ++++++++++++++++++++++++++++ src/plugin.ts | 93 ++++++++++++++++++++++++++++++++++++ src/types.ts | 70 +++++++++++++++++++++++++++ tsconfig.json | 18 +++++++ 10 files changed, 444 insertions(+) create mode 100644 .github/workflows/docker.yml create mode 100644 .gitignore create mode 100644 Dockerfile create mode 100644 README.md create mode 100644 package.json create mode 100644 src/index.ts create mode 100644 src/meta-core-client.ts create mode 100644 src/plugin.ts create mode 100644 src/types.ts create mode 100644 tsconfig.json diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml new file mode 100644 index 0000000..8cdc3e7 --- /dev/null +++ b/.github/workflows/docker.yml @@ -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 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..397b0d9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +node_modules/ +dist/ +*.log +.env +.DS_Store diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..b5a1fea --- /dev/null +++ b/Dockerfile @@ -0,0 +1,22 @@ +FROM node:20-slim AS builder +RUN apt-get update && apt-get install -y git && rm -rf /var/lib/apt/lists/* +WORKDIR /app +COPY package.json tsconfig.json ./ +RUN npm install +# Build the git dependency (filename-tools) +RUN cd node_modules/@metazla/filename-tools && npm install && npm run build +COPY src/ ./src/ +RUN npm run build + +FROM node:20-slim +RUN apt-get update && apt-get install -y git && rm -rf /var/lib/apt/lists/* +WORKDIR /app +COPY package.json ./ +RUN npm install --omit=dev +# Build the git dependency in production too +RUN cd node_modules/@metazla/filename-tools && npm install && npm run build +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"] diff --git a/README.md b/README.md new file mode 100644 index 0000000..e5991d5 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +# MetaMesh Plugin: Filename Parser + +A MetaMesh plugin that parses video filenames to extract metadata like title, season, episode, and year. + +## Description + +This plugin analyzes video filenames using the `@metazla/filename-tools` library to extract structured metadata. It handles various naming conventions including: + +- Movies: `Movie Title (2024).mkv` +- TV Shows: `Show.S01E05.Episode.Name.mkv` +- Anime: `[Group] Title - 01 [1080p].mkv` + +## Metadata Fields + +| Field | Description | +|-------|-------------| +| `originalTitle` | Extracted title from filename | +| `videoType` | `movie` or `tvshow` | +| `season` | Season number (TV shows) | +| `episode` | Episode number (TV shows) | +| `movieYear` | Release year | +| `increment` | Episode increment | +| `extra` | Extra info (e.g., "Director's Cut") | + +## Dependencies + +- Requires `file-info` plugin to run first + +## 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-filename-parser . +docker run -p 8080:8080 metamesh-plugin-filename-parser +``` + +## Environment Variables + +| Variable | Default | Description | +|----------|---------|-------------| +| `PORT` | `8080` | HTTP server port | +| `HOST` | `0.0.0.0` | HTTP server host | + +## License + +MIT diff --git a/package.json b/package.json new file mode 100644 index 0000000..a977f69 --- /dev/null +++ b/package.json @@ -0,0 +1,13 @@ +{ + "name": "@metazla/plugin-filename-parser", + "version": "1.0.0", + "description": "MetaMesh plugin: Parses video filenames to extract metadata", + "type": "module", + "main": "dist/index.js", + "scripts": { "build": "tsc", "start": "node dist/index.js" }, + "dependencies": { + "fastify": "^5.0.0", + "@metazla/filename-tools": "github:worph/filename-tool" + }, + "devDependencies": { "@types/node": "^20.0.0", "typescript": "^5.3.0" } +} diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..a1db0dc --- /dev/null +++ b/src/index.ts @@ -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 => ({ status: 'healthy', ready, version: manifest.version })); +app.get('/manifest', async () => manifest); +app.post<{ Body: ConfigureRequest }>('/configure', async (request): Promise => { + 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); }); diff --git a/src/meta-core-client.ts b/src/meta-core-client.ts new file mode 100644 index 0000000..edbe17c --- /dev/null +++ b/src/meta-core-client.ts @@ -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 { + 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 { + 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 { + 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): Promise { + 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 { + 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 { + 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> { + 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 }; + return data.metadata ?? {}; + } +} diff --git a/src/plugin.ts b/src/plugin.ts new file mode 100644 index 0000000..07857ba --- /dev/null +++ b/src/plugin.ts @@ -0,0 +1,93 @@ +/** + * Filename Parser Plugin + * Parses video filenames to extract title, season, episode, year + * Uses @metazla/filename-tools library for parsing + */ + +import type { PluginManifest, ProcessRequest, CallbackPayload } from './types.js'; +import { MetaCoreClient } from './meta-core-client.js'; +import { + FileNameVideoMetaExtractor, + episodePatterns, + seasonAndEpisodePatterns, + seasonPatterns, + extraEpKeyWords, + keywordsArray, + substringArray, + soloEp +} from '@metazla/filename-tools'; + +export const manifest: PluginManifest = { + id: 'filename-parser', + name: 'Filename Parser', + version: '1.0.0', + description: 'Parses video filenames to extract title, season, episode, year, and quality', + author: 'MetaMesh', + dependencies: ['file-info'], + priority: 20, + color: '#2196F3', + defaultQueue: 'fast', + timeout: 30000, + schema: { + originalTitle: { label: 'Original Title', type: 'string' }, + videoType: { label: 'Video Type', type: 'string', hint: 'movie or tvshow' }, + season: { label: 'Season', type: 'string' }, + episode: { label: 'Episode', type: 'string' }, + movieYear: { label: 'Year', type: 'number' }, + }, + config: {}, +}; + +// Create extractor instance with default config +const extractor = new FileNameVideoMetaExtractor( + [], // watchFolderList - empty for plugin context + episodePatterns, + seasonAndEpisodePatterns, + seasonPatterns, + extraEpKeyWords, + keywordsArray, + substringArray, + soloEp +); + +export async function process( + request: ProcessRequest, + sendCallback: (payload: CallbackPayload) => Promise +): Promise { + const startTime = Date.now(); + const metaCore = new MetaCoreClient(request.metaCoreUrl); + + try { + const { cid, filePath } = request; + + // Use the library to extract metadata + const metadata = extractor.extractVideoFileMetadata(filePath); + + // Convert to record for merging + const result: Record = {}; + if (metadata.originalTitle) result.originalTitle = metadata.originalTitle; + if (metadata.season) result.season = metadata.season; + if (metadata.episode) result.episode = metadata.episode; + if (metadata.increment) result.increment = metadata.increment; + if (metadata.movieYear) result.movieYear = metadata.movieYear; + if (metadata.videoType) result.videoType = metadata.videoType; + if (metadata.extra) result.extra = metadata.extra; + + if (Object.keys(result).length > 0) { + await metaCore.mergeMetadata(cid, result); + } + + 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), + }); + } +} diff --git a/src/types.ts b/src/types.ts new file mode 100644 index 0000000..4dbbfe2 --- /dev/null +++ b/src/types.ts @@ -0,0 +1,70 @@ +/** + * MetaMesh Plugin Types + */ + +export interface PluginManifest { + id: string; + name: string; + version: string; + description?: string; + author?: string; + dependencies?: string[]; + schema?: Record; + config?: Record; + 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; +} + +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; +} + +export interface ConfigureResponse { + status: 'ok' | 'error'; + error?: string; +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..95ac5c2 --- /dev/null +++ b/tsconfig.json @@ -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"] +}