output-tex.ts

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

import { dirname, join, normalize, relative } from "../../deno_ral/path.ts";
import { ensureDirSync, safeRemoveSync } from "../../deno_ral/fs.ts";

import { writeFileToStdout } from "../../core/console.ts";
import { dirAndStem, expandPath } from "../../core/path.ts";
import { texSafeFilename } from "../../core/tex.ts";

import {
  kKeepTex,
  kOutputExt,
  kOutputFile,
  kPdfStandard,
  kPdfStandardApplied,
  kTargetFormat,
  pdfStandardEnv,
} from "../../config/constants.ts";
import { Format } from "../../config/types.ts";
import { asArray } from "../../core/array.ts";
import { validatePdfStandards } from "../../core/verapdf.ts";

import { PandocOptions, RenderFlags, RenderOptions } from "./types.ts";
import { kStdOut, replacePandocOutputArg } from "./flags.ts";
import { OutputRecipe } from "./types.ts";
import { pdfEngine } from "../../config/pdf.ts";
import { execProcess } from "../../core/process.ts";
import { parseFormatString } from "../../core/pandoc/pandoc-formats.ts";
import { normalizeOutputPath } from "./output-shared.ts";

export interface PdfGenerator {
  generate: (
    input: string,
    format: Format,
    pandocOptions: PandocOptions,
  ) => Promise<string>;
  computePath: (texStem: string, inputDir: string, format: Format) => string;
}

export function texToPdfOutputRecipe(
  input: string,
  finalOutput: string,
  options: RenderOptions,
  format: Format,
  pdfIntermediateTo: string,
  pdfGenerator: PdfGenerator,
  pdfOutputDir?: string | null,
): OutputRecipe {
  // break apart input file
  const [inputDir, inputStem] = dirAndStem(input);

  // there are many characters that give tex trouble in filenames, create
  // a target stem that replaces them with the '-' character

  // include variants in the tex stem if they are present to avoid
  // overwriting files
  let fixupInputName = "";
  if (format.identifier[kTargetFormat]) {
    const formatDesc = parseFormatString(format.identifier[kTargetFormat]);
    fixupInputName = `${formatDesc.variants.join("")}${
      formatDesc.modifiers.join("")
    }`;
  }

  const texStem = texSafeFilename(`${inputStem}${fixupInputName}`);

  // calculate output and args for pandoc (this is an intermediate file
  // which we will then compile to a pdf and rename to .tex)
  const output = texStem + ".tex";
  let args = options.pandocArgs || [];
  const pandoc = { ...format.pandoc };
  if (options.flags?.output) {
    args = replacePandocOutputArg(args, output);
  } else {
    pandoc[kOutputFile] = output;
  }

  // when pandoc is done, we need to run the pdf generator and then copy the
  // ouptut to the user's requested destination
  const complete = async (pandocOptions: PandocOptions) => {
    const input = join(inputDir, output);
    const pdfOutput = await pdfGenerator.generate(input, format, pandocOptions);

    // Validate PDF against applied standards using verapdf (if available)
    // Use kPdfStandardApplied from pandocOptions.format.metadata (filtered by LaTeX support)
    // if available, otherwise fall back to original kPdfStandard list
    const pdfStandards = asArray(
      pandocOptions.format.metadata?.[kPdfStandardApplied] ??
        format.render?.[kPdfStandard] ??
        format.metadata?.[kPdfStandard] ??
        pdfStandardEnv(),
    ) as string[];
    if (pdfStandards.length > 0) {
      await validatePdfStandards(pdfOutput, pdfStandards, {
        quiet: pandocOptions.flags?.quiet,
      });
    }

    // keep tex if requested
    const compileTex = join(inputDir, output);
    if (!format.render[kKeepTex]) {
      safeRemoveSync(compileTex);
    }

    // copy (or write for stdout) compiled pdf to final output location
    if (finalOutput) {
      if (finalOutput === kStdOut) {
        writeFileToStdout(pdfOutput);
        safeRemoveSync(pdfOutput);
      } else {
        const outputPdf = expandPath(finalOutput);

        if (normalize(pdfOutput) !== normalize(outputPdf)) {
          // ensure the target directory exists
          ensureDirSync(dirname(outputPdf));

          Deno.renameSync(pdfOutput, outputPdf);
        }
      }

      // Clean the output directory if it is empty
      if (pdfOutputDir) {
        console.log({ pdfOutputDir });
        try {
          // Remove the outputDir if it is empty
          safeRemoveSync(pdfOutputDir, { recursive: false });
        } catch {
          // This is ok, just means the directory wasn't empty
        }
      }

      // final output needs to either absolute or input dir relative
      // (however it may be working dir relative when it is passed in)
      return normalizeOutputPath(input, finalOutput);
    } else {
      return normalizeOutputPath(input, pdfOutput);
    }
  };

  const pdfOutput = finalOutput
    ? finalOutput === kStdOut
      ? undefined
      : normalizeOutputPath(input, finalOutput)
    : normalizeOutputPath(
      input,
      pdfGenerator.computePath(texStem, dirname(input), format),
    );

  // tweak writer if it's pdf
  const to = format.pandoc.to === "pdf" ? pdfIntermediateTo : format.pandoc.to;

  // return recipe
  return {
    output,
    keepYaml: false,
    args,
    format: {
      ...format,
      pandoc: {
        ...pandoc,
        to,
      },
    },
    complete,
    finalOutput: pdfOutput ? relative(inputDir, pdfOutput) : undefined,
  };
}

export function useContextPdfOutputRecipe(
  format: Format,
  flags?: RenderFlags,
) {
  const kContextPdfEngine = "context";
  if (format.pandoc.to === "pdf" && format.render[kOutputExt] === "pdf") {
    const engine = pdfEngine(format.pandoc, format.render, flags);
    return engine.pdfEngine === kContextPdfEngine;
  } else {
    return false;
  }
}

// based on: https://github.com/rstudio/rmarkdown/blob/main/R/context_document.R

export function contextPdfOutputRecipe(
  input: string,
  finalOutput: string,
  options: RenderOptions,
  format: Format,
): OutputRecipe {
  const computePath = (stem: string, dir: string, _format: Format) => {
    return join(dir, stem + ".pdf");
  };

  const generate = async (
    input: string,
    format: Format,
    pandocOptions: PandocOptions,
  ): Promise<string> => {
    // derive engine (parse opts, etc.)
    const engine = pdfEngine(format.pandoc, format.render, pandocOptions.flags);

    // build context command
    const cmd = "context";
    const args = [input];
    if (engine.pdfEngineOpts) {
      args.push(...engine.pdfEngineOpts);
    }
    args.push(
      // ConTeXt produces some auxiliary files:
      // direct PDF generation by Pandoc never produces these auxiliary
      // files because Pandoc runs ConTeXt in a temporary directory.
      // Replicate Pandoc's behavior using "--purgeall" option
      "--purgeall",
      // Pandoc runs ConteXt with "--batchmode" option. Do the same.
      "--batchmode",
    );

    // run context
    const result = await execProcess({
      cmd,
      args,
    });
    if (result.success) {
      const [dir, stem] = dirAndStem(input);
      return computePath(stem, dir, format);
    } else {
      throw new Error();
    }
  };

  return texToPdfOutputRecipe(
    input,
    finalOutput,
    options,
    format,
    "context",
    {
      generate,
      computePath,
    },
  );
}