@saltcorn/server 1.6.0-alpha.0 → 1.6.0-alpha.10

package/routes/files.js

@@ -8,6 +8,7 @@
 const Router = require("express-promise-router");
 const File = require("@saltcorn/data/models/file");
 const User = require("@saltcorn/data/models/user");
+const Form = require("@saltcorn/data/models/form");
 const { getState } = require("@saltcorn/data/db/state");
 const s3storage = require("../s3storage");
 const resizer = require("resize-with-sharp-or-jimp");
@@ -854,3 +855,193 @@ router.post(
     }
   })
 );
+
+const editableExtensions = [
+  "html",
+  "css",
+  "js",
+  "jsx",
+  "ts",
+  "tsx",
+  "sql",
+  "py",
+  "bash",
+  "sh",
+  "txt",
+  "json",
+  "md",
+  "yml",
+];
+
+/**
+ * GET load the file editor
+ */
+router.get(
+  "/edit/*serve_path",
+  error_catcher(async (req, res) => {
+    const role = req.user && req.user.id ? req.user.role_id : 100;
+    const user_id = req.user && req.user.id;
+    const serve_path = path.join(...req.params.serve_path);
+    const file = await File.findOne(serve_path);
+    if (
+      file &&
+      (role <= file.min_role_read || (user_id && user_id === file.user_id))
+    ) {
+      try {
+        if (file.isDirectory) {
+          res
+            .status(400)
+            .sendWrap(
+              req.__("Error"),
+              h1(req.__("File not editable")) +
+                div(req.__("Directories cannot be edited"))
+            );
+          return;
+        }
+        const ext = path.extname(file.filename).toLowerCase().slice(1);
+        if (!editableExtensions.includes(ext)) {
+          res
+            .status(400)
+            .sendWrap(
+              req.__("Error"),
+              h1(req.__("File not editable")) +
+                div(req.__("Files of this type cannot be edited"))
+            );
+          return;
+        }
+        const fileContent = await fs.promises.readFile(file.location, "utf8");
+        const form = new Form({
+          action: `/files/edit/${encodeURIComponent(serve_path)}`,
+          onChange: "saveAndContinue(this)",
+          submitLabel: req.__("Done"),
+          noSubmitButton: true,
+          noLabelCols: true,
+          fields: [
+            {
+              name: "value",
+              label: " ",
+              input_type: "code",
+              class: ["validate-statements", "enlarge-in-card"],
+              attributes: {
+                mode: `${file.mime_super}/${file.mime_sub}`,
+              },
+            },
+          ],
+          additionalButtons: [
+            {
+              label: req.__("Save"),
+              id: "btnSaveId",
+              class: "btn btn-primary",
+              type: "submit",
+            },
+            {
+              label: req.__("Close"),
+              class: "btn btn-secondary ms-2",
+              onclick: `location.href='/files?dir=${encodeURIComponent(
+                file.current_folder
+              )}'`,
+            },
+          ],
+        });
+
+        form.values = { value: fileContent };
+        res.sendWrap(req.__("Edit file"), {
+          above: [
+            {
+              type: "breadcrumbs",
+              crumbs: [
+                { text: req.__("Settings"), href: "/settings" },
+                { text: req.__("Files"), href: "/files" },
+                { text: req.__("Edit"), href: null },
+              ],
+            },
+            {
+              title: req.__("Editing %s", file.filename),
+              type: "card",
+              contents: renderForm(form, req.csrfToken()),
+            },
+          ],
+        });
+      } catch (err) {
+        getState().log(3, `Error reading file ${serve_path}: ${err.message}`);
+        res
+          .status(500)
+          .sendWrap(
+            req.__("Error"),
+            h1(req.__("Error reading file")) + div(err.message)
+          );
+      }
+    } else {
+      res
+        .status(404)
+        .sendWrap(req.__("Not found"), h1(req.__("File not found")));
+    }
+  })
+);
+
+/**
+ * POST edit a file from the editor
+ */
+router.post(
+  "/edit/*serve_path",
+  error_catcher(async (req, res) => {
+    const role = req.user && req.user.id ? req.user.role_id : 100;
+    const user_id = req.user && req.user.id;
+    const serve_path = path.join(...req.params.serve_path);
+    const file = await File.findOne(serve_path);
+    if (
+      file &&
+      (role <= file.min_role_read || (user_id && user_id === file.user_id))
+    ) {
+      try {
+        if (file.isDirectory) {
+          if (req.xhr) res.json({ error: "Directories cannot be edited" });
+          else
+            res
+              .status(400)
+              .sendWrap(
+                req.__("Error"),
+                h1(req.__("File not editable")) +
+                  div(req.__("Directories cannot be edited"))
+              );
+
+          return;
+        }
+        const ext = path.extname(file.filename).toLowerCase().slice(1);
+        if (!editableExtensions.includes(ext)) {
+          if (req.xhr)
+            res.json({ error: "Files of this type cannot be edited" });
+          else
+            res
+              .status(400)
+              .sendWrap(
+                req.__("Error"),
+                h1(req.__("File not editable")) +
+                  div(req.__("Files of this type cannot be edited"))
+              );
+          return;
+        }
+        const newContent = req.body.value;
+        await fs.promises.writeFile(file.location, newContent, "utf8");
+        if (req.xhr) res.json({ success: true });
+        else {
+          const currentFolder = file.current_folder;
+          res.redirect(`/files${currentFolder ? `?dir=${currentFolder}` : ""}`);
+        }
+      } catch (err) {
+        getState().log(3, `Error writing file ${serve_path}: ${err.message}`);
+        if (req.xhr) res.json({ error: err.message });
+        else {
+          req.flash("error", err.message);
+          res.redirect(`/files/edit/${encodeURIComponent(serve_path)}`);
+        }
+      }
+    } else {
+      if (req.xhr) res.status(404).json({ error: "File not found" });
+      else {
+        req.flash("error", req.__("File not found"));
+        res.redirect("/files");
+      }
+    }
+  })
+);

package/routes/menu.js

@@ -391,7 +391,9 @@ const menuForm = async (req) => {
         label: req.__("Show if"),
         class: "item-menu validate-expression",
         type: "String",
-        sublabel: req.__("Optional expression. Show only if true. In scope: <code>user</code>, <code>url</code>, <code>query</code>")
+        sublabel: req.__(
+          "Optional expression. Show only if true. In scope: <code>user</code>, <code>url</code>, <code>query</code>"
+        ),
       },
       {
         name: "disable_on_mobile",
@@ -484,6 +486,29 @@ const menuForm = async (req) => {
           ],
         },
       },
+      {
+        name: "shortcut",
+        label: req.__("Keyboard shortcut"),
+        sublabel: req.__(
+          "e.g. <code>Alt+k</code> or <code>Ctrl+Alt+k</code> or <code>Ctrl+Space</code>. Modifier keys: <code>Alt</code>, <code>Ctrl</code>, <code>Shift</code>, <code>Meta</code>"
+        ),
+        class: "item-menu",
+        input_type: "text",
+        required: false,
+        help: { topic: "Menu item shortcuts"},
+        showIf: {
+          type: [
+            "View",
+            "Page",
+            "Page Group",
+            "Link",
+            "Action",
+            "Admin Page",
+            "User Page",
+            "Search",
+          ],
+        },
+      },
       {
         name: "location",
         label: req.__("Location"),
@@ -576,6 +601,81 @@ const menuEditorScript = (menu_items) => `
   });
   lastState=editor.getString()
   setInterval(ajax_save_menu, 500)
+
+  // Keyboard shortcut validation
+  const modifierKeys = new Set(["alt", "ctrl", "shift", "meta"]);
+  const validKeys = new Set([
+    "a","b","c","d","e","f","g","h","i","j","k","l","m",
+    "n","o","p","q","r","s","t","u","v","w","x","y","z",
+    "0","1","2","3","4","5","6","7","8","9",
+    "f1","f2","f3","f4","f5","f6","f7","f8","f9","f10","f11","f12",
+    "enter","tab","escape","backspace","delete","insert",
+    "arrowup","arrowdown","arrowleft","arrowright",
+    "space","-",",","."
+  ]);
+  const reservedShortcuts = [
+    "Ctrl+c", "Ctrl+v", "Ctrl+x", "Ctrl+z", "Ctrl+y", "Ctrl+a",
+    "Ctrl+s", "Ctrl+p", "Ctrl+t", "Ctrl+w", "Ctrl+n", "Ctrl+f",
+    "Ctrl+h", "Ctrl+l", "Ctrl+d", "Ctrl+r", "Ctrl+o", "Ctrl+g",
+    "Ctrl+j", "Ctrl+k", "Ctrl+u", "Ctrl+e", "Ctrl+Shift+p",
+    "Ctrl+Tab", "Shift+Escape", "Alt+Space",
+    "Ctrl+Shift+i", "Ctrl+Shift+j", "Ctrl+Shift+c", "Ctrl+Shift+t",
+    "Ctrl+Shift+n", "Ctrl+Shift+Delete",
+    "F1", "F3", "F5", "F7", "F11", "F12"
+  ];
+  const normalizeShortcut = (s) => {
+    return s.split("+").map(function(p) { return p.trim().toLowerCase(); }).join("+");
+  };
+  const reservedSet = new Set(reservedShortcuts.map(normalizeShortcut));
+
+  function validateShortcut(val) {
+    if (!val) return null;
+    const parts = val.split("+").map((p) => { return p.trim(); });
+    if (parts.length === 0 || parts.some(function(p) { return p === ""; })) {
+      return "Invalid format. Use Modifier+Key, e.g. Alt+k";
+    }
+    const mods = [];
+    let key = null;
+    for (var i = 0; i < parts.length; i++) {
+      const p = parts[i];
+      const pLower = p.toLowerCase();
+      if (modifierKeys.has(pLower)) {
+        if (mods.indexOf(pLower) >= 0) return "Duplicate modifier: " + p;
+        mods.push(pLower);
+      } else if (key !== null) {
+        return "Only one non-modifier key allowed, got: " + key + " and " + p;
+      } else {
+        key = p;
+      }
+    }
+    if (key === null) return "A non-modifier key is required";
+    if (mods.length === 0) {
+      if (validKeys.has(key.toLowerCase()) && key.length === 1)
+        return "Single character keys require at least one modifier (Alt, Ctrl, Shift, or Meta)";
+    }
+    if (!validKeys.has(key.toLowerCase()))
+      return "Unknown key: " + key + ". Use a letter (a-z), digit (0-9), F1-F12, or a named key like Enter, Escape, etc.";
+    return null;
+  }
+
+  var $shortcutInput = $('input[name="shortcut"]');
+  var $shortcutMsg = $('<div class="small mt-1" style="display:none"></div>');
+  $shortcutInput.after($shortcutMsg);
+  $shortcutInput.on('input', function() {
+    var val = $(this).val().trim();
+    if (!val) { $shortcutMsg.hide(); return; }
+    var error = validateShortcut(val);
+    if (error) {
+      $shortcutMsg.removeClass('text-warning').addClass('text-danger').text(error).show();
+      return;
+    }
+    var norm = normalizeShortcut(val);
+    if (reservedSet.has(norm)) {
+      $shortcutMsg.removeClass('text-danger').addClass('text-warning').text('Warning: this shortcut conflicts with a common browser shortcut and may not work.').show();
+    } else {
+      $shortcutMsg.hide();
+    }
+  });
   `;
 
 /**

package/routes/notifications.js

@@ -355,7 +355,7 @@ router.post(
   "/mobile-subscribe",
   loggedIn,
   error_catcher(async (req, res) => {
-    const { token, deviceId, synchedTables } = req.body || {};
+    const { token, deviceId, platform } = req.body || {};
     if (!token) {
       res.status(400).json({
         error: req.__("FCM token is required"),
@@ -375,11 +375,14 @@ router.post(
         message: req.__("FCM token already uploaded"),
       });
     } else {
+      // web based subscriptions and other device subscriptions for this user
       userSubs = userSubs.filter(
-        (s) => s.type !== "fcm-push" || s.deviceId !== deviceId
+        (s) =>
+          (s.type !== "fcm-push" && s.type !== "apns-push") ||
+          s.deviceId !== deviceId
       );
       userSubs.push({
-        type: "fcm-push",
+        type: platform === "android" ? "fcm-push" : "apns-push",
         token: token,
         deviceId: deviceId,
       });
@@ -432,18 +435,6 @@ router.post(
   })
 );
 
-// TODO
-router.post(
-  "/mobile-remove-subscription",
-  loggedIn,
-  error_catcher(async (req, res) => {
-    res.json({
-      success: "ok",
-      message: req.__("Unsubscribed from notifications"),
-    });
-  })
-);
-
 router.post(
   "/mobile-remove-subscription",
   loggedIn,
@@ -533,9 +524,7 @@ router.get(
     }
     if (Array.isArray(pwa_icons) && pwa_icons.length > 0)
       manifest.icons = pwa_icons.map(({ image, size, maskable }) => ({
-        src: /^(?:[a-z]+:)?\/\//i.test(image)
-          ? image
-          : `/files/serve/${image}`,
+        src: /^(?:[a-z]+:)?\/\//i.test(image) ? image : `/files/serve/${image}`,
         type: File.nameToMimeType(image),
         sizes: size ? `${size}x${size}` : "144x144",
         ...(maskable ? { purpose: "maskable" } : {}),

package/routes/packs.js

@@ -5,7 +5,12 @@
  */
 
 const Router = require("express-promise-router");
-const { isAdmin, error_catcher, setTenant } = require("./utils.js");
+const {
+  isAdmin,
+  error_catcher,
+  setTenant,
+  is_relative_url,
+} = require("./utils.js");
 const { renderForm } = require("@saltcorn/markup");
 const Table = require("@saltcorn/data/models/table");
 const Form = require("@saltcorn/data/models/form");
@@ -20,8 +25,8 @@ const ModelInstance = require("@saltcorn/data/models/model_instance");
 const load_plugins = require("../load_plugins");
 const { getState } = require("@saltcorn/data/db/state");
 const db = require("@saltcorn/data/db/index");
+const { instanceOfPack } = require("@saltcorn/types/base_types");
 
-const { is_pack } = require("@saltcorn/data/contracts");
 const {
   table_pack,
   view_pack,
@@ -56,6 +61,16 @@ const fs = require("fs");
 const router = new Router();
 module.exports = router;
 
+const getOnDoneRedirect = (req, fallback = "/plugins") => {
+  if (
+    req.query.on_done_redirect &&
+    is_relative_url("/" + req.query.on_done_redirect)
+  ) {
+    return `/${req.query.on_done_redirect}`;
+  }
+  return fallback;
+};
+
 /**
  * @name get
  * @function
@@ -413,7 +428,7 @@ router.post(
     } catch (e) {
       error = e.message;
     }
-    if (!error && !is_pack.check(pack)) {
+    if (!error && !instanceOfPack(pack)) {
       error = req.__("Not a valid pack");
     }
 
@@ -473,14 +488,14 @@ router.post(
     const pack = await fetch_pack_by_name(name);
     if (!pack) {
       req.flash("error", req.__(`Pack %s not found`, text(name)));
-      res.redirect(`/plugins`);
+      res.redirect(getOnDoneRedirect(req, "/plugins"));
       return;
     }
     const can_install = await can_install_pack(pack.pack);
 
     if (can_install.error) {
       req.flash("error", can_install.error);
-      res.redirect(`/plugins`);
+      res.redirect(getOnDoneRedirect(req, "/plugins"));
       return;
     } else if (can_install.warning) {
       req.flash("warning", can_install.warning);
@@ -492,7 +507,7 @@ router.post(
     });
     await getState().refresh();
     req.flash("success", req.__(`Pack %s installed`, text(name)));
-    res.redirect(`/`);
+    res.redirect(getOnDoneRedirect(req, "/"));
   })
 );
 
@@ -511,7 +526,7 @@ router.post(
     const pack = await fetch_pack_by_name(name);
     if (!pack) {
       req.flash("error", req.__(`Pack %s not found`, text(name)));
-      res.redirect(`/plugins`);
+      res.redirect(getOnDoneRedirect(req, "/plugins"));
       return;
     }
     await db.withTransaction(async () => {
@@ -521,6 +536,6 @@ router.post(
 
     req.flash("success", req.__(`Pack %s uninstalled`, text(name)));
 
-    res.redirect(`/`);
+    res.redirect(getOnDoneRedirect(req, "/"));
   })
 );

package/routes/page.js

@@ -73,7 +73,10 @@ const runPage = async (page, req, res, tic) => {
       );
     }
     if (contents.html_file) await sendHtmlFile(req, res, contents.html_file);
-    else
+    else if (contents.html_string) {
+      res.set("Content-Type", "text/html");
+      await res.send(contents.html_string);
+    } else
       res.sendWrap(
         {
           title,

package/routes/pageedit.js

@@ -202,6 +202,20 @@ const pageBuilderData = async (req, context) => {
       });
     }
   }
+  const workflowActions = Trigger.trigger_actions({
+    apiNeverTriggers: true,
+    onlyWorkflows: true,
+  });
+  for (const name of workflowActions) {
+    actionConfigForms[name] = [
+      {
+        name: "initial_context",
+        label: "Initial context",
+        type: "String",
+        class: "validate-expression",
+      },
+    ];
+  }
   const actionsNotRequiringRow = Trigger.action_options({
     notRequireRow: true,
     apiNeverTriggers: true,
@@ -251,6 +265,8 @@ const pageBuilderData = async (req, context) => {
   //console.log(fixed_state_fields.ListTasks);
   const icons = getState().icons;
   return {
+    translations:
+      req.getLocale() === "en" ? {} : req.getCatalog(req.getLocale()) || {},
     views: views.map((v) => v.select_option),
     images,
     pages,

package/routes/plugins.js

@@ -6,7 +6,13 @@
  */
 
 const Router = require("express-promise-router");
-const { isAdmin, loggedIn, error_catcher } = require("./utils.js");
+const {
+  isAdmin,
+  loggedIn,
+  error_catcher,
+  addOnDoneRedirect,
+  is_relative_url,
+} = require("./utils.js");
 const { renderForm, link, post_btn } = require("@saltcorn/markup");
 const {
   getState,
@@ -70,6 +76,16 @@ const {
   isVersionSupported,
 } = require("@saltcorn/plugins-loader/stable_versioning");
 
+const getOnDoneRedirect = (req, fallback = "/plugins") => {
+  if (
+    req.query.on_done_redirect &&
+    is_relative_url("/" + req.query.on_done_redirect)
+  ) {
+    return `/${req.query.on_done_redirect}`;
+  }
+  return fallback;
+};
+
 /**
  * @type {object}
  * @const
@@ -572,6 +588,7 @@ const plugin_store_html = (items, req) => {
             search_bar("q", req.query.q || "", {
               placeHolder: req.__("Search for..."),
               stateField: "q",
+              autofocus: true,
             })
           ),
           div(store_actions_dropdown(req))
@@ -790,7 +807,7 @@ router.get(
     const plugin = await Plugin.findOne({ name: decodeURIComponent(name) });
     if (!plugin) {
       req.flash("warning", req.__("Module not found"));
-      res.redirect("/plugins");
+      res.redirect(getOnDoneRedirect(req));
       return;
     }
     let module = getState().plugins[plugin.name];
@@ -799,9 +816,15 @@ router.get(
     }
     const flow = module.configuration_workflow();
     flow.modifyForm = remove_fixed_fields(name);
-    flow.action = `/plugins/configure/${encodeURIComponent(plugin.name)}`;
+    const configurePath = `/plugins/configure/${encodeURIComponent(
+      plugin.name
+    )}`;
+    flow.action = addOnDoneRedirect(configurePath, req);
     flow.autoSave = true;
-    flow.saveURL = `/plugins/saveconfig/${encodeURIComponent(plugin.name)}`;
+    flow.saveURL = addOnDoneRedirect(
+      `/plugins/saveconfig/${encodeURIComponent(plugin.name)}`,
+      req
+    );
     const wfres = await flow.run(plugin.configuration || {});
 
     if (module.layout) {
@@ -871,9 +894,15 @@ router.post(
     const flow = module.configuration_workflow();
     flow.modifyForm = remove_fixed_fields(name);
 
-    flow.action = `/plugins/configure/${encodeURIComponent(plugin.name)}`;
+    const configurePath = `/plugins/configure/${encodeURIComponent(
+      plugin.name
+    )}`;
+    flow.action = addOnDoneRedirect(configurePath, req);
     flow.autoSave = true;
-    flow.saveURL = `/plugins/saveconfig/${encodeURIComponent(plugin.name)}`;
+    flow.saveURL = addOnDoneRedirect(
+      `/plugins/saveconfig/${encodeURIComponent(plugin.name)}`,
+      req
+    );
     const wfres = await flow.run(req.body || {});
     if (wfres.renderForm) {
       if (module.layout) {
@@ -912,7 +941,7 @@ router.post(
       });
       if (module.layout) await sleep(500); // Allow other workers to reload this plugin
       if (wfres.cleanup) await wfres.cleanup();
-      res.redirect("/plugins");
+      res.redirect(getOnDoneRedirect(req));
     }
   })
 );
@@ -1534,7 +1563,7 @@ router.post(
     const plugin = await Plugin.findOne({ name: decodeURIComponent(name) });
     if (!plugin) {
       req.flash("warning", req.__("Module not found"));
-      res.redirect("/plugins");
+      res.redirect(getOnDoneRedirect(req));
       return;
     }
     const depviews = await plugin.dependant_views();
@@ -1551,7 +1580,7 @@ router.post(
         req.__(`Cannot remove module: views %s depend on it`, depviews.join())
       );
     }
-    res.redirect(`/plugins`);
+    res.redirect(getOnDoneRedirect(req));
   })
 );
 
@@ -1590,7 +1619,7 @@ router.post(
         "error",
         req.__(`Module %s not found`, text(decodeURIComponent(name)))
       );
-      res.redirect(`/plugins`);
+      res.redirect(getOnDoneRedirect(req));
       return;
     }
     let forceReInstall =
@@ -1604,7 +1633,7 @@ router.post(
         "error",
         req.__("Cannot install unsafe modules on subdomain tenants")
       );
-      res.redirect(`/plugins`);
+      res.redirect(getOnDoneRedirect(req));
       return;
     }
 
@@ -1622,7 +1651,7 @@ router.post(
         "error",
         e.message || req.__("Error installing module %s", plugin.name)
       );
-      res.redirect(`/plugins`);
+      res.redirect(getOnDoneRedirect(req));
       return;
     }
     const plugin_module = getState().plugins[name];
@@ -1639,11 +1668,14 @@ router.post(
         )
       );
       if (msgs?.length > 0) req.flash("warning", msgs.join("<br>"));
-      res.redirect(`/plugins/configure/${plugin_db.name}`);
+      const configurePath = `/plugins/configure/${encodeURIComponent(
+        plugin_db.name
+      )}`;
+      res.redirect(addOnDoneRedirect(configurePath, req));
     } else {
       req.flash("success", req.__(`Module %s installed`, plugin.name));
       if (msgs?.length > 0) req.flash("warning", msgs.join("<br>"));
-      res.redirect(`/plugins`);
+      res.redirect(getOnDoneRedirect(req));
     }
   })
 );

package/routes/registry.js

@@ -276,6 +276,7 @@ router.get(
                     placeholder: "Search",
                     name: "q",
                     value: q,
+                    autofocus: true,
                     "aria-label": "Search",
                     "aria-describedby": "button-search-submit",
                   }),