validate.js

// > The plan is to have the user setup only the bare minimum, and then have the server create the rest.
// > Once secrets, binaries and some basic configuration is set up, the first launch will put epochtal into
// > a fully usable state, having a first week and everything set up.
// - PancakeTAS

const fs = require("fs");

/**
 * Ensure a directory exists, creating it if it doesn't.
 *
 * @author PancakeTAS
 * @param {string} dir The directory to ensure.
 */
function ensureDir(dir) {
  if (!fs.existsSync(dir)) {
    fs.mkdirSync(dir);
  }
}

/**
 * Ensure a file exists, creating it with the provided content if it doesn't.
 *
 * @author PancakeTAS
 * @param {string} file The file to ensure.
 * @param {string} content The content to write to the file if it doesn't exist
 */
async function ensureFile(file, content) {
  if (!fs.existsSync(file)) {
    await Bun.write(file, content);
  }
}

/**
 * Validate the global config and the basic directory structure.
 *
 * @author PancakeTAS
 * @returns {boolean} Whether the setup is valid or not.
 */
async function validate() {
  // Validate the global config
  if (!gconfig.domain || !gconfig.secretsdir || !gconfig.datadir || !gconfig.bindir || !gconfig.port) {
    console.log("Global config is missing required fields: [domain, tls, https, secretsdir, datadir, bindir]");
    return false;
  }

  // Validate bindir
  if (!fs.existsSync(`${gconfig.bindir}/bspsrc`)) {
    console.log("BSPSource is not installed, epochtal will not function properly without it.");
    console.log("> https://github.com/ata4/bspsrc/releases");
    return false;
  }

  if (!fs.existsSync(`${gconfig.bindir}/mdp-json`)) {
    console.log("mdp-json is not installed, epochtal will not function properly without it.");
    console.log("> https://github.com/p2r3/mdp-json");
    return false;
  }

  if (!fs.existsSync(`${gconfig.bindir}/UntitledParser`)) {
    console.log("UntitledParser is not installed, epochtal will not function properly without it.");
    console.log("> https://github.com/UncraftedName/UntitledParser/releases");
    return false;
  }

  // Validate secretsdir
  if (gconfig.tls && (!fs.existsSync(`${gconfig.secretsdir}/fullchain.pem`) || !fs.existsSync(`${gconfig.secretsdir}/privkey.pem`))) {
    console.log("TLS is enabled, but fullchain.pem and privkey.pem are missing from secretsdir.");
    console.log("> Generate self-signed certificates or obtain them from a certificate authority.");
    return false;
  }

  if (!fs.existsSync(`${gconfig.secretsdir}/weights.js`)) {
    console.log("weights.js is missing from secretsdir. Dumping default weights...");
    await Bun.write(`${gconfig.secretsdir}/weights.js`, `module.exports = ${JSON.stringify(WEIGHTS, null, 2)};`);
  }


  // Validate basic datadir structure

  ensureDir(`${gconfig.datadir}`);
  ensureDir(`${gconfig.datadir}/.tmp`);
  ensureDir(`${gconfig.datadir}/archives`);
  ensureDir(`${gconfig.datadir}/profiles`);
  ensureDir(`${gconfig.datadir}/spplice`);
  ensureDir(`${gconfig.datadir}/week`);
  ensureDir(`${gconfig.datadir}/week/proof`);
  ensureDir(`${gconfig.datadir}/week/maps`);
  ensureDir(`${gconfig.datadir}/week/mdp`);

  await ensureFile(`${gconfig.datadir}/users.json`, "{}");
  await ensureFile(`${gconfig.datadir}/entgraphs.json`, "{}");
  await ensureFile(`${gconfig.datadir}/suggestions.json`, "[]");
  await ensureFile(`${gconfig.datadir}/util.error`, "");
  await ensureFile(`${gconfig.datadir}/util.print`, "");
  await ensureFile(`${gconfig.datadir}/spplice/index.json`, `{"packages":[]}`);
  await ensureFile(`${gconfig.datadir}/week/config.json`, `{"categories":[],"votingmaps":[{"id":"140534764"}],"votes":{},"number":0}`);
  await ensureFile(`${gconfig.datadir}/week/leaderboard.json`, "{}");
  await ensureFile(`${gconfig.datadir}/week/week.log`, "");
  await ensureFile(`${gconfig.datadir}/week/mdp/filesum_whitelist.txt`, "");
  await ensureFile(`${gconfig.datadir}/week/mdp/sar_whitelist.txt`, "");

  // Validate process environment
  if (
      !process.env.STEAM_API_KEY
      || !process.env.DISCORD_API_KEY
      || !process.env.JWT_SECRET
      || !process.env.INTERNAL_SECRET
      || !process.env.DISCORD_CHANNEL_ANNOUNCE
      || !process.env.DISCORD_CHANNEL_REPORT
      || !process.env.DISCORD_CHANNEL_UPDATE
  ) {
    console.error("One or more environment variables are missing. Epochtal cannot run unless all necessary variables are present.");
    return false;
  }

  return true;
}

/**
 * Setup the epochtal server on first launch.
 *
 * @author PancakeTAS
 */
async function setup () {

  const routines = require("./util/routine.js");
  const categories = require("./util/categories.js");

  // Get epochtal up and running
  await routines(["run", "epochtal", "concludeWeek"]);
  await routines(["run", "epochtal", "releaseMap"]);

  // Create traditional categories
  await categories(["add", "main", "Inbounds CM", false, false, false, "demo", true]);
  await categories(["add", "lp", "Least Portals", true, false, false, "any", true]);
  await categories(["add", "ppnf", "Portal Placement Never Fail", false, false, false, "demo", false]);
  await categories(["add", "tas", "Tool Assisted Speedrun", false, false, false, "any", false]);
  await categories(["add", "meme", "Meme", false, false, false, "video", false]);
  await categories(["add", "coop", "Co-op Mode", false, true, false, "demo", true]);

  // Delete first archive
  fs.rmSync(`${gconfig.datadir}/archives/week0`, { recursive: true, force: true });

  // Build the Epochtal Live package
  await routines(["run", "live", "rebuildPackage"]);

  // Create first run file
  await Bun.write(`${gconfig.datadir}/.first-run`, "");
}

module.exports = {
  validate,
  setup
};

// default weights
const WEIGHTS = {
  v1: {
    PREVIEWS: 1,
    PREVIEWS_EXTRA: 1,
    PREVIEWS_VIDEO: 1,
    TAGS_COUNT: 1,
    TAGS_VISUALS: 1,
    HAMMER: 1,
    FILENAME: 1,
    DESC_NEWLINE: 1,
    DESC_FORMATTING: 1,
    REVISION: 1,
    TEXT_TURRETS: 1,
    TEXT_BEEMOD: 1,
    TEXT_RECREATION: 1,
    TITLE_LENGTH: 1,
    TITLE_CASE: 1,
    PLAYTIME_GAME: 1,
    PLAYTIME_EDITOR: 1,
    AUTHOR_WORKSHOP: 1
  },
  v2: {
    QUALITY_DEFAULT: 1,
    QUALITY_PUNISH: 1,
    SCORE_EXPONENT: 1,
    GROUPING_DEPTH: 1
  }
};