Merge pull request #11455 from quarto-dev/bugfix/7998

use safeRemoveDirSync when possible to avoid unexpected catastrophic directory deletions

Author: cscheid

news/changelog-1.6.md

@@ -91,6 +91,7 @@ All changes included in 1.6:
 
 ## Projects
 
+- ([#7988](https://github.com/quarto-dev/quarto-cli/issues/7988)): Do not allow `lib-dir` to cause an accidental cleanup of the project directory when its value points to a parent of the project directory.
 - ([#10125](https://github.com/quarto-dev/quarto-cli/issues/10125)): Show path to the project when project YAML validation fails.
 - ([#10268](https://github.com/quarto-dev/quarto-cli/issues/10268)): `quarto create` supports opening project in Positron, in addition to VS Code and RStudio IDE.
 - ([#10285](https://github.com/quarto-dev/quarto-cli/issues/10285)): Include text from before the first chapter sections in search indices. In addition, include text of every element with `.quarto-include-in-search-index` class in search indices.

src/command/render/cleanup.ts

@@ -4,7 +4,7 @@
  * Copyright (C) 2020-2022 Posit Software, PBC
  */
 
-import { existsSync } from "../../deno_ral/fs.ts";
+import { existsSync, safeRemoveDirSync } from "../../deno_ral/fs.ts";
 import { dirname, extname, isAbsolute, join } from "../../deno_ral/path.ts";
 
 import * as ld from "../../core/lodash.ts";
@@ -22,11 +22,13 @@ import { isHtmlFileOutput, isLatexOutput } from "../../config/format.ts";
 import { kKeepMd, kKeepTex, kKeepTyp } from "../../config/constants.ts";
 
 import { filesDirLibDir, filesDirMediabagDir } from "./render-paths.ts";
+import { ProjectContext } from "../../project/types.ts";
 
 export function renderCleanup(
   input: string,
   output: string,
   format: Format,
+  project: ProjectContext,
   supporting?: string[],
   keepMd?: string,
 ) {
@@ -90,7 +92,7 @@ export function renderCleanup(
     // clean supporting
     ld.uniq(supporting).forEach((path) => {
       if (existsSync(path)) {
-        safeRemoveSync(path, { recursive: true });
+        safeRemoveDirSync(path, project.dir);
       }
     });
   }

src/command/render/latexmk/latex.ts

@@ -5,7 +5,7 @@
  */
 
 import { basename, join } from "../../../deno_ral/path.ts";
-import { existsSync } from "../../../deno_ral/fs.ts";
+import { existsSync, safeRemoveSync } from "../../../deno_ral/fs.ts";
 import { error, info } from "../../../deno_ral/log.ts";
 
 import { PdfEngine } from "../../../config/types.ts";
@@ -67,7 +67,7 @@ export async function runPdfEngine(
   // Clean any log file or output from previous runs
   [log, output].forEach((file) => {
     if (existsSync(file)) {
-      Deno.removeSync(file);
+      safeRemoveSync(file);
     }
   });
 
@@ -141,7 +141,7 @@ export async function runIndexEngine(
 
   // Clean any log file from previous runs
   if (existsSync(log)) {
-    Deno.removeSync(log);
+    safeRemoveSync(log);
   }
 
   const result = await runLatexCommand(
@@ -176,7 +176,7 @@ export async function runBibEngine(
 
   // Clean any log file from previous runs
   if (existsSync(log)) {
-    Deno.removeSync(log);
+    safeRemoveSync(log);
   }
 
   const result = await runLatexCommand(

src/command/render/latexmk/pdf.ts

@@ -5,7 +5,7 @@
  */
 
 import { dirname, join } from "../../../deno_ral/path.ts";
-import { existsSync } from "../../../deno_ral/fs.ts";
+import { existsSync, safeRemoveSync } from "../../../deno_ral/fs.ts";
 
 import { PdfEngine } from "../../../config/types.ts";
 import { LatexmkOptions } from "./types.ts";
@@ -594,7 +594,7 @@ function cleanup(workingDir: string, stem: string) {
 
   auxFiles.forEach((auxFile) => {
     if (existsSync(auxFile)) {
-      Deno.removeSync(auxFile);
+      safeRemoveSync(auxFile);
     }
   });
 }

src/command/render/output-tex.ts

@@ -5,7 +5,7 @@
  */
 
 import { dirname, join, normalize, relative } from "../../deno_ral/path.ts";
-import { ensureDirSync } from "../../deno_ral/fs.ts";
+import { ensureDirSync, safeRemoveSync } from "../../deno_ral/fs.ts";
 
 import { writeFileToStdout } from "../../core/console.ts";
 import { dirAndStem, expandPath } from "../../core/path.ts";
@@ -78,14 +78,14 @@ export function texToPdfOutputRecipe(
     // keep tex if requested
     const compileTex = join(inputDir, output);
     if (!format.render[kKeepTex]) {
-      Deno.removeSync(compileTex);
+      safeRemoveSync(compileTex);
     }
 
     // copy (or write for stdout) compiled pdf to final output location
     if (finalOutput) {
       if (finalOutput === kStdOut) {
         writeFileToStdout(pdfOutput);
-        Deno.removeSync(pdfOutput);
+        safeRemoveSync(pdfOutput);
       } else {
         const outputPdf = expandPath(finalOutput);
 
@@ -99,9 +99,10 @@ export function texToPdfOutputRecipe(
 
       // Clean the output directory if it is empty
       if (pdfOutputDir) {
+        console.log({ pdfOutputDir });
         try {
           // Remove the outputDir if it is empty
-          Deno.removeSync(pdfOutputDir, { recursive: false });
+          safeRemoveSync(pdfOutputDir, { recursive: false });
         } catch {
           // This is ok, just means the directory wasn't empty
         }

src/command/render/output-typst.ts

@@ -5,7 +5,7 @@
  */
 
 import { dirname, join, normalize, relative } from "../../deno_ral/path.ts";
-import { ensureDirSync } from "../../deno_ral/fs.ts";
+import { ensureDirSync, safeRemoveSync } from "../../deno_ral/fs.ts";
 
 import {
   kFontPaths,
@@ -81,14 +81,14 @@ export function typstPdfOutputRecipe(
 
     // keep typ if requested
     if (!format.render[kKeepTyp]) {
-      Deno.removeSync(input);
+      safeRemoveSync(input);
     }
 
     // copy (or write for stdout) compiled pdf to final output location
     if (finalOutput) {
       if (finalOutput === kStdOut) {
         writeFileToStdout(pdfOutput);
-        Deno.removeSync(pdfOutput);
+        safeRemoveSync(pdfOutput);
       } else {
         const outputPdf = expandPath(finalOutput);
 

src/command/render/output.ts

@@ -15,7 +15,7 @@ import {
 } from "../../deno_ral/path.ts";
 
 import { writeFileToStdout } from "../../core/console.ts";
-import { dirAndStem, expandPath } from "../../core/path.ts";
+import { dirAndStem, expandPath, safeRemoveSync } from "../../core/path.ts";
 import {
   parse as parseYaml,
   partitionYamlFrontMatter,
@@ -209,7 +209,7 @@ export function outputRecipe(
       recipe.isOutputTransient = true;
       completeActions.push(() => {
         writeFileToStdout(join(inputDir, recipe.output));
-        Deno.removeSync(join(inputDir, recipe.output));
+        safeRemoveSync(join(inputDir, recipe.output));
       });
     } else if (!isAbsolute(recipe.output)) {
       // relatve output file on the command line: make it relative to the input dir

src/command/render/project.ts

@@ -4,7 +4,14 @@
  * Copyright (C) 2020-2022 Posit Software, PBC
  */
 
-import { ensureDirSync, existsSync, safeMoveSync } from "../../deno_ral/fs.ts";
+import {
+  ensureDirSync,
+  existsSync,
+  safeMoveSync,
+  safeRemoveDirSync,
+  safeRemoveSync,
+  UnsafeRemovalError,
+} from "../../deno_ral/fs.ts";
 import { dirname, isAbsolute, join, relative } from "../../deno_ral/path.ts";
 import { info, warning } from "../../deno_ral/log.ts";
 import { mergeProjectMetadata } from "../../config/metadata.ts";
@@ -481,7 +488,18 @@ export async function renderProject(
         return;
       }
       if (existsSync(targetDir)) {
-        Deno.removeSync(targetDir, { recursive: true });
+        try {
+          safeRemoveDirSync(targetDir, context.dir);
+        } catch (e) {
+          if (e instanceof UnsafeRemovalError) {
+            warning(
+              `Refusing to remove directory ${targetDir} since it is not a subdirectory of the main project directory.`,
+            );
+            warning(
+              `Quarto did not expect the path configuration being used in this project, and strange behavior may result.`,
+            );
+          }
+        }
       }
       ensureDirSync(dirname(targetDir));
       if (copy) {
@@ -494,7 +512,7 @@ export async function renderProject(
           // because src and target are in different file systems.
           // In that case, try to recursively copy from src
           copyTo(srcDir, targetDir);
-          Deno.removeSync(srcDir, { recursive: true });
+          safeRemoveDirSync(targetDir, context.dir);
         }
       }
     };
@@ -906,7 +924,7 @@ export async function renderProject(
   if (projectRenderConfig.options.forceClean) {
     const scratchDir = join(projDir, kQuartoScratch);
     if (existsSync(scratchDir)) {
-      Deno.removeSync(scratchDir, { recursive: true });
+      safeRemoveSync(scratchDir, { recursive: true });
     }
   }
 

src/command/render/render.ts

@@ -377,6 +377,7 @@ export async function renderPandoc(
             context.target.input,
             finalOutput!,
             format,
+            file.context.project,
             cleanupSelfContained,
             executionEngineKeepMd(context),
           ));

src/core/copy.ts

@@ -18,6 +18,7 @@ import {
   existsSync,
   getFileInfoType,
   isSubdir,
+  safeRemoveSync,
   walkSync,
 } from "../deno_ral/fs.ts";
 
@@ -146,7 +147,7 @@ function copyFileSync(
   // multiple users/owners in play). see this code for where this occurs:
   // https://github.com/denoland/deno/blob/1c05e41f37da022971f0090b2a92e6340d230055/runtime/ops/fs.rs#L914-L916
   if (existsSync(dest)) {
-    Deno.removeSync(dest);
+    safeRemoveSync(dest);
   }
   Deno.copyFileSync(src, dest);
 
@@ -196,7 +197,7 @@ function copySymlinkSync(
   ensureValidCopySync(src, dest, options);
   // remove dest if it exists
   if (existsSync(dest)) {
-    Deno.removeSync(dest);
+    safeRemoveSync(dest);
   }
   const originSrcFilePath = Deno.readLinkSync(src);
   const type = getFileInfoType(Deno.lstatSync(src));