runtipi/packages/system-api/src/modules/apps/apps.helpers.ts

import portUsed from 'tcp-port-used';
import { fileExists, readdirSync, readFile, readJsonFile, runScript, writeFile } from '../fs/fs.helpers';
import InternalIp from 'internal-ip';
import crypto from 'crypto';
import config from '../../config';
import { AppInfo } from './apps.types';

export const checkAppRequirements = async (appName: string) => {
  let valid = true;
  const configFile: AppInfo = readJsonFile(`/apps/${appName}/config.json`);

  if (configFile?.requirements?.ports) {
    for (const port of configFile.requirements.ports) {
      const ip = await InternalIp.v4();
      const used = await portUsed.check(port, ip);

      if (used) valid = false;
    }
  }

  return valid;
};

export const getEnvMap = (appName: string): Map<string, string> => {
  const envFile = readFile(`/app-data/${appName}/app.env`).toString();
  const envVars = envFile.split('\n');
  const envVarsMap = new Map<string, string>();

  envVars.forEach((envVar) => {
    const [key, value] = envVar.split('=');
    envVarsMap.set(key, value);
  });

  return envVarsMap;
};

export const checkEnvFile = (appName: string) => {
  const configFile: AppInfo = readJsonFile(`/apps/${appName}/config.json`);
  const envMap = getEnvMap(appName);

  configFile.form_fields?.forEach((field) => {
    const envVar = field.env_variable;
    const envVarValue = envMap.get(envVar);

    if (!envVarValue && field.required) {
      throw new Error('New info needed. App config needs to be updated');
    }
  });
};

export const checkAppExists = (appName: string) => {
  const appExists = fileExists(`/app-data/${appName}`);

  if (!appExists) {
    throw new Error(`App ${appName} not installed`);
  }
};

export const runAppScript = (params: string[]): Promise<void> => {
  return new Promise((resolve, reject) => {
    runScript('/scripts/app.sh', [...params, config.ROOT_FOLDER_HOST], (err: string) => {
      if (err) {
        reject(err);
      }

      resolve();
    });
  });
};

export const ensureAppState = (appName: string, installed: boolean) => {
  const state = readJsonFile('/state/apps.json');

  if (installed) {
    if (state.installed.indexOf(appName) === -1) {
      state.installed += ` ${appName}`;
    }
  } else {
    if (state.installed.indexOf(appName) !== -1) {
      state.installed = state.installed.replace(`${appName}`, '');
    }
  }

  state.installed = state.installed.replace(/\s+/g, ' ').trim();
  writeFile('/state/apps.json', JSON.stringify(state));
};

const getEntropy = (name: string, length: number) => {
  const hash = crypto.createHash('sha256');
  hash.update(name);
  return hash.digest('hex').substring(0, length);
};

export const generateEnvFile = (appName: string, form: Record<string, string>) => {
  const configFile: AppInfo = readJsonFile(`/apps/${appName}/config.json`);
  const baseEnvFile = readFile('/.env').toString();
  let envFile = `${baseEnvFile}\nAPP_PORT=${configFile.port}\n`;
  const envMap = getEnvMap(appName);

  configFile.form_fields?.forEach((field) => {
    const formValue = form[field.env_variable];
    const envVar = field.env_variable;

    if (formValue) {
      envFile += `${envVar}=${formValue}\n`;
    } else if (field.type === 'random') {
      if (envMap.has(envVar)) {
        envFile += `${envVar}=${envMap.get(envVar)}\n`;
      } else {
        const length = field.min || 32;
        const randomString = getEntropy(field.env_variable, length);

        envFile += `${envVar}=${randomString}\n`;
      }
    } else if (field.required) {
      throw new Error(`Variable ${field.env_variable} is required`);
    }
  });

  writeFile(`/app-data/${appName}/app.env`, envFile);
};

export const getAvailableApps = (): string[] => {
  const apps: string[] = [];

  const appsDir = readdirSync('/apps');

  appsDir.forEach((app) => {
    if (fileExists(`/apps/${app}/config.json`)) {
      const configFile: AppInfo = readJsonFile(`/apps/${app}/config.json`);

      if (configFile.available) {
        apps.push(app);
      }
    }
  });

  return apps;
};

export const getAppInfo = (id: string): AppInfo => {
  try {
    const configFile: AppInfo = readJsonFile(`/apps/${id}/config.json`);
    configFile.description = readFile(`/apps/${id}/metadata/description.md`);

    return configFile;
  } catch (e) {
    throw new Error(`App ${id} not found`);
  }
};