Merge pull request #1833 from rktjmp/feat-upload-no-clobber

Dont clobber existing files when uploading

Author: zefhemel

client/codemirror/editor_paste.ts

@@ -36,6 +36,26 @@ function striptHtmlComments(s: string): string {
   return s.replace(/<!--[\s\S]*?-->/g, "");
 }
 
+function ensureValidFilenameWithExtension(filename: string): string {
+  if (isValidPath(filename)) {
+    return filename;
+  }
+  const match = filename.match(/\.([^.]+)$/);
+  return `file.${match ? match[1] : "txt"}`;
+}
+
+async function doesFileExist(
+  editor: Client,
+  filePath: string,
+): Promise<boolean> {
+  try {
+    await editor.space.spacePrimitives.getFileMeta(filePath);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
 const urlRegexp =
   /^https?:\/\/[-a-zA-Z0-9@:%._\+~#=]{1,256}([-a-zA-Z0-9()@:%_\+.~#?&//=]*)/;
 
@@ -207,6 +227,9 @@ export function documentExtension(editor: Client) {
 
   async function saveFile(file: UploadFile) {
     const maxSize = maximumDocumentSize;
+    const invalidPathMessage =
+      "Unable to upload file, invalid target filename or path";
+
     if (file.content.length > maxSize * 1024 * 1024) {
       editor.flashNotification(
         `Document is too large, maximum is ${maxSize}MiB`,
@@ -215,21 +238,62 @@ export function documentExtension(editor: Client) {
       return;
     }
 
-    const finalFilePath = await editor.prompt(
+    let desiredFilePath = await editor.prompt(
       "File name for pasted document",
       resolveMarkdownLink(
         client.currentPath(),
-        isValidPath(file.name)
-          ? file.name
-          : `file.${
-            file.name.indexOf(".") !== -1 ? file.name.split(".").pop() : "txt"
-          }`,
+        ensureValidFilenameWithExtension(file.name),
       ),
     );
-    if (!finalFilePath || !isValidName(finalFilePath)) {
+    if (desiredFilePath === undefined) {
+      // User hit cancel, so they know why we stopped and dont need an notification.
+      return;
+    }
+    desiredFilePath = desiredFilePath.trim();
+    if (!isValidName(desiredFilePath)) {
+      editor.flashNotification(invalidPathMessage, "error");
       return;
     }
 
+    // Check the given desired file path wont clobber an existing file. If it
+    // would, ask the user to confirm or provide another filename. Repeat this
+    // check for every new filename they give.
+    // Note: duplicate any modifications here to client/code_mirror/editor_paste.ts
+    let finalFilePath = null;
+    while (finalFilePath == null) {
+      if (await doesFileExist(editor, desiredFilePath)) {
+        let confirmedFilePath = await editor.prompt(
+          "A file with that name already exists, keep the same name to replace it, or rename your file",
+          resolveMarkdownLink(
+            client.currentPath(),
+            ensureValidFilenameWithExtension(desiredFilePath),
+          ),
+        );
+        if (confirmedFilePath === undefined) {
+          // Unlike the initial filename prompt, we're inside a workflow here
+          // and should be explicit that the user action cancelled the whole
+          // operation.
+          editor.flashNotification("Upload cancelled by user", "info");
+          return;
+        }
+        confirmedFilePath = confirmedFilePath.trim();
+        if (!isValidPath(confirmedFilePath)) {
+          editor.flashNotification(invalidPathMessage, "error");
+          return;
+        }
+        if (desiredFilePath === confirmedFilePath) {
+          // if we got back the same path, we're replacing and should accept the given name
+          finalFilePath = desiredFilePath;
+        } else {
+          // we got a new path, so we must repeat the check
+          desiredFilePath = confirmedFilePath;
+          confirmedFilePath = undefined;
+        }
+      } else {
+        finalFilePath = desiredFilePath;
+      }
+    }
+
     await editor.space.writeDocument(finalFilePath, file.content);
     let documentMarkdown = `[[${finalFilePath}]]`;
     if (file.contentType.startsWith("image/")) {

plugs/editor/upload.ts

@@ -10,11 +10,22 @@ import {
 } from "@silverbulletmd/silverbullet/lib/ref";
 import type { UploadFile } from "@silverbulletmd/silverbullet/type/client";
 
+function ensureValidFilenameWithExtension(filename: string): string {
+  if (isValidPath(filename)) {
+    return filename;
+  }
+  const match = filename.match(/\.([^.]+)$/);
+  return `file.${match ? match[1] : "txt"}`;
+}
+
 export async function saveFile(file: UploadFile) {
+  const invalidPathMessage =
+    "Unable to upload file, invalid target filename or path";
   const maxSize = await system.getConfig<number>(
     "maximumDocumentSize",
     maximumDocumentSize,
   );
+
   if (typeof maxSize !== "number") {
     await editor.flashNotification(
       "The setting 'maximumDocumentSize' must be a number",
@@ -29,21 +40,62 @@ export async function saveFile(file: UploadFile) {
     return;
   }
 
-  const finalFilePath = await editor.prompt(
-    "File name for pasted document",
+  let desiredFilePath = await editor.prompt(
+    "File name for uploaded document",
     resolveMarkdownLink(
       await editor.getCurrentPath(),
-      isValidPath(file.name)
-        ? file.name
-        : `file.${
-          file.name.indexOf(".") !== -1 ? file.name.split(".").pop() : "txt"
-        }`,
+      ensureValidFilenameWithExtension(file.name),
     ),
   );
-  if (!finalFilePath || !isValidPath(finalFilePath)) {
+  if (desiredFilePath === undefined) {
+    // User hit cancel, so they know why we stopped and dont need an notification.
+    return;
+  }
+  desiredFilePath = desiredFilePath.trim();
+  if (!isValidPath(desiredFilePath)) {
+    editor.flashNotification(invalidPathMessage, "error");
     return;
   }
 
+  // Check the given desired file path wont clobber an existing file. If it
+  // would, ask the user to confirm or provide another filename. Repeat this
+  // check for every new filename they give.
+  // Note: duplicate any modifications here to client/code_mirror/editor_paste.ts
+  let finalFilePath = null;
+  while (finalFilePath == null) {
+    if (await space.fileExists(desiredFilePath)) {
+      let confirmedFilePath = await editor.prompt(
+        "A file with that name already exists, keep the same name to replace it, or rename your file",
+        resolveMarkdownLink(
+          await editor.getCurrentPath(),
+          ensureValidFilenameWithExtension(desiredFilePath),
+        ),
+      );
+      if (confirmedFilePath === undefined) {
+        // Unlike the initial filename prompt, we're inside a workflow here
+        // and should be explicit that the user action cancelled the whole
+        // operation.
+        editor.flashNotification("Upload cancelled by user", "info");
+        return;
+      }
+      confirmedFilePath = confirmedFilePath.trim();
+      if (!isValidPath(confirmedFilePath)) {
+        editor.flashNotification(invalidPathMessage, "error");
+        return;
+      }
+      if (desiredFilePath === confirmedFilePath) {
+        // if we got back the same path, we're replacing and should accept the given name
+        finalFilePath = desiredFilePath;
+      } else {
+        // we got a new path, so we must repeat the check
+        desiredFilePath = confirmedFilePath;
+        confirmedFilePath = undefined;
+      }
+    } else {
+      finalFilePath = desiredFilePath;
+    }
+  }
+
   await space.writeDocument(finalFilePath, file.content);
 
   if (await editor.getCurrentEditor() === "page") {