mirror of
https://github.com/kikootwo/ReadMeABook.git
synced 2026-06-03 21:00:09 +00:00
Add extensible notification providers + UI/API
Introduce a provider-based notification system and wire it through the API and admin UI. Added INotificationProvider + notification service implementation and providers (apprise, discord, ntfy, pushover), plus a GET /api/admin/notifications/providers endpoint to expose provider metadata. Refactored code to use provider type strings (removed enum coupling), updated masking/encryption calls, and simplified the test notification endpoint to accept backendId or type+config and call sendToBackend directly. UI: NotificationsTab now fetches provider metadata and renders provider cards and dynamic config forms (fields driven by provider metadata). Added config field rendering, improved backend cards, and edit/delete actions. APIs: New providers route, updated admin notification CRUD routes to validate provider types dynamically, updated test route schema. Added download-client categories POST API to fetch categories from clients and wired postImportCategory handling in download-client routes. Other notable changes: BookDate now fetches Claude models dynamically from Anthropic's Models API; added paginated model fetch helper. Added ALLOW_WEAK_PASSWORD flag exposure to auth providers and password change logic. Doc updates and various tests added/updated. File-organization doc clarifies EPERM fix using stream-based copy.
This commit is contained in:
@@ -0,0 +1,22 @@
|
||||
/**
|
||||
* Component: Stream-based File Copy Utility
|
||||
* Documentation: documentation/phase3/file-organization.md
|
||||
*
|
||||
* Uses read()/write() syscalls via Node.js streams instead of fs.copyFile(),
|
||||
* which relies on copy_file_range() — a syscall that fails with EPERM on
|
||||
* certain filesystem configurations (e.g. cross-export NFS4 mounts).
|
||||
*/
|
||||
|
||||
import { createReadStream, createWriteStream } from 'fs';
|
||||
import { pipeline } from 'stream/promises';
|
||||
|
||||
/**
|
||||
* Copy a file using streams.
|
||||
*
|
||||
* Equivalent to `fs.copyFile()` but uses standard read/write syscalls
|
||||
* instead of `copy_file_range()`, ensuring compatibility with NFS, FUSE,
|
||||
* and other network/virtual filesystems.
|
||||
*/
|
||||
export async function copyFile(source: string, destination: string): Promise<void> {
|
||||
await pipeline(createReadStream(source), createWriteStream(destination));
|
||||
}
|
||||
@@ -8,6 +8,7 @@ import path from 'path';
|
||||
import axios from 'axios';
|
||||
import { tagMultipleFiles, checkFfmpegAvailable } from './metadata-tagger';
|
||||
import { RMABLogger } from './logger';
|
||||
import { copyFile } from './copy-file';
|
||||
|
||||
const moduleLogger = RMABLogger.create('FileOrganizer');
|
||||
import {
|
||||
@@ -340,8 +341,8 @@ export class FileOrganizer {
|
||||
|
||||
// Copy file (do NOT delete original - needed for seeding)
|
||||
try {
|
||||
// Copy file using streaming (handles large files >2GB)
|
||||
await fs.copyFile(sourcePath, targetFilePath);
|
||||
// Copy file via streams (avoids copy_file_range EPERM on NFS/FUSE)
|
||||
await copyFile(sourcePath, targetFilePath);
|
||||
// Set explicit permissions after copy
|
||||
await fs.chmod(targetFilePath, 0o644);
|
||||
|
||||
@@ -378,7 +379,7 @@ export class FileOrganizer {
|
||||
await logger?.info(`Attempting fallback copy of original (untagged) file: ${filename}`);
|
||||
try {
|
||||
await fs.access(originalSourcePath, fs.constants.R_OK);
|
||||
await fs.copyFile(originalSourcePath, targetFilePath);
|
||||
await copyFile(originalSourcePath, targetFilePath);
|
||||
await fs.chmod(targetFilePath, 0o644);
|
||||
result.audioFiles.push(targetFilePath);
|
||||
result.filesMovedCount++;
|
||||
@@ -413,7 +414,7 @@ export class FileOrganizer {
|
||||
|
||||
try {
|
||||
// Copy cover art (do NOT delete original)
|
||||
await fs.copyFile(sourcePath, targetCoverPath);
|
||||
await copyFile(sourcePath, targetCoverPath);
|
||||
await fs.chmod(targetCoverPath, 0o644);
|
||||
result.coverArtFile = targetCoverPath;
|
||||
result.filesMovedCount++;
|
||||
@@ -608,7 +609,7 @@ export class FileOrganizer {
|
||||
const cachedPath = path.join('/app/cache/thumbnails', filename);
|
||||
|
||||
// Copy from local cache instead of downloading
|
||||
await fs.copyFile(cachedPath, targetPath);
|
||||
await copyFile(cachedPath, targetPath);
|
||||
await fs.chmod(targetPath, 0o644);
|
||||
moduleLogger.debug(`Copied cover art from cache: ${filename}`);
|
||||
} else {
|
||||
@@ -755,7 +756,7 @@ export class FileOrganizer {
|
||||
}
|
||||
|
||||
// Copy ebook file (do NOT delete original - may need for seeding or retry)
|
||||
await fs.copyFile(sourceFilePath, targetPath);
|
||||
await copyFile(sourceFilePath, targetPath);
|
||||
await fs.chmod(targetPath, 0o644);
|
||||
|
||||
await logger?.info(`Copied ebook: ${targetFilename}`);
|
||||
|
||||
@@ -37,6 +37,14 @@ const VALID_VARIABLES = ['author', 'title', 'narrator', 'asin', 'year', 'series'
|
||||
*/
|
||||
const INVALID_PATH_CHARS = /[<>:"|?*]/;
|
||||
|
||||
/**
|
||||
* Placeholder characters for escaped braces during substitution.
|
||||
* Uses Unicode Private Use Area characters that won't appear in metadata
|
||||
* and won't be affected by path cleanup operations.
|
||||
*/
|
||||
const LBRACE_PLACEHOLDER = '\uE000';
|
||||
const RBRACE_PLACEHOLDER = '\uE001';
|
||||
|
||||
/**
|
||||
* Sanitize a path component by removing invalid characters
|
||||
* Reuses logic from file-organizer.ts
|
||||
@@ -87,6 +95,10 @@ export function substituteTemplate(
|
||||
): string {
|
||||
let result = template;
|
||||
|
||||
// Replace escaped braces with placeholders before any processing,
|
||||
// so they survive the variable substitution and path cleanup steps
|
||||
result = result.replace(/\\\{/g, LBRACE_PLACEHOLDER).replace(/\\\}/g, RBRACE_PLACEHOLDER);
|
||||
|
||||
// Substitute each variable
|
||||
for (const key of VALID_VARIABLES) {
|
||||
const value = variables[key as keyof TemplateVariables];
|
||||
@@ -120,6 +132,11 @@ export function substituteTemplate(
|
||||
.filter(part => part.length > 0)
|
||||
.join('/');
|
||||
|
||||
// Resolve escaped brace placeholders as the final step,
|
||||
// after all variable substitution and path cleanup is complete
|
||||
result = result.replace(new RegExp(LBRACE_PLACEHOLDER, 'g'), '{');
|
||||
result = result.replace(new RegExp(RBRACE_PLACEHOLDER, 'g'), '}');
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
@@ -153,16 +170,20 @@ export function validateTemplate(template: string): ValidationResult {
|
||||
};
|
||||
}
|
||||
|
||||
// Check for absolute paths
|
||||
if (template.startsWith('/') || template.startsWith('\\') || /^[a-zA-Z]:/.test(template)) {
|
||||
// Check for absolute paths (backslash followed by { or } is a brace escape, not a path)
|
||||
if (template.startsWith('/') || /^\\(?![{}])/.test(template) || /^[a-zA-Z]:/.test(template)) {
|
||||
return {
|
||||
valid: false,
|
||||
error: 'Template must be a relative path (no absolute paths like "/" or "C:\\")'
|
||||
};
|
||||
}
|
||||
|
||||
// Extract all variables from template
|
||||
const variableMatches = template.match(/\{[^}]+\}/g);
|
||||
// Strip escaped braces (\{ and \}) before parsing so they don't interfere
|
||||
// with variable extraction or character validation
|
||||
const templateWithoutEscapedBraces = template.replace(/\\[{}]/g, '');
|
||||
|
||||
// Extract all variables from the stripped template
|
||||
const variableMatches = templateWithoutEscapedBraces.match(/\{[^}]+\}/g);
|
||||
|
||||
if (variableMatches) {
|
||||
for (const match of variableMatches) {
|
||||
@@ -178,7 +199,7 @@ export function validateTemplate(template: string): ValidationResult {
|
||||
}
|
||||
|
||||
// Remove valid variables temporarily to check for invalid characters
|
||||
let templateWithoutVars = template;
|
||||
let templateWithoutVars = templateWithoutEscapedBraces;
|
||||
for (const varName of VALID_VARIABLES) {
|
||||
templateWithoutVars = templateWithoutVars.replace(new RegExp(`\\{${varName}\\}`, 'g'), '');
|
||||
}
|
||||
@@ -192,8 +213,9 @@ export function validateTemplate(template: string): ValidationResult {
|
||||
};
|
||||
}
|
||||
|
||||
// Check for backslashes (Windows-style paths)
|
||||
if (templateWithoutVars.includes('\\')) {
|
||||
// Check for backslashes that are not brace escapes (Windows-style paths)
|
||||
// We check the original template: any backslash NOT followed by { or } is invalid
|
||||
if (/\\(?![{}])/.test(template)) {
|
||||
return {
|
||||
valid: false,
|
||||
error: 'Use forward slashes (/) for path separators, not backslashes (\\)'
|
||||
|
||||
Reference in New Issue
Block a user