configure.ts

/*
 * dependencies.ts
 *
 * Copyright (C) 2020-2022 Posit Software, PBC
 */
import { dirname, join, SEP } from "../../../src/deno_ral/path.ts";
import { existsSync, ensureDirSync } from "../../../src/deno_ral/fs.ts";
import { info, warning } from "../../../src/deno_ral/log.ts";

import { expandPath } from "../../../src/core/path.ts";
import {
  createDevConfig,
  writeDevConfig,
} from "../../../src/core/devconfig.ts";

import { Configuration } from "./config.ts";
import {
  configureDependency,
  kDependencies,
} from "./dependencies/dependencies.ts";
import { suggestUserBinPaths, which } from "../../../src/core/path.ts";
import { buildQuartoPreviewJs } from "./previewjs.ts";
import { isWindows } from "../../../src/deno_ral/platform.ts";

export async function configure(
  config: Configuration,
) {
  // npm is required later for building quarto-preview.js (used by `quarto
  // preview` live-reload). Check upfront to fail fast before downloading
  // hundreds of MB of dependencies when npm is missing.
  if ((await which("npm")) === undefined) {
    throw new Error(
      "npm not found on PATH. Please install Node.js (which provides npm) before running configure.",
    );
  }

  // Download dependencies
  for (const dependency of kDependencies) {
    const targetDir = join(
      config.directoryInfo.bin,
      "tools",
    );
    await configureDependency(dependency, targetDir, config);
  }

  info("Building quarto-preview.js...");
  const result = buildQuartoPreviewJs(config.directoryInfo.src);
  if (!result.success) {
    throw new Error();
  }
  info("Build completed.");

  // Move the quarto script into place
  info("Placing Quarto script");
  copyQuartoScript(config, config.directoryInfo.bin);

  info("Creating architecture specific Pandoc link");
  const vendor = Deno.env.get("QUARTO_VENDOR_BINARIES");
  if (vendor === undefined || vendor === "true") {
    // Quarto tools may look right in the bin/tools directory for Pandoc
    // so make a symlink that points to the architecture specific version.
    // Note that if we are being instructed not to vendor binaries,
    // Pandoc won't be present in the architecture specific directory, so 
    // just skip this step.
    copyPandocScript(config, join(config.directoryInfo.bin, "tools"));
  }

  // record dev config. These are versions as defined in the root configuration file.
  const devConfig = createDevConfig(
    Deno.env.get("DENO") || "",
    Deno.env.get("DENO_DOM") || "",
    Deno.env.get("PANDOC") || "",
    Deno.env.get("DARTSASS") || "",
    Deno.env.get("ESBUILD") || "",
    Deno.env.get("TYPST") || "",
    config.directoryInfo.bin,
  );
  writeDevConfig(devConfig, config.directoryInfo.bin);
  info("Wrote dev config to bin directory");

  if (
    config.os !== "windows" &&
    Deno.env.get("QUARTO_NO_SYMLINK") === undefined
  ) {
    info("Creating Quarto Symlink");

    // Set up a symlink (if appropriate)
    const possibleBinPaths = suggestUserBinPaths();
    const symlinksFiltered = possibleBinPaths.map((path) =>
      join(path, "quarto")
    );

    info(`Found ${symlinksFiltered.length} paths to try.`);

    if (symlinksFiltered.length > 0) {
      for (let i = 0; i < symlinksFiltered.length; i++) {
        info(`> Trying ${symlinksFiltered[i]}`);
        const symlinkPath = expandPath(symlinksFiltered[i]);

        // Remove existing symlink
        try {
          if (existsSync(symlinkPath)) {
            Deno.removeSync(symlinkPath);
          }
        } catch (error) {
          info(error);
          warning(
            "\n> Failed to remove existing symlink.\n> Did you previously install with sudo? Run 'which quarto' to test which version will be used.",
          );
        }

        // Create new symlink
        try {
          ensureDirSync(dirname(symlinkPath) + SEP);

          Deno.symlinkSync(
            join(config.directoryInfo.bin, "quarto"),
            symlinkPath,
          );

          info(`> Symlink created at ${symlinkPath}`);
          info("> Success");
          // it worked, just move on
          break;
        } catch (_error) {
          info(`> Didn't create symlink at ${symlinkPath}`);
          if (i === symlinksFiltered.length - 1) {
            warning(
              `\n> Please ensure that ${
                join(config.directoryInfo.bin, "quarto")
              } is in your path.`,
            );
          }
        }
      }
    } else {
      // Just warn the user and create a symlink in our last resort
      warning(
        `\n> Please ensure that ${
          join(config.directoryInfo.bin, "quarto")
        } is in your path.`,
      );
    }
  }
}

export function copyQuartoScript(config: Configuration, targetDir: string) {
  // Move the quarto script into place
  if (config.os === "windows") {
    Deno.copyFileSync(
      join(config.directoryInfo.pkg, "scripts", "windows", "quarto.cmd"),
      join(targetDir, "quarto.cmd"),
    );
  } else {
    const out = join(targetDir, "quarto");
    Deno.copyFileSync(
      join(config.directoryInfo.pkg, "scripts", "common", "quarto"),
      out,
    );
    Deno.chmodSync(out, 0o755);
  }
}

export function copyPandocScript(config: Configuration, targetDir: string) {
  const linkTarget = join(config.arch, "pandoc");
  
  const pandocFile = join(targetDir, "pandoc");
  if (existsSync(pandocFile)) {
    info("> removing existing pandoc link");
    Deno.removeSync(pandocFile);
  }

  if (!isWindows) {
    info("> creating pandoc symlink");
    Deno.run({
      cwd: targetDir,
      cmd: ["ln", "-s", linkTarget, "pandoc"]
    });  
  }
}

export function copyPandocAliasScript(config: Configuration, toolsDir: string) {
    // Move the quarto script into place
    if (config.os === "darwin") {
      const out = join(toolsDir, "pandoc");
      Deno.copyFileSync(
        join(config.directoryInfo.pkg, "scripts", "macos", "pandoc"),
        out,
      );
      Deno.chmodSync(out, 0o755);
    } else if (config.os === "linux") {
      const out = join(toolsDir, "pandoc");
      Deno.copyFileSync(
        join(config.directoryInfo.pkg, "scripts", "linux", "pandoc"),
        out,
      );
      Deno.chmodSync(out, 0o755);
    }
}