Merge pull request #384 from gjsjohnmurray/isfs-folder-settings-experiment

Support server-side (isfs) folder settings, snippets, debug configs etc

Author: gjsjohnmurray

src/api/index.ts

@@ -500,4 +500,12 @@ export class AtelierAPI {
     };
     return this.request(1, "GET", `%SYS/jobs`, null, params);
   }
+
+  // v1+
+  public getCSPApps(detail = false): Promise<Atelier.Response> {
+    const params = {
+      detail: detail ? 1 : 0,
+    };
+    return this.request(1, "GET", `%SYS/cspapps/${this.ns || ""}`, null, params);
+  }
 }

src/commands/compile.ts

@@ -251,18 +251,22 @@ export async function importAndCompile(askFlags = false, document?: vscode.TextD
       // console.error(error);
       throw error;
     })
-    .then(() => compile([file], flags));
+    .then(() => {
+      if (!file.fileName.startsWith("\\.vscode\\")) {
+        compile([file], flags);
+      }
+    });
 }
 
 // Compiles all files types in the namespace
-export async function namespaceCompile(askFLags = false): Promise<any> {
+export async function namespaceCompile(askFlags = false): Promise<any> {
   const api = new AtelierAPI();
   const fileTypes = ["*.CLS", "*.MAC", "*.INC", "*.BAS"];
   if (!config("conn").active) {
     throw new Error(`No Active Connection`);
   }
   const defaultFlags = config().compileFlags;
-  const flags = askFLags ? await compileFlags() : defaultFlags;
+  const flags = askFlags ? await compileFlags() : defaultFlags;
   if (flags === undefined) {
     // User cancelled
     return;

src/providers/FileSystemPovider/FileSystemProvider.ts

@@ -6,6 +6,7 @@ import { Directory } from "./Directory";
 import { File } from "./File";
 import { fireOtherStudioAction, OtherStudioAction } from "../../commands/studio";
 import { StudioOpenDialog } from "../../queries";
+import { redirectDotvscodeRoot } from "../../utils/index";
 
 declare function setTimeout(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timeout;
 
@@ -61,29 +62,63 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
     } else {
       filter = "*.cls,*.inc,*.mac,*.int";
     }
-    const folder = csp ? (uri.path.endsWith("/") ? uri.path : uri.path + "/") : uri.path.replace(/\//g, ".");
+    const folder = !csp
+      ? uri.path.replace(/\//g, ".")
+      : uri.path === "/"
+      ? ""
+      : uri.path.endsWith("/")
+      ? uri.path
+      : uri.path + "/";
     const spec = csp ? folder + filter : folder.length > 1 ? folder.slice(1) + "/" + filter : filter;
     const dir = "1";
     const orderBy = "1";
     const system = api.ns === "%SYS" ? "1" : "0";
     const flat = query.flat && query.flat.length ? query.flat.toString() : "0";
     const notStudio = "0";
     const generated = query.generated && query.generated.length ? query.generated.toString() : "0";
+    // get all web apps that have a filepath (Studio dialog used below returns REST ones too)
+    const cspApps = csp ? await api.getCSPApps().then((data) => data.result.content || []) : [];
+    const cspSubfolderMap = new Map<string, vscode.FileType>();
+    const prefix = folder === "" ? "/" : folder;
+    for (const app of cspApps) {
+      if ((app + "/").startsWith(prefix)) {
+        const subfolder = app.slice(prefix.length).split("/")[0];
+        if (subfolder) {
+          cspSubfolderMap.set(subfolder, vscode.FileType.Directory);
+        }
+      }
+    }
+    const cspSubfolders = Array.from(cspSubfolderMap.entries());
+    // Assemble the results
     return api
       .actionQuery(sql, [spec, dir, orderBy, system, flat, notStudio, generated])
       .then((data) => data.result.content || [])
-      .then((data) =>
-        data.map((item: StudioOpenDialog) => {
-          const name = item.Name;
-          const fullName = folder === "" ? name : folder + "/" + name;
-          if (item.Type === "10" || item.Type === "9") {
-            parent.entries.set(name, new Directory(name, fullName));
-            return [name, vscode.FileType.Directory];
-          } else {
-            return [name, vscode.FileType.File];
-          }
-        })
-      )
+      .then((data) => {
+        const results = data
+          .filter((item: StudioOpenDialog) =>
+            item.Type === "10"
+              ? csp && !item.Name.includes("/") // ignore web apps here because there may be REST ones
+              : item.Type === "9" // class package
+              ? !csp
+              : csp
+              ? item.Type === "5" // web app file
+              : true
+          )
+          .map((item: StudioOpenDialog) => {
+            const name = item.Name;
+            const fullName = folder === "" ? name : csp ? folder + name : folder + "/" + name;
+            if (item.Type === "10" || item.Type === "9") {
+              parent.entries.set(name, new Directory(name, fullName));
+              return [name, vscode.FileType.Directory];
+            } else {
+              return [name, vscode.FileType.File];
+            }
+          });
+        if (!csp) {
+          return results;
+        }
+        return results.concat(cspSubfolders);
+      })
       .catch((error) => {
         error && console.error(error);
       });
@@ -138,7 +173,8 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
       overwrite: boolean;
     }
   ): void | Thenable<void> {
-    if (uri.path.match(/\/\.[^/]*\//)) {
+    uri = redirectDotvscodeRoot(uri);
+    if (uri.path.startsWith("/.")) {
       throw vscode.FileSystemError.NoPermissions("dot-folders not supported by server");
     }
     const { query } = url.parse(decodeURIComponent(uri.toString()), true);
@@ -235,14 +271,17 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
   private async _lookup(uri: vscode.Uri): Promise<Entry> {
     const parts = uri.path.split("/");
     let entry: Entry = this.root;
-    for (const part of parts) {
+    for (let i = 0; i < parts.length; i++) {
+      const part = parts[i];
       if (!part) {
         continue;
       }
       let child: Entry | undefined;
       if (entry instanceof Directory) {
         child = entry.entries.get(part);
-        if (!part.includes(".")) {
+        // If the last element of path is dotted and is one we haven't already cached as a directory
+        // then it is assumed to be a file.
+        if (!part.includes(".") || i + 1 < parts.length) {
           const fullName = entry.name === "" ? part : entry.fullName + "/" + part;
           child = new Directory(part, fullName);
           entry.entries.set(part, child);
@@ -274,10 +313,11 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
 
   // Fetch from server and cache it
   private async _lookupAsFile(uri: vscode.Uri): Promise<File> {
-    // Reject attempts to access files in .-folders such as .vscode and .git
-    if (uri.path.match(/\/\.[^/]*\//)) {
-      throw vscode.FileSystemError.FileNotFound("dot-folders not supported by server");
+    uri = redirectDotvscodeRoot(uri);
+    if (uri.path.startsWith("/.")) {
+      throw vscode.FileSystemError.NoPermissions("dot-folders not supported by server");
     }
+
     const { query } = url.parse(decodeURIComponent(uri.toString()), true);
     const csp = query.csp === "" || query.csp === "1";
     const fileName = csp ? uri.path : uri.path.slice(1).replace(/\//g, ".");

src/utils/index.ts

@@ -72,19 +72,19 @@ export function currentFile(document?: vscode.TextDocument): CurrentFile {
       !document.fileName ||
       !document.languageId ||
       !document.languageId.startsWith("objectscript") ||
-      fileExt.match(/(csp)/i)) // Skip CSP for now, yet
+      fileExt.match(/(csp)/i)) // Skip local CSPs for now
   ) {
     return null;
   }
   const eol = document.eol || vscode.EndOfLine.LF;
-  const uri = document.uri;
+  const uri = redirectDotvscodeRoot(document.uri);
   const content = document.getText();
   let name = "";
   let ext = "";
   const { query } = url.parse(decodeURIComponent(uri.toString()), true);
   const csp = query.csp === "" || query.csp === "1";
   if (csp) {
-    name = fileName.replace("\\", "/");
+    name = uri.path;
   } else if (fileExt === "cls") {
     const match = content.match(/^Class (%?\w+(?:\.\w+)+)/im);
     if (match) {
@@ -333,3 +333,30 @@ export async function terminalWithDocker(): Promise<vscode.Terminal> {
   terminal.show(true);
   return terminal;
 }
+
+/**
+ * Alter isfs-type uri.path of /.vscode/* files or subdirectories.
+ * Rewrite `/.vscode/path/to/file` as `/_vscode/XYZ/path/to/file`
+ *  where XYZ comes from the `ns` queryparam of uri.
+ * Also alter query to specify `ns=%SYS&csp=1`
+ *
+ * @returns uri, altered if necessary.
+ * @throws if `ns` queryparam is missing but required.
+ */
+export function redirectDotvscodeRoot(uri: vscode.Uri): vscode.Uri {
+  if (!schemas.includes(uri.scheme)) {
+    return uri;
+  }
+  const dotMatch = uri.path.match(/^\/(\.[^/]*)\/(.*)$/);
+  if (dotMatch && dotMatch[1] === ".vscode") {
+    const nsMatch = `&${uri.query}&`.match(/&ns=(.+)&/);
+    if (!nsMatch) {
+      throw new Error("No 'ns' query parameter on uri");
+    }
+    const namespace = nsMatch[1];
+    const newQueryString = (("&" + uri.query).replace(`ns=${namespace}`, "ns=%SYS") + "&csp=1").slice(1);
+    return uri.with({ path: `/_vscode/${namespace}/${dotMatch[2]}`, query: newQueryString });
+  } else {
+    return uri;
+  }
+}