@saltcorn/server 0.8.5-beta.3 → 0.8.5-beta.5

package/routes/list.js

@@ -241,13 +241,16 @@ router.get(
     for (const f of fields) {
       if (f.type === "File") f.attributes = { select_file_where: {} };
       await f.fill_fkey_options();
+
+      if (f.type === "File") {
+        //add existing values in folders
+        const dvs = await f.distinct_values();
+        dvs.forEach((dv) => {
+          if (dv?.value?.includes("/")) f.options.push(dv);
+        });
+      }
     }
 
-    //console.log(fields);
-    // todo remove keyfields - unused
-    const keyfields = fields
-      .filter((f) => f.type === "Key" || f.type === "File")
-      .map((f) => ({ name: f.name, type: f.reftype }));
     const jsfields = arrangeIdFirst(fields).map((f) =>
       typeToGridType(f.type, f)
     );

package/routes/notifications.js

@@ -0,0 +1,136 @@
+/**
+ * @category server
+ * @module routes/notifications
+ * @subcategory routes
+ */
+
+const Router = require("express-promise-router");
+const { isAdmin, setTenant, error_catcher, loggedIn } = require("./utils.js");
+const Notification = require("@saltcorn/data/models/notification");
+const { div, a, i, text, h5, p, span } = require("@saltcorn/markup/tags");
+const moment = require("moment");
+const { getState } = require("@saltcorn/data/db/state");
+const Form = require("@saltcorn/data/models/form");
+const User = require("@saltcorn/data/models/user");
+const { renderForm } = require("@saltcorn/markup");
+
+const router = new Router();
+module.exports = router;
+
+const notificationSettingsForm = () =>
+  new Form({
+    action: `/notifications/settings`,
+    noSubmitButton: true,
+    onChange: `saveAndContinue(this)`,
+    labelCols: 4,
+    fields: [{ name: "notify_email", label: "Email", type: "Bool" }],
+  });
+
+router.get(
+  "/",
+  loggedIn,
+  error_catcher(async (req, res) => {
+    const nots = await Notification.find(
+      { user_id: req.user.id },
+      { orderBy: "id", orderDesc: true, limit: 20 }
+    );
+    await Notification.mark_as_read({
+      id: { in: nots.filter((n) => !n.read).map((n) => n.id) },
+    });
+    const notifyCards = nots.length
+      ? nots.map((not) => ({
+          type: "card",
+          class: [!not.read && "unread-notify"],
+          contents: [
+            div(
+              { class: "d-flex" },
+              span({ class: "fw-bold" }, not.title),
+              span({ class: "ms-2 text-muted" }, moment(not.created).fromNow())
+            ),
+            not.body && p(not.body),
+            not.link && a({ href: not.link }, "Link"),
+          ],
+        }))
+      : [
+          {
+            type: "card",
+            contents: [h5(req.__("No notifications"))],
+          },
+        ];
+    res.sendWrap(req.__("Notifications"), {
+      above: [
+        {
+          type: "breadcrumbs",
+          crumbs: [{ text: req.__("Notifications") }],
+        },
+        {
+          widths: [4, 8],
+          breakpoint: "md",
+          besides: [
+            {
+              type: "card",
+              contents: [
+                "Receive notifications by:",
+                renderForm(notificationSettingsForm(), req.csrfToken()),
+              ],
+            },
+            { above: notifyCards },
+          ],
+        },
+      ],
+    });
+  })
+);
+
+router.get(
+  "/count-unread",
+  loggedIn,
+  error_catcher(async (req, res) => {
+    const num_unread = await Notification.count({
+      user_id: req.user.id,
+      read: false,
+    });
+    res.set("Cache-Control", "public, max-age=60"); // 1 minute
+    res.json({ success: num_unread });
+  })
+);
+
+router.post(
+  "/settings",
+  loggedIn,
+  error_catcher(async (req, res) => {
+    const user = await User.findOne({ id: req.user.id });
+    const form = notificationSettingsForm();
+    form.validate(req.body);
+    const _attributes = { ...user._attributes, ...form.values };
+    await user.update({ _attributes });
+    res.json({ success: "ok" });
+  })
+);
+
+router.get(
+  "/manifest.json",
+  error_catcher(async (req, res) => {
+    const state = getState();
+    const manifest = {
+      name: state.getConfig("site_name"),
+      start_url: state.getConfig("base_url") || "/",
+      display: state.getConfig("pwa_display", "browser"),
+    };
+    const site_logo = state.getConfig("site_logo_id");
+    if (site_logo)
+      manifest.icons = [
+        {
+          src: `/files/serve/${site_logo}`,
+        },
+      ];
+    if (state.getConfig("pwa_set_colors", false)) {
+      manifest.theme_color = state.getConfig("pwa_theme_color", "black");
+      manifest.background_color = state.getConfig(
+        "pwa_background_color",
+        "red"
+      );
+    }
+    res.json(manifest);
+  })
+);

package/routes/plugins.js

@@ -14,11 +14,18 @@ const {
   post_btn,
   post_delete_btn,
 } = require("@saltcorn/markup");
-const { getState, restart_tenant } = require("@saltcorn/data/db/state");
+const {
+  getState,
+  restart_tenant,
+  getRootState,
+} = require("@saltcorn/data/db/state");
 const Form = require("@saltcorn/data/models/form");
 const Field = require("@saltcorn/data/models/field");
 const Plugin = require("@saltcorn/data/models/plugin");
 const { fetch_available_packs } = require("@saltcorn/admin-models/models/pack");
+const {
+  upgrade_all_tenants_plugins,
+} = require("@saltcorn/admin-models/models/tenant");
 const { getConfig, setConfig } = require("@saltcorn/data/models/config");
 const db = require("@saltcorn/data/db");
 const {
@@ -150,7 +157,10 @@ const local_has_theme = (name) => {
 const get_store_items = async () => {
   const installed_plugins = await Plugin.find({});
   const isRoot = db.getTenantSchema() === db.connectObj.default_schema;
-
+  const tenants_unsafe_plugins = getRootState().getConfig(
+    "tenants_unsafe_plugins",
+    false
+  );
   const instore = await Plugin.store_plugins_available();
   const packs_available = await fetch_available_packs();
   const packs_installed = getState().getConfig("installed_packs", []);
@@ -168,7 +178,7 @@ const get_store_items = async () => {
       has_auth: plugin.has_auth,
       unsafe: plugin.unsafe,
     }))
-    .filter((p) => !p.unsafe || isRoot);
+    .filter((p) => !p.unsafe || isRoot || tenants_unsafe_plugins);
   const local_logins = installed_plugins
     .filter((p) => !store_plugin_names.includes(p.name) && p.name !== "base")
     .map((plugin) => ({
@@ -424,8 +434,12 @@ const filter_items_set = (items, query) => {
  * @param {object} req
  * @returns {div}
  */
-const store_actions_dropdown = (req) =>
-  div(
+const store_actions_dropdown = (req) => {
+  const tenants_install_git = getRootState().getConfig(
+    "tenants_install_git",
+    false
+  );
+  return div(
     { class: "dropdown" },
     button(
       {
@@ -460,7 +474,8 @@ const store_actions_dropdown = (req) =>
           '<i class="far fa-arrow-alt-circle-up"></i>&nbsp;' +
             req.__("Upgrade installed modules")
         ),
-      db.getTenantSchema() === db.connectObj.default_schema &&
+      (db.getTenantSchema() === db.connectObj.default_schema ||
+        tenants_install_git) &&
         a(
           {
             class: "dropdown-item",
@@ -488,6 +503,7 @@ const store_actions_dropdown = (req) =>
       //create pack
     )
   );
+};
 
 /**
  * @param {object[]} items
@@ -926,14 +942,22 @@ router.get(
   "/upgrade",
   isAdmin,
   error_catcher(async (req, res) => {
-    const installed_plugins = await Plugin.find({});
-    for (const plugin of installed_plugins) {
-      await plugin.upgrade_version((p, f) => load_plugins.loadPlugin(p, f));
+    const schema = db.getTenantSchema();
+    if (schema === db.connectObj.default_schema) {
+      await upgrade_all_tenants_plugins((p, f) =>
+        load_plugins.loadPlugin(p, f)
+      );
+      req.flash("success", req.__(`Modules up-to-date. Please restart server`));
+    } else {
+      const installed_plugins = await Plugin.find({});
+      for (const plugin of installed_plugins) {
+        await plugin.upgrade_version((p, f) => load_plugins.loadPlugin(p, f));
+      }
+      req.flash("success", req.__(`Modules up-to-date`));
+      await restart_tenant(loadAllPlugins);
+      process.send &&
+        process.send({ restart_tenant: true, tenant: db.getTenantSchema() });
     }
-    req.flash("success", req.__(`Modules up-to-date`));
-    await restart_tenant(loadAllPlugins);
-    process.send &&
-      process.send({ restart_tenant: true, tenant: db.getTenantSchema() });
     res.redirect(`/plugins`);
   })
 );
@@ -970,7 +994,11 @@ router.post(
   error_catcher(async (req, res) => {
     const plugin = new Plugin(req.body);
     const schema = db.getTenantSchema();
-    if (schema !== db.connectObj.default_schema) {
+    const tenants_install_git = getRootState().getConfig(
+      "tenants_install_git",
+      false
+    );
+    if (schema !== db.connectObj.default_schema && !tenants_install_git) {
       req.flash(
         "error",
         req.__(`Only store modules can be installed on tenant instances`)
@@ -1039,7 +1067,10 @@ router.post(
   isAdmin,
   error_catcher(async (req, res) => {
     const { name } = req.params;
-
+    const tenants_unsafe_plugins = getRootState().getConfig(
+      "tenants_unsafe_plugins",
+      false
+    );
     const plugin = await Plugin.store_by_name(decodeURIComponent(name));
     if (!plugin) {
       req.flash(
@@ -1050,7 +1081,7 @@ router.post(
       return;
     }
     const isRoot = db.getTenantSchema() === db.connectObj.default_schema;
-    if (!isRoot && plugin.unsafe) {
+    if (!isRoot && plugin.unsafe && !tenants_unsafe_plugins) {
       req.flash(
         "error",
         req.__("Cannot install unsafe modules on subdomain tenants")

package/routes/tables.js

@@ -51,6 +51,7 @@ const {
 const { getState } = require("@saltcorn/data/db/state");
 const { cardHeaderTabs } = require("@saltcorn/markup/layout_utils");
 const { tablesList } = require("./common_lists");
+const { InvalidConfiguration } = require("@saltcorn/data/utils");
 
 /**
  * @type {object}
@@ -180,6 +181,7 @@ router.get(
   "/new/",
   isAdmin,
   error_catcher(async (req, res) => {
+    const table_provider_names = Object.keys(getState().table_providers);
     res.sendWrap(req.__(`New table`), {
       above: [
         {
@@ -203,6 +205,20 @@ router.get(
                   input_type: "text",
                   required: true,
                 },
+                ...(table_provider_names.length
+                  ? [
+                      {
+                        label: req.__("Table provider"),
+                        name: "provider_name",
+                        input_type: "select",
+                        options: [
+                          req.__("Database table"),
+                          ...table_provider_names,
+                        ],
+                        required: true,
+                      },
+                    ]
+                  : []),
               ],
             }),
             req.csrfToken()
@@ -439,8 +455,7 @@ router.get(
         title: req.__("Tables"),
         headers: [
           {
-            script:
-              "https://unpkg.com/vis-network@9.1.2/standalone/umd/vis-network.min.js",
+            script: `/static_assets/${db.connectObj.version_tag}/vis-network.min.js`,
           },
         ],
       },
@@ -549,9 +564,9 @@ router.get(
     const { idorname } = req.params;
     let id = parseInt(idorname);
     let table;
-    if (id) table = await Table.findOne({ id });
+    if (id) table = Table.findOne({ id });
     else {
-      table = await Table.findOne({ name: idorname });
+      table = Table.findOne({ name: idorname });
     }
 
     if (!table) {
@@ -646,7 +661,7 @@ router.get(
     var viewCard;
     if (fields.length > 0) {
       const views = await View.find(
-        table.external ? { exttable_name: table.name } : { table_id: table.id }
+        table.id ? { table_id: table.id } : { exttable_name: table.name }
       );
       var viewCardContents;
       if (views.length > 0) {
@@ -727,6 +742,16 @@ router.get(
             : req.__("Edit")
         )
       ),
+      table.provider_name &&
+        div(
+          { class: "mx-auto" },
+          a(
+            { href: `/table/provider-cfg/${table.id}` },
+            i({ class: "fas fa-2x fa-tools" }),
+            "<br/>",
+            req.__("Configure provider")
+          )
+        ),
       div(
         { class: "mx-auto" },
         a(
@@ -821,7 +846,13 @@ router.get(
           type: "breadcrumbs",
           crumbs: [
             { text: req.__("Tables"), href: "/table" },
-            { text: span({ class: "fw-bold text-body" }, table.name) },
+            {
+              text: span(
+                { class: "fw-bold text-body" },
+                table.name,
+                table.provider_name && ` (${table.provider_name} provider)`
+              ),
+            },
           ],
         },
         {
@@ -876,7 +907,14 @@ router.post(
       } else if (db.sqlsanitize(name) === "") {
         req.flash("error", req.__(`Invalid table name %s`, name));
         res.redirect(`/table/new`);
+      } else if (
+        rest.provider_name &&
+        rest.provider_name !== "Database table"
+      ) {
+        const table = await Table.create(name, rest);
+        res.redirect(`/table/provider-cfg/${table.id}`);
       } else {
+        delete rest.provider_name;
         const table = await Table.create(name, rest);
         req.flash("success", req.__(`Table %s created`, name));
         res.redirect(`/table/${table.id}`);
@@ -1005,23 +1043,6 @@ router.post(
     }
   })
 );
-/**
- * Table badges to show in System Table list views
- * Currently supports:
- * - Owned - if ownership_field_id? What is it?
- * - History - if table has versioning
- * - External - if this is external table
- * @param {object} t table object
- * @param {object} req http request
- * @returns {string} html string with list of badges
- */
-const tableBadges = (t, req) => {
-  let s = "";
-  if (t.ownership_field_id) s += badge("primary", req.__("Owned"));
-  if (t.versioned) s += badge("success", req.__("History"));
-  if (t.external) s += badge("info", req.__("External"));
-  return s;
-};
 
 /**
  * List Views of Tables (GET Handler)
@@ -1529,3 +1550,119 @@ router.post(
     res.redirect(`/table/${table.id}`);
   })
 );
+
+const respondWorkflow = (table, wf, wfres, req, res) => {
+  const wrap = (contents, noCard, previewURL) => ({
+    above: [
+      {
+        type: "breadcrumbs",
+        crumbs: [
+          { text: req.__("Tables"), href: "/table" },
+          { href: `/table/${table.id || table.name}`, text: table.name },
+          { text: req.__("Configuration") },
+        ],
+      },
+      {
+        type: noCard ? "container" : "card",
+        class: !noCard && "mt-0",
+        title: wfres.title,
+        titleAjaxIndicator: true,
+        contents,
+      },
+    ],
+  });
+  if (wfres.flash) req.flash(wfres.flash[0], wfres.flash[1]);
+  if (wfres.renderForm)
+    res.sendWrap(
+      {
+        title: req.__(`%s configuration`, table.name),
+        headers: [
+          {
+            script: `/static_assets/${db.connectObj.version_tag}/jquery-menu-editor.min.js`,
+          },
+          {
+            script: `/static_assets/${db.connectObj.version_tag}/iconset-fontawesome5-3-1.min.js`,
+          },
+          {
+            script: `/static_assets/${db.connectObj.version_tag}/bootstrap-iconpicker.js`,
+          },
+          {
+            css: `/static_assets/${db.connectObj.version_tag}/bootstrap-iconpicker.min.css`,
+          },
+        ],
+      },
+      wrap(
+        renderForm(wfres.renderForm, req.csrfToken()),
+        false,
+        wfres.previewURL
+      )
+    );
+  else res.redirect(wfres.redirect);
+};
+
+const get_provider_workflow = (table, req) => {
+  const provider = getState().table_providers[table.provider_name];
+  if (!provider) {
+    throw new InvalidConfiguration(
+      `Provider not found for rable ${table.name}: table.provider_name`
+    );
+  }
+  const workflow = provider.configuration_workflow(req);
+  workflow.action = `/table/provider-cfg/${table.id}`;
+  const oldOnDone = workflow.onDone || ((c) => c);
+  workflow.onDone = async (ctx) => {
+    const { table_id, ...configuration } = await oldOnDone(ctx);
+    await table.update({ provider_cfg: configuration });
+
+    return {
+      redirect: `/table/${table.id}`,
+      flash: ["success", `Table ${this.name || ""} saved`],
+    };
+  };
+  return workflow;
+};
+
+router.get(
+  "/provider-cfg/:id",
+  isAdmin,
+  error_catcher(async (req, res) => {
+    const { id } = req.params;
+    const { step } = req.query;
+
+    const table = await Table.findOne({ id });
+    if (!table) {
+      req.flash("error", `Table not found`);
+      res.redirect(`/table`);
+      return;
+    }
+    const workflow = get_provider_workflow(table, req);
+    const wfres = await workflow.run(
+      {
+        ...(table.provider_cfg || {}),
+        table_id: table.id,
+        ...(step ? { stepName: step } : {}),
+      },
+      req
+    );
+    respondWorkflow(table, workflow, wfres, req, res);
+  })
+);
+
+router.post(
+  "/provider-cfg/:id",
+  isAdmin,
+  error_catcher(async (req, res) => {
+    const { id } = req.params;
+    const { step } = req.query;
+
+    const table = await Table.findOne({ id });
+    if (!table) {
+      req.flash("error", `Table not found`);
+      res.redirect(`/table`);
+      return;
+    }
+    const workflow = get_provider_workflow(table, req);
+    const wfres = await workflow.run(req.body, req);
+    respondWorkflow(table, workflow, wfres, req, res);
+  })
+);

package/routes/tenant.js

@@ -426,6 +426,10 @@ const tenant_settings_form = (req) =>
       "create_tenant_warning",
       "create_tenant_warning_text",
       "tenant_template",
+      { section_header: "Tenant application capabilities" },
+      "tenants_install_git",
+      "tenants_set_npm_modules",
+      "tenants_unsafe_plugins",
     ],
     action: "/tenant/settings",
     submitLabel: req.__("Save"),

package/routes/utils.js

@@ -19,7 +19,12 @@ const is = require("contractis/is");
 const { validateHeaderName, validateHeaderValue } = require("http");
 const Crash = require("@saltcorn/data/models/crash");
 const si = require("systeminformation");
-
+const {
+  config_fields_form,
+  save_config_from_form,
+  check_if_restart_required,
+  flash_restart,
+} = require("../markup/admin.js");
 const get_sys_info = async () => {
   const disks = await si.fsSize();
   let size = 0;
@@ -318,6 +323,63 @@ const is_relative_url = (url) => {
   return typeof url === "string" && !url.includes(":/") && !url.includes("//");
 };
 
+const admin_config_route = ({
+  router,
+  path,
+  super_path = "",
+  get_form,
+  field_names,
+  response,
+  flash,
+}) => {
+  const getTheForm = async (req) =>
+    !get_form && field_names
+      ? await config_fields_form({
+          req,
+          field_names,
+          action: super_path + path,
+        })
+      : typeof get_form === "function"
+      ? await get_form(req)
+      : get_form;
+
+  router.get(
+    path,
+    isAdmin,
+    error_catcher(async (req, res) => {
+      response(await getTheForm(req), req, res);
+    })
+  );
+  router.post(
+    path,
+    isAdmin,
+    error_catcher(async (req, res) => {
+      const form = await getTheForm(req);
+      form.validate(req.body);
+      if (form.hasErrors) {
+        response(form, req, res);
+      } else {
+        const restart_required = check_if_restart_required(form, req);
+
+        await save_config_from_form(form);
+        if (!req.xhr) {
+          if (restart_required) {
+            flash_restart(req);
+          } else req.flash("success", req.__(flash));
+          res.redirect(super_path + path);
+        } else {
+          if (restart_required)
+            res.json({
+              success: "ok",
+              notify: req.__("Restart required for changes to take effect."),
+            });
+          else res.json({ success: "ok" });
+        }
+      }
+    })
+  );
+};
+
 module.exports = {
   sqlsanitize,
   csrfField,
@@ -333,4 +395,5 @@ module.exports = {
   addOnDoneRedirect,
   is_relative_url,
   get_sys_info,
+  admin_config_route,
 };

package/tests/api.test.js

@@ -19,7 +19,7 @@ beforeAll(async () => {
 afterAll(db.close);
 
 describe("API read", () => {
-  it("should get books for public", async () => {
+  it("should get books for public simple", async () => {
     const app = await getApp({ disableCsrf: true });
     await request(app)
       .get("/api/books/")
@@ -32,7 +32,7 @@ describe("API read", () => {
         )
       );
   });
-  it("should get books for public", async () => {
+  it("should get books for public fts", async () => {
     const app = await getApp({ disableCsrf: true });
     await request(app)
       .get("/api/books/?_fts=Herman")