homeio

1import "server-only";
2
3import { readFileSync } from "node:fs";
4import path from "node:path";
5import yaml from "js-yaml";
6import type { StoreAppEnvDefinition } from "@/lib/shared/contracts/apps";
7
8export type AppDefinition = {
9  appId: string;
10  templateName: string;
11  name: string;
12  description: string;
13  platform: string;
14  note: string;
15  categories: string[];
16  logoUrl: string | null;
17  repositoryUrl: string;
18  stackFile: string;
19  composePath: string;
20  env: StoreAppEnvDefinition[];
21  screenshots: string[];
22  image: string | null;
23  volumes: string[];
24  port: number | null;
25  scheme: string;
26  index: string;
27  mainServiceName: string;
28};
29
30type ComposeService = Record<string, unknown>;
31type ComposeDocument = {
32  name?: unknown;
33  services?: Record<string, ComposeService>;
34  [key: string]: unknown;
35};
36
37type CasaosSection = {
38  title?: unknown;
39  description?: unknown;
40  icon?: unknown;
41  screenshot_link?: unknown;
42  category?: unknown;
43  tips?: unknown;
44  scheme?: unknown;
45  port_map?: unknown;
46  index?: unknown;
47  main?: unknown;
48};
49
50type CasaosEnvMetadata = {
51  container?: unknown;
52  label?: unknown;
53  name?: unknown;
54  description?: unknown;
55};
56
57const INFRA_SERVICE_TOKEN_PATTERN =
58  /(?:^|[-_.])(db|database|postgres|postgresql|mariadb|mysql|redis|cache|broker|queue|rabbitmq|kafka|zookeeper|mongo|mongodb|elasticsearch|minio)(?:$|[-_.])/i;
59const APP_ALIAS_PATTERN = /^(app|main|server|web|frontend|backend)$/i;
60const DEFAULT_DESCRIPTION = "No description available.";
61const DEFAULT_NOTE = "No installation notes provided.";
62
63function slugify(value: string) {
64  return value
65    .trim()
66    .toLowerCase()
67    .replace(/[^a-z0-9]+/g, "-")
68    .replace(/^-+|-+$/g, "");
69}
70
71function normalizeLocaleKey(value: string) {
72  return value.trim().toLowerCase().replace(/-/g, "_");
73}
74
75function resolveLocalizedValue(input: unknown): string | null {
76  if (typeof input === "string") {
77    const trimmed = input.trim();
78    return trimmed.length > 0 ? trimmed : null;
79  }
80
81  if (!input || typeof input !== "object" || Array.isArray(input)) {
82    return null;
83  }
84
85  const entries = Object.entries(input as Record<string, unknown>).filter(
86    ([, value]) => typeof value === "string" && value.trim().length > 0,
87  );
88  if (entries.length === 0) {
89    return null;
90  }
91
92  const values = new Map(entries.map(([key, value]) => [normalizeLocaleKey(key), String(value).trim()]));
93  for (const preferred of ["en_us", "en", "en_gb", "en-ca", "en_au"]) {
94    const exact = values.get(normalizeLocaleKey(preferred));
95    if (exact) return exact;
96  }
97
98  return entries[0]?.[1] ? String(entries[0][1]).trim() : null;
99}
100
101function resolveScreenshots(input: unknown) {
102  if (!Array.isArray(input)) return [];
103  return input
104    .filter((value): value is string => typeof value === "string")
105    .map((value) => value.trim())
106    .filter((value) => value.length > 0);
107}
108
109function resolveCategories(input: unknown) {
110  const raw = Array.isArray(input) ? input : [input];
111  const categories = raw
112    .filter((value): value is string => typeof value === "string")
113    .map((value) => value.trim())
114    .filter((value) => value.length > 0);
115  return categories.length > 0 ? Array.from(new Set(categories)) : ["Utilities"];
116}
117
118function parseEnvironment(service: ComposeService) {
119  const environment = service.environment;
120  const result: Record<string, string> = {};
121
122  if (Array.isArray(environment)) {
123    for (const entry of environment) {
124      if (typeof entry !== "string") continue;
125      const [key, ...valueParts] = entry.split("=");
126      if (!key) continue;
127      result[key] = valueParts.join("=");
128    }
129    return result;
130  }
131
132  if (!environment || typeof environment !== "object") {
133    return result;
134  }
135
136  for (const [key, value] of Object.entries(environment as Record<string, unknown>)) {
137    if (typeof value === "string") {
138      result[key] = value;
139      continue;
140    }
141
142    if (typeof value === "number" || typeof value === "boolean") {
143      result[key] = String(value);
144      continue;
145    }
146
147    result[key] = "";
148  }
149
150  return result;
151}
152
153function parseVolumes(service: ComposeService) {
154  const volumes = service.volumes;
155  if (!Array.isArray(volumes)) return [];
156
157  return volumes
158    .map((entry) => {
159      if (typeof entry === "string") {
160        return entry.trim();
161      }
162
163      if (!entry || typeof entry !== "object") {
164        return "";
165      }
166
167      const candidate = entry as {
168        source?: unknown;
169        target?: unknown;
170        type?: unknown;
171      };
172      const source = typeof candidate.source === "string" ? candidate.source.trim() : "";
173      const target = typeof candidate.target === "string" ? candidate.target.trim() : "";
174      if (!target) return "";
175      return source ? `${source}:${target}` : target;
176    })
177    .filter((entry) => entry.length > 0);
178}
179
180function parsePortNumber(input: unknown): number | null {
181  if (typeof input === "number" && Number.isInteger(input) && input > 0 && input <= 65535) {
182    return input;
183  }
184
185  if (typeof input !== "string") {
186    return null;
187  }
188
189  const trimmed = input.trim();
190  if (!trimmed) return null;
191
192  if (/^\d+$/.test(trimmed)) {
193    const parsed = Number.parseInt(trimmed, 10);
194    return parsed >= 1 && parsed <= 65535 ? parsed : null;
195  }
196
197  const defaultMatch = trimmed.match(/\$\{[^}:]+:-?(\d+)\}/);
198  if (defaultMatch?.[1]) {
199    const parsed = Number.parseInt(defaultMatch[1], 10);
200    return parsed >= 1 && parsed <= 65535 ? parsed : null;
201  }
202
203  return null;
204}
205
206function parseFirstPublishedPort(service: ComposeService): number | null {
207  const ports = service.ports;
208  if (!Array.isArray(ports)) return null;
209
210  for (const entry of ports) {
211    if (typeof entry === "string") {
212      const [mappingPart] = entry.split("/");
213      const segments = mappingPart.split(":").filter(Boolean);
214      const published = segments.length >= 2 ? segments[segments.length - 2] : segments[0];
215      const parsed = parsePortNumber(published);
216      if (parsed !== null) return parsed;
217      continue;
218    }
219
220    if (!entry || typeof entry !== "object") continue;
221    const candidate = entry as { published?: unknown; target?: unknown };
222    const parsed = parsePortNumber(candidate.published ?? candidate.target);
223    if (parsed !== null) return parsed;
224  }
225
226  return null;
227}
228
229function hasPublishedPorts(service: ComposeService) {
230  return parseFirstPublishedPort(service) !== null;
231}
232
233function scorePrimaryServiceCandidate(input: {
234  name: string;
235  service: ComposeService;
236  appId?: string;
237}) {
238  const name = input.name.toLowerCase();
239  const appId = input.appId?.toLowerCase().trim();
240  const image = typeof input.service.image === "string" ? input.service.image.toLowerCase() : "";
241
242  let score = 0;
243  if (hasPublishedPorts(input.service)) score += 40;
244  if (name === "app") score += 60;
245  else if (APP_ALIAS_PATTERN.test(name)) score += 30;
246  if (name.includes("server")) score += 20;
247
248  if (appId) {
249    if (name === appId) score += 100;
250    else if (name.startsWith(`${appId}-`) || name.endsWith(`-${appId}`)) score += 45;
251    else if (name.includes(appId)) score += 25;
252    if (image.includes(appId)) score += 20;
253  }
254
255  if (INFRA_SERVICE_TOKEN_PATTERN.test(name)) score -= 80;
256  return score;
257}
258
259function resolveMainServiceName(services: Record<string, ComposeService>, casaos: CasaosSection, appId: string) {
260  const configured = typeof casaos.main === "string" ? casaos.main.trim() : "";
261  if (configured && services[configured]) {
262    return configured;
263  }
264
265  const entries = Object.entries(services);
266  if (entries.length === 0) {
267    throw new Error("Compose file does not define any services");
268  }
269
270  return entries
271    .map(([name, service], index) => ({
272      name,
273      index,
274      score: scorePrimaryServiceCandidate({ name, service, appId }),
275    }))
276    .sort((left, right) => right.score - left.score || left.index - right.index)[0]?.name ?? entries[0][0];
277}
278
279function resolveEnvDefinitions(service: ComposeService) {
280  const environment = parseEnvironment(service);
281  const metadata = ((service["x-casaos"] as { envs?: unknown } | undefined)?.envs ?? []) as unknown;
282  const metadataByKey = new Map<string, CasaosEnvMetadata>();
283
284  if (Array.isArray(metadata)) {
285    for (const entry of metadata) {
286      if (!entry || typeof entry !== "object") continue;
287      const item = entry as CasaosEnvMetadata;
288      const key = typeof item.container === "string"
289        ? item.container.trim()
290        : typeof item.name === "string"
291          ? item.name.trim()
292          : "";
293      if (!key) continue;
294      metadataByKey.set(key, item);
295    }
296  }
297
298  return Object.keys(environment)
299    .sort((left, right) => left.localeCompare(right))
300    .map((name) => {
301      const item = metadataByKey.get(name);
302      return {
303        name,
304        label:
305          typeof item?.label === "string" && item.label.trim().length > 0
306            ? item.label.trim()
307            : undefined,
308        description: resolveLocalizedValue(item?.description) ?? undefined,
309        default: environment[name],
310      } satisfies StoreAppEnvDefinition;
311    });
312}
313
314function parseComposeContentToAppDefinition(composePath: string, content: string): AppDefinition {
315  const parsed = yaml.load(content) as ComposeDocument | null;
316  if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) {
317    throw new Error(`Invalid compose file: ${composePath}`);
318  }
319
320  const services = parsed.services;
321  if (!services || typeof services !== "object" || Array.isArray(services) || Object.keys(services).length === 0) {
322    throw new Error(`Compose file does not define any services: ${composePath}`);
323  }
324
325  const casaos = ((parsed["x-casaos"] as CasaosSection | undefined) ?? {}) as CasaosSection;
326  const composeName = typeof parsed.name === "string" && parsed.name.trim().length > 0
327    ? parsed.name.trim()
328    : path.basename(path.dirname(composePath));
329  const appId = slugify(composeName) || slugify(path.basename(path.dirname(composePath))) || "app";
330  const mainServiceName = resolveMainServiceName(services, casaos, appId);
331  const mainService = services[mainServiceName];
332
333  const description = resolveLocalizedValue(casaos.description) ?? DEFAULT_DESCRIPTION;
334  const note =
335    resolveLocalizedValue(casaos.tips) ??
336    resolveLocalizedValue((casaos.tips as { before_install?: unknown } | undefined)?.before_install) ??
337    description ??
338    DEFAULT_NOTE;
339  const port = parsePortNumber(casaos.port_map) ?? parsePortNumber((mainService["x-casaos"] as CasaosSection | undefined)?.port_map) ?? parseFirstPublishedPort(mainService);
340  const index = typeof casaos.index === "string" && casaos.index.trim().length > 0 ? casaos.index.trim() : "/";
341  const scheme = typeof casaos.scheme === "string" && casaos.scheme.trim().length > 0 ? casaos.scheme.trim() : "http";
342
343  return {
344    appId,
345    templateName: composeName,
346    name: resolveLocalizedValue(casaos.title) ?? composeName,
347    description,
348    platform: "Docker Compose",
349    note,
350    categories: resolveCategories(casaos.category),
351    logoUrl: typeof casaos.icon === "string" && casaos.icon.trim().length > 0 ? casaos.icon.trim() : null,
352    repositoryUrl: "",
353    stackFile: path.relative(path.dirname(composePath), composePath),
354    composePath: path.resolve(composePath),
355    env: resolveEnvDefinitions(mainService),
356    screenshots: resolveScreenshots(casaos.screenshot_link),
357    image: typeof mainService.image === "string" && mainService.image.trim().length > 0 ? mainService.image.trim() : null,
358    volumes: parseVolumes(mainService),
359    port,
360    scheme,
361    index,
362    mainServiceName,
363  };
364}
365
366export function parseComposeToApp(composePath: string): AppDefinition {
367  const content = readFileSync(composePath, "utf8");
368  return parseComposeContentToAppDefinition(composePath, content);
369}
370
371export function parseComposeContentToApp(composePath: string, content: string): AppDefinition {
372  return parseComposeContentToAppDefinition(composePath, content);
373}
374