latex.ts

/*
 * latex.ts
 *
 * Copyright (C) 2020-2022 Posit Software, PBC
 */

import { basename, join } from "../../../deno_ral/path.ts";
import { existsSync, safeRemoveSync } from "../../../deno_ral/fs.ts";
import { error, info } from "../../../deno_ral/log.ts";

import { PdfEngine } from "../../../config/types.ts";

import { dirAndStem } from "../../../core/path.ts";
import { execProcess, ExecProcessOptions } from "../../../core/process.ts";
import { ProcessResult } from "../../../core/process-types.ts";

import { PackageManager } from "./pkgmgr.ts";
import { kLatexBodyMessageOptions } from "./types.ts";
import { hasTexLive, texLiveCmd, TexLiveContext } from "./texlive.ts";
import { withPath } from "../../../core/env.ts";
import { logProgress } from "../../../core/log.ts";

export interface LatexCommandReponse {
  log: string;
  result: ProcessResult;
  output?: string;
}

export async function hasLatexDistribution() {
  try {
    const result = await execProcess({
      cmd: "pdftex",
      args: ["--version"],
      stdout: "piped",
      stderr: "piped",
    });
    return result.code === 0;
  } catch {
    return false;
  }
}

const kLatexMkEngineFlags = [
  "-pdf",
  "-pdfdvi",
  "-pdfps",
  "-pdflua",
  "-pdfxe",
  "-pdf-",
];

// Runs the Pdf engine
export async function runPdfEngine(
  input: string,
  engine: PdfEngine,
  texLive: TexLiveContext,
  outputDir?: string,
  texInputDirs?: string[],
  pkgMgr?: PackageManager,
  quiet?: boolean,
): Promise<LatexCommandReponse> {
  // Input and log paths
  const [cwd, stem] = dirAndStem(input);
  const targetDir = outputDir ? join(cwd, outputDir) : cwd;
  const output = join(targetDir, `${stem}.pdf`);
  const log = join(targetDir, `${stem}.log`);

  // Clean any log file or output from previous runs
  [log, output].forEach((file) => {
    if (existsSync(file)) {
      safeRemoveSync(file);
    }
  });

  // build pdf engine command line
  // ensure that we provide latexmk with its require custom options
  // Note that users may control the latexmk engine options, but
  // if not specified, we should provide a default
  const computeEngineArgs = () => {
    if (engine.pdfEngine === "latexmk") {
      const engineArgs = ["-interaction=batchmode", "-halt-on-error"];
      if (
        !engine.pdfEngineOpts || engine.pdfEngineOpts.find((opt) => {
            return kLatexMkEngineFlags.includes(opt);
          }) === undefined
      ) {
        engineArgs.push("-pdf");
      }
      engineArgs.push("-quiet");
      return engineArgs;
    } else {
      return ["-interaction=batchmode", "-halt-on-error"];
    }
  };
  const args = computeEngineArgs();

  // output directory
  if (outputDir !== undefined) {
    args.push(`-output-directory=${outputDir}`);
  }

  // pdf engine opts
  if (engine.pdfEngineOpts) {
    args.push(...engine.pdfEngineOpts);
  }

  // input file
  args.push(basename(input));

  // Run the command
  const result = await runLatexCommand(
    engine.pdfEngine,
    args,
    {
      pkgMgr,
      cwd,
      texInputDirs,
      texLive,
    },
    quiet,
  );

  // Success, return result
  return {
    result,
    output,
    log,
  };
}

// Run the index generation engine (currently hard coded to makeindex)
export async function runIndexEngine(
  input: string,
  texLive: TexLiveContext,
  engine?: string,
  args?: string[],
  pkgMgr?: PackageManager,
  quiet?: boolean,
) {
  const [cwd, stem] = dirAndStem(input);
  const log = join(cwd, `${stem}.ilg`);

  // Clean any log file from previous runs
  if (existsSync(log)) {
    safeRemoveSync(log);
  }

  const result = await runLatexCommand(
    engine || "makeindex",
    [...(args || []), basename(input)],
    {
      cwd,
      pkgMgr,
      texLive,
    },
    quiet,
  );

  return {
    result,
    log,
  };
}

// Runs the bibengine to process citations
export async function runBibEngine(
  engine: string,
  input: string,
  cwd: string,
  texLive: TexLiveContext,
  pkgMgr?: PackageManager,
  texInputDirs?: string[],
  quiet?: boolean,
): Promise<LatexCommandReponse> {
  const [dir, stem] = dirAndStem(input);
  const log = join(dir, `${stem}.blg`);

  // Clean any log file from previous runs
  if (existsSync(log)) {
    safeRemoveSync(log);
  }

  const result = await runLatexCommand(
    engine,
    [input],
    {
      pkgMgr,
      cwd,
      texInputDirs,
      texLive,
    },
    quiet,
  );
  return {
    result,
    log,
  };
}

export interface LatexCommandContext {
  pkgMgr?: PackageManager;
  cwd?: string;
  texInputDirs?: string[];
  texLive: TexLiveContext;
}

async function runLatexCommand(
  latexCmd: string,
  args: string[],
  context: LatexCommandContext,
  quiet?: boolean,
): Promise<ProcessResult> {
  const fullLatexCmd = texLiveCmd(latexCmd, context.texLive);

  const runOptions: ExecProcessOptions = {
    cmd: fullLatexCmd.fullPath,
    args,
    stdout: "piped",
    stderr: "piped",
  };

  //Ensure that the bin directory is available as a part of PDF compilation
  if (context.texLive.binDir) {
    runOptions.env = runOptions.env || {};
    runOptions.env["PATH"] = withPath({ prepend: [context.texLive.binDir] });
  }

  // Set the working directory
  if (context.cwd) {
    runOptions.cwd = context.cwd;
  }

  // Add a tex search path
  // The // means that TeX programs will search recursively in that folder;
  // the trailing colon means "append the standard value of TEXINPUTS" (which you don't need to provide).
  if (context.texInputDirs && context.texInputDirs.length > 0) {
    // note this  //
    runOptions.env = runOptions.env || {};
    runOptions.env["TEXINPUTS"] = `${context.texInputDirs.join(";")};`;
    runOptions.env["BSTINPUTS"] = `${context.texInputDirs.join(";")};`;
  }

  // Run the command
  const runCmd = async () => {
    const result = await execProcess(runOptions, undefined, "stdout>stderr");
    if (!quiet && result.stderr) {
      info(result.stderr, kLatexBodyMessageOptions);
    }
    return result;
  };

  try {
    // Try running the command
    return await runCmd();
  } catch (_e) {
    // First confirm that there is a TeX installation available
    const tex = await hasTexLive() || await hasLatexDistribution();
    if (!tex) {
      info(
        "\nNo TeX installation was detected.\n\nPlease run 'quarto install tinytex' to install TinyTex.\nIf you prefer, you may install TexLive or another TeX distribution.\n",
      );
      return Promise.reject();
    } else if (context.pkgMgr && context.pkgMgr.autoInstall) {
      // If the command itself can't be found, try installing the command
      // if auto installation is enabled
      if (!quiet) {
        logProgress(
          `command ${latexCmd} not found, attempting install`,
        );
      }

      // Search for a package for this command
      const packageForCommand = await context.pkgMgr.searchPackages([latexCmd]);
      if (packageForCommand) {
        // try to install it
        await context.pkgMgr.installPackages(packagesForCommand(latexCmd));
      }
      // Try running the command again
      return await runCmd();
    } else {
      // Some other error has occurred
      error(
        `Error executing ${latexCmd}`,
      );

      return Promise.reject();
    }
  }
}

// Convert any commands to their
function packagesForCommand(cmd: string): string[] {
  if (cmd === "texindy") {
    return ["xindy"];
  } else {
    return [cmd];
  }
}