Spaces:
Sleeping
Sleeping
File size: 22,254 Bytes
ed57015 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 | import crypto from 'crypto';
import path from 'path';
import { fileURLToPath } from 'url';
import { exec } from 'child_process';
import type DatabaseType from 'better-sqlite3';
import { getDb, getSetting, setSetting } from '../db/index.js';
import { hasProvider } from '../providers/index.js';
import { MEDIA_PLATFORMS } from './media.js';
import type { Platform } from '@freellmapi/shared/types.js';
// Generative-media modalities are routed into the separate media_models table
// (see services/media.ts), never into the chat `models` table.
const MEDIA_MODALITIES = new Set(['image', 'audio']);
/**
* catalog-sync β keeps the local model catalog in step with the published one.
*
* Twice a day (and on demand) the server pulls the signed catalog from the
* catalog service. A valid Premium license key (Bearer) gets the live tier,
* refreshed every 2-3 days; everyone else gets the monthly snapshot β so free
* installs still self-heal, just on a slower cadence. The response is verified
* against a pinned Ed25519 public key over the exact bytes received; anything
* unsigned or tampered with is discarded, which means a compromised CDN or
* MITM cannot inject models or quirks into the router.
*
* The bundled migrations remain the baseline: a fetched catalog is applied
* only when it is NEWER than what the binary shipped with (MIN_CATALOG_VERSION
* below), so a stale monthly snapshot can never roll back models that a newer
* app version added via migrations.
*/
const DEFAULT_BASE_URL = 'https://api.freellmapi.co';
// The Ed25519 public key the production catalog is signed with. The private
// half was generated on the catalog host and has never left it. Self-hosters
// running their own catalog server can override both via env.
const PINNED_CATALOG_PUBKEY = `-----BEGIN PUBLIC KEY-----
MCowBQYDK2VwAyEAq9yv4+3EeyMHKsfVYBhkcz1lYgIXSUeHNnN6tNgYX3k=
-----END PUBLIC KEY-----
`;
// Catalogs older than this are ignored. Bump to today's date whenever a model
// migration lands, so the bundled DB is always the floor.
export const MIN_CATALOG_VERSION = '2026.06.07';
const SYNC_INTERVAL_MS = 12 * 60 * 60 * 1000; // twice daily
const BOOT_DELAY_MS = 10 * 1000; // let the server settle before first sync
const FETCH_TIMEOUT_MS = 20 * 1000;
// settings table keys
export const SETTING_LICENSE_KEY = 'premium_license_key';
export const SETTING_LICENSE_STATUS = 'premium_license_status'; // JSON LicenseStatus
const SETTING_APPLIED_VERSION = 'catalog_applied_version';
const SETTING_APPLIED_TIER = 'catalog_applied_tier';
const SETTING_APPLIED_JSON = 'catalog_applied_json';
const SETTING_LAST_SYNC_MS = 'catalog_last_sync_ms';
const SETTING_LAST_ERROR = 'catalog_last_error';
export function catalogBaseUrl(): string {
return (process.env.CATALOG_BASE_URL ?? DEFAULT_BASE_URL).replace(/\/$/, '');
}
function catalogPublicKey(): crypto.KeyObject {
const pem = process.env.CATALOG_PUBKEY ? process.env.CATALOG_PUBKEY.replace(/\\n/g, '\n') : PINNED_CATALOG_PUBKEY;
return crypto.createPublicKey({ key: pem, format: 'pem' });
}
export interface LicenseStatus {
valid: boolean;
plan: 'annual' | 'lifetime' | null;
status: string | null;
expiresAt: string | null;
cancelAtPeriodEnd?: boolean;
reason?: string;
checkedAtMs: number;
}
interface CatalogQuirk {
slug: string;
title: string;
body: string;
severity: 'blocker' | 'warning' | 'info';
targets: { platform: string | null; modelGlob: string | null }[];
}
interface CatalogModel {
platform: string;
modelId: string;
displayName: string;
intelligenceRank: number;
speedRank: number;
sizeLabel: string;
limits: { rpm: number | null; rpd: number | null; tpm: number | null; tpd: number | null };
monthlyTokenBudget: string | null;
contextWindow: number | null;
enabled: boolean;
supportsVision: boolean;
supportsTools: boolean;
/** 'text' (default/absent) routes to the chat `models` table; 'image'/'audio'
* route to the separate `media_models` table. */
modality?: string;
/** Short display note for media models (e.g. "Keyless - up to 1024x1024"). */
mediaNote?: string;
}
interface Catalog {
version: string;
generatedAt: string;
tier: 'live' | 'monthly';
models: CatalogModel[];
quirks: CatalogQuirk[];
}
export interface SyncResult {
ok: boolean;
action: 'applied' | 'up_to_date' | 'skipped_older' | 'error';
version?: string;
tier?: string;
detail?: string;
counts?: { updated: number; inserted: number; removed: number; skippedUnknownPlatform: number; quirks: number };
}
/** Minimal structural check β enough to fail loudly on a wrong/garbled body. */
function isCatalog(value: unknown): value is Catalog {
const c = value as Catalog;
return (
!!c &&
typeof c.version === 'string' &&
(c.tier === 'live' || c.tier === 'monthly') &&
Array.isArray(c.models) &&
Array.isArray(c.quirks) &&
c.models.every(
(m) =>
typeof m?.platform === 'string' &&
typeof m?.modelId === 'string' &&
typeof m?.displayName === 'string' &&
typeof m?.enabled === 'boolean' &&
!!m?.limits &&
typeof m.limits === 'object',
) &&
c.quirks.every((q) => typeof q?.slug === 'string' && Array.isArray(q?.targets))
);
}
/**
* Apply a verified catalog to the local DB inside one transaction.
*
* Rules of engagement with user data:
* - metadata (name, ranks, limits, context, capabilities) always tracks the
* catalog β that is the whole point of the product;
* - catalog enabled=false force-disables (the model is dead upstream), but
* enabled=true never re-enables a model the user turned off themselves;
* - models the user added via custom providers (platform='custom' or bound to
* a key) are never touched;
* - models that vanished from the catalog are deleted, exactly like the
* dead-model migrations do (fallback_config row first, FK order).
*/
export function applyCatalog(db: DatabaseType.Database, catalog: Catalog): NonNullable<SyncResult['counts']> {
const counts = { updated: 0, inserted: 0, removed: 0, skippedUnknownPlatform: 0, quirks: 0 };
const selectModel = db.prepare('SELECT id, enabled FROM models WHERE platform = ? AND model_id = ?');
const updateModel = db.prepare(`
UPDATE models SET
display_name = @displayName, intelligence_rank = @intelligenceRank, speed_rank = @speedRank,
size_label = @sizeLabel, rpm_limit = @rpm, rpd_limit = @rpd, tpm_limit = @tpm, tpd_limit = @tpd,
monthly_token_budget = @monthlyTokenBudget, context_window = @contextWindow,
supports_vision = @supportsVision, supports_tools = @supportsTools,
enabled = @enabled
WHERE id = @id
`);
const insertModel = db.prepare(`
INSERT INTO models (platform, model_id, display_name, intelligence_rank, speed_rank, size_label,
rpm_limit, rpd_limit, tpm_limit, tpd_limit, monthly_token_budget, context_window,
enabled, supports_vision, supports_tools)
VALUES (@platform, @modelId, @displayName, @intelligenceRank, @speedRank, @sizeLabel,
@rpm, @rpd, @tpm, @tpd, @monthlyTokenBudget, @contextWindow,
@enabled, @supportsVision, @supportsTools)
`);
// Generative-media models go to their own table (never the chat router's pool).
const selectMedia = db.prepare('SELECT id, enabled FROM media_models WHERE platform = ? AND model_id = ?');
const updateMedia = db.prepare(`
UPDATE media_models SET
display_name = @displayName, modality = @modality, priority = @priority,
quota_label = @quotaLabel, enabled = @enabled
WHERE id = @id
`);
const insertMedia = db.prepare(`
INSERT INTO media_models (platform, model_id, display_name, modality, priority, enabled, quota_label)
VALUES (@platform, @modelId, @displayName, @modality, @priority, @enabled, @quotaLabel)
`);
const apply = db.transaction(() => {
const inCatalog = new Set<string>();
const inMediaCatalog = new Set<string>();
for (const m of catalog.models) {
// Media modalities are gated on MEDIA_PLATFORMS (decoupled from the chat
// provider registry) and routed to media_models, then skip the chat path.
const modality = m.modality ?? 'text';
if (MEDIA_MODALITIES.has(modality)) {
if (!MEDIA_PLATFORMS.has(m.platform)) {
counts.skippedUnknownPlatform++;
continue;
}
inMediaCatalog.add(`${m.platform}:${m.modelId}`);
const mrow = selectMedia.get(m.platform, m.modelId) as { id: number; enabled: number } | undefined;
const mfields = {
displayName: m.displayName,
modality,
priority: m.intelligenceRank ?? 0,
quotaLabel: m.mediaNote ?? '',
};
if (mrow) {
const enabled = m.enabled ? mrow.enabled : 0; // catalog disable wins; local disable wins
updateMedia.run({ ...mfields, id: mrow.id, enabled });
counts.updated++;
} else {
insertMedia.run({ ...mfields, platform: m.platform, modelId: m.modelId, enabled: m.enabled ? 1 : 0 });
counts.inserted++;
}
continue;
}
if (m.platform === 'custom' || !hasProvider(m.platform as Platform)) {
// An older binary may receive models for providers it cannot route yet;
// skip them β they will appear after the user updates the app.
counts.skippedUnknownPlatform++;
continue;
}
inCatalog.add(`${m.platform}:${m.modelId}`);
const row = selectModel.get(m.platform, m.modelId) as { id: number; enabled: number } | undefined;
const fields = {
displayName: m.displayName,
intelligenceRank: m.intelligenceRank,
speedRank: m.speedRank,
sizeLabel: m.sizeLabel,
rpm: m.limits.rpm,
rpd: m.limits.rpd,
tpm: m.limits.tpm,
tpd: m.limits.tpd,
monthlyTokenBudget: m.monthlyTokenBudget,
contextWindow: m.contextWindow,
supportsVision: m.supportsVision ? 1 : 0,
supportsTools: m.supportsTools ? 1 : 0,
};
if (row) {
// Catalog disable wins (dead upstream); local disable also wins.
const enabled = m.enabled ? row.enabled : 0;
updateModel.run({ ...fields, id: row.id, enabled });
counts.updated++;
} else {
insertModel.run({ ...fields, platform: m.platform, modelId: m.modelId, enabled: m.enabled ? 1 : 0 });
counts.inserted++;
}
}
// Ensure every model has a fallback_config row (same invariant migrations keep).
const missingFb = db
.prepare(
`SELECT m.id FROM models m LEFT JOIN fallback_config f ON m.id = f.model_db_id WHERE f.id IS NULL`,
)
.all() as { id: number }[];
if (missingFb.length > 0) {
const maxPriority = (db.prepare('SELECT COALESCE(MAX(priority), 0) AS mx FROM fallback_config').get() as { mx: number }).mx;
const addFb = db.prepare('INSERT INTO fallback_config (model_db_id, priority, enabled) VALUES (?, ?, 1)');
missingFb.forEach((r, i) => addFb.run(r.id, maxPriority + 1 + i));
}
// Remove catalog-managed models that the catalog no longer lists.
const candidates = db
.prepare(`SELECT id, platform, model_id FROM models WHERE platform != 'custom' AND key_id IS NULL`)
.all() as { id: number; platform: string; model_id: string }[];
const deleteFb = db.prepare('DELETE FROM fallback_config WHERE model_db_id = ?');
const deleteModel = db.prepare('DELETE FROM models WHERE id = ?');
for (const c of candidates) {
if (!hasProvider(c.platform as Platform)) continue; // not catalog-managed by this binary
if (!inCatalog.has(`${c.platform}:${c.model_id}`)) {
deleteFb.run(c.id);
deleteModel.run(c.id);
counts.removed++;
}
}
// Remove media models the catalog no longer lists (own table, no fallback_config).
const mediaCandidates = db
.prepare('SELECT id, platform, model_id FROM media_models')
.all() as { id: number; platform: string; model_id: string }[];
const deleteMedia = db.prepare('DELETE FROM media_models WHERE id = ?');
for (const c of mediaCandidates) {
if (!MEDIA_PLATFORMS.has(c.platform)) continue; // not media-managed by this binary
if (!inMediaCatalog.has(`${c.platform}:${c.model_id}`)) {
deleteMedia.run(c.id);
counts.removed++;
}
}
// Quirks are pure content: replace wholesale.
db.prepare('DELETE FROM quirk_targets').run();
db.prepare('DELETE FROM quirks').run();
const insertQuirk = db.prepare(
`INSERT INTO quirks (slug, title, body, severity, created_at_ms, updated_at_ms) VALUES (?, ?, ?, ?, ?, ?)`,
);
const insertTarget = db.prepare(
`INSERT INTO quirk_targets (quirk_id, platform, model_glob) VALUES (?, ?, ?)`,
);
const now = Date.now();
for (const q of catalog.quirks) {
const info = insertQuirk.run(q.slug, q.title, q.body, q.severity, now, now);
for (const t of q.targets) insertTarget.run(info.lastInsertRowid, t.platform ?? null, t.modelGlob ?? null);
counts.quirks++;
}
});
apply();
return counts;
}
/**
* Fetch the catalog, verify its signature, and apply it if it moves us forward.
* `force` skips the `since` short-circuit β used right after a license key is
* added or removed, where the tier can change without the version changing.
*/
export async function syncCatalog(force = false): Promise<SyncResult> {
const db = getDb();
const key = getSetting(SETTING_LICENSE_KEY);
const applied = getSetting(SETTING_APPLIED_VERSION);
try {
const headers: Record<string, string> = {};
if (key) headers.Authorization = `Bearer ${key}`;
const url = new URL(`${catalogBaseUrl()}/v1/latest`);
if (applied && !force) url.searchParams.set('since', applied);
const res = await fetch(url, { headers, signal: AbortSignal.timeout(FETCH_TIMEOUT_MS) });
if (res.status === 304) {
setSetting(SETTING_LAST_SYNC_MS, String(Date.now()));
setSetting(SETTING_LAST_ERROR, '');
return { ok: true, action: 'up_to_date', version: applied };
}
if (!res.ok) throw new Error(`catalog fetch failed: HTTP ${res.status}`);
const signature = res.headers.get('x-catalog-signature');
if (!signature) throw new Error('catalog response missing signature');
const bytes = Buffer.from(await res.arrayBuffer());
const verified = crypto.verify(null, bytes, catalogPublicKey(), Buffer.from(signature, 'base64'));
if (!verified) throw new Error('catalog signature verification FAILED β discarding response');
const parsed: unknown = JSON.parse(bytes.toString('utf8'));
if (!isCatalog(parsed)) throw new Error('catalog payload has unexpected shape');
const catalog = parsed;
if (catalog.version < MIN_CATALOG_VERSION) {
// Older than the bundled baseline (e.g. monthly snapshot lagging a fresh
// app release) β applying it would roll back migrations. Wait it out.
setSetting(SETTING_LAST_SYNC_MS, String(Date.now()));
setSetting(SETTING_LAST_ERROR, '');
return { ok: true, action: 'skipped_older', version: catalog.version, tier: catalog.tier };
}
const sameAsApplied = applied === catalog.version && getSetting(SETTING_APPLIED_TIER) === catalog.tier;
if (!sameAsApplied) {
const counts = applyCatalog(db, catalog);
setSetting(SETTING_APPLIED_VERSION, catalog.version);
setSetting(SETTING_APPLIED_TIER, catalog.tier);
// Cache the verified document so boots can re-apply it offline (see
// reapplyCachedCatalog). Stored post-verification: anything that could
// tamper this row could tamper the models table directly, so the cache
// adds no new trust surface.
setSetting(SETTING_APPLIED_JSON, bytes.toString('utf8'));
console.log(
`[catalog-sync] applied ${catalog.tier} v${catalog.version}: ` +
`${counts.updated} updated, ${counts.inserted} new, ${counts.removed} removed, ` +
`${counts.quirks} quirks` +
(counts.skippedUnknownPlatform ? `, ${counts.skippedUnknownPlatform} skipped (unknown platform)` : ''),
);
setSetting(SETTING_LAST_SYNC_MS, String(Date.now()));
setSetting(SETTING_LAST_ERROR, '');
return { ok: true, action: 'applied', version: catalog.version, tier: catalog.tier, counts };
}
setSetting(SETTING_LAST_SYNC_MS, String(Date.now()));
setSetting(SETTING_LAST_ERROR, '');
return { ok: true, action: 'up_to_date', version: catalog.version, tier: catalog.tier };
} catch (err) {
const message = err instanceof Error ? err.message : String(err);
console.warn(`[catalog-sync] ${message}`);
setSetting(SETTING_LAST_ERROR, message);
return { ok: false, action: 'error', detail: message };
}
}
/** Revalidate the stored license against the catalog service and cache the result. */
export async function refreshLicenseStatus(): Promise<LicenseStatus | null> {
const key = getSetting(SETTING_LICENSE_KEY);
if (!key) return null;
try {
const res = await fetch(`${catalogBaseUrl()}/v1/license/check`, {
headers: { Authorization: `Bearer ${key}` },
signal: AbortSignal.timeout(FETCH_TIMEOUT_MS),
});
if (!res.ok && res.status !== 401) throw new Error(`HTTP ${res.status}`);
const body = (await res.json()) as Omit<LicenseStatus, 'checkedAtMs'>;
const status: LicenseStatus = { ...body, checkedAtMs: Date.now() };
setSetting(SETTING_LICENSE_STATUS, JSON.stringify(status));
return status;
} catch (err) {
// Offline or service down: keep the cached status. Entitlement is enforced
// server-side at /v1/latest anyway β this cache is informational UI state.
console.warn(`[catalog-sync] license check unreachable: ${err instanceof Error ? err.message : err}`);
return getCachedLicenseStatus();
}
}
export function getCachedLicenseStatus(): LicenseStatus | null {
const raw = getSetting(SETTING_LICENSE_STATUS);
if (!raw) return null;
try {
return JSON.parse(raw) as LicenseStatus;
} catch {
return null;
}
}
export interface CatalogSyncState {
baseUrl: string;
appliedVersion: string | null;
appliedTier: string | null;
lastSyncMs: number | null;
lastError: string | null;
}
export function getSyncState(): CatalogSyncState {
return {
baseUrl: catalogBaseUrl(),
appliedVersion: getSetting(SETTING_APPLIED_VERSION) ?? null,
appliedTier: getSetting(SETTING_APPLIED_TIER) ?? null,
lastSyncMs: Number(getSetting(SETTING_LAST_SYNC_MS)) || null,
lastError: getSetting(SETTING_LAST_ERROR) || null,
};
}
/**
* Re-apply the cached (already signature-verified) catalog after boot.
*
* Migrations run on every boot and re-assert the bundled baseline β they
* INSERT OR IGNORE baseline models the catalog may have deleted and re-run
* the family-rule resets β while the boot-time network sync 304s on an
* unchanged version and so would NOT re-apply. Without this step every
* restart drifts the DB back toward the baseline until the next catalog
* version bump. Re-applying from the local cache is synchronous, needs no
* network, and keeps the catalog authoritative even offline.
*
* Legacy upgrade path: installs that applied a catalog before the cache
* existed have an applied-version setting but no cached document. Clearing
* the applied version makes the next poll fetch the full catalog (no `since`
* short-circuit), which re-applies it and populates the cache.
*/
export function reapplyCachedCatalog(): { reapplied: boolean; version?: string } {
try {
const raw = getSetting(SETTING_APPLIED_JSON);
if (!raw) {
if (getSetting(SETTING_APPLIED_VERSION)) {
getDb().prepare('DELETE FROM settings WHERE key = ?').run(SETTING_APPLIED_VERSION);
}
return { reapplied: false };
}
const parsed: unknown = JSON.parse(raw);
if (!isCatalog(parsed) || parsed.version < MIN_CATALOG_VERSION) return { reapplied: false };
applyCatalog(getDb(), parsed);
console.log(`[catalog-sync] re-applied cached ${parsed.tier} v${parsed.version} after boot`);
return { reapplied: true, version: parsed.version };
} catch (err) {
console.warn(`[catalog-sync] cached catalog re-apply failed: ${err instanceof Error ? err.message : err}`);
return { reapplied: false };
}
}
let intervalId: ReturnType<typeof setInterval> | null = null;
let bootTimer: ReturnType<typeof setTimeout> | null = null;
function setupLocalCatalogSync(): void {
const __dirname = path.dirname(fileURLToPath(import.meta.url));
const scriptPath = path.resolve(__dirname, '../../catalog-updater/update_catalog.sh');
const runLocalSync = () => {
console.log('[local-catalog-sync] Starting automatic crawl, sync, and ranking pipeline...');
exec(`bash "${scriptPath}"`, (error, stdout, stderr) => {
if (error) {
console.error(`[local-catalog-sync] Error running update_catalog.sh: ${error.message}`);
return;
}
console.log('[local-catalog-sync] Automatic catalog update complete!');
});
};
// Run initial local sync 15 seconds after server boot to allow initialization
bootTimer = setTimeout(runLocalSync, 15000);
// Run local sync every 12 hours
intervalId = setInterval(runLocalSync, 12 * 60 * 60 * 1000);
console.log('[local-catalog-sync] Configured background sync task (runs every 12 hours)');
}
export function startCatalogSync(): void {
if (intervalId) return;
if (process.env.CATALOG_SYNC_DISABLED === '1') {
console.log('[catalog-sync] disabled via CATALOG_SYNC_DISABLED=1');
setupLocalCatalogSync();
return;
}
reapplyCachedCatalog();
const run = () => {
void refreshLicenseStatus();
void syncCatalog();
};
bootTimer = setTimeout(run, BOOT_DELAY_MS);
intervalId = setInterval(run, SYNC_INTERVAL_MS);
console.log(`[catalog-sync] polling ${catalogBaseUrl()} every ${SYNC_INTERVAL_MS / 3600000}h`);
}
export function stopCatalogSync(): void {
if (bootTimer) {
clearTimeout(bootTimer);
bootTimer = null;
}
if (intervalId) {
clearInterval(intervalId);
intervalId = null;
}
}
|