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

package/routes/api.js

@@ -135,6 +135,21 @@ const getFlashes = (req) =>
     })
     .filter((a) => a.msg && a.msg.length && a.msg.length > 0);
 
+router.use(
+  error_catcher(async (req, res, next) => {
+    const state = getState();
+    const maintenanceModeEnabled = state.getConfig(
+      "maintenance_mode_enabled",
+      false
+    );
+    if (maintenanceModeEnabled && (!req.user || req.user.role_id > 1)) {
+      res.status(503).json({ error: "in maintenance mode" });
+      return;
+    }
+    next();
+  })
+);
+
 router.post(
   "/viewQuery/:viewName/:queryName",
   error_catcher(async (req, res, next) => {
@@ -446,6 +461,44 @@ router.get(
   })
 );
 
+router.get("/:tableName/count", async (req, res, next) => {
+  const { tableName } = req.params;
+  const { approximate, ...req_query } = req.query;
+
+  const table = Table.findOne(
+    strictParseInt(tableName)
+      ? { id: strictParseInt(tableName) }
+      : { name: tableName }
+  );
+  if (!table) {
+    getState().log(3, `API get ${tableName} table not found`);
+    res.status(404).json({ error: req.__("Not found") });
+    return;
+  }
+  await passport.authenticate(
+    ["api-bearer", "jwt"],
+    { session: false },
+    async function (err, user, info) {
+      if (accessAllowedRead(req, user, table)) {
+        const tbl_fields = table.getFields();
+        readState(req_query, tbl_fields, req);
+        const qstate = stateFieldsToWhere({
+          fields: tbl_fields,
+          approximate: !!approximate,
+          state: req_query,
+          table,
+          prefix: "a.",
+        });
+        const count = await table.countRows(qstate);
+        res.json({ success: count });
+      } else {
+        getState().log(3, `API get ${table.name} not authorized`);
+        res.status(401).json({ error: req.__("Not authorized") });
+      }
+    }
+  )(req, res, next);
+});
+
 /**
  * Emit Event using POST
  * This is used from the mobile app to send an event to the server.

package/routes/files.js

@@ -52,6 +52,18 @@ const { extract } = require("@saltcorn/admin-models/models/backup");
 const router = new Router();
 module.exports = router;
 
+router.use(
+  error_catcher(async (req, res, next) => {
+    const state = getState();
+    const maintenanceModeEnabled =  state.getConfig("maintenance_mode_enabled", false);
+    if (maintenanceModeEnabled && (!req.user || req.user.role_id > 1)) {
+      res.status(503).send("Page Unavailable: in maintenance mode");
+      return;
+    }
+    next();
+  })
+)
+
 const send_files_picker = async (folder, noSubdirs, inputId, req, res) => {
   res.set("SaltcornModalWidth", "1200px");
   res.sendWrap(req.__("Please select a file"), {

package/routes/homepage.js

@@ -15,7 +15,7 @@ const Page = require("@saltcorn/data/models/page");
 const PageGroup = require("@saltcorn/data/models/page_group");
 const Plugin = require("@saltcorn/data/models/plugin");
 const { link, mkTable } = require("@saltcorn/markup");
-const { div, a, p, i, h5, span } = require("@saltcorn/markup/tags");
+const { div, a, p, i, h5, span, title } = require("@saltcorn/markup/tags");
 const Table = require("@saltcorn/data/models/table");
 const { get_cached_packs } = require("@saltcorn/admin-models/models/pack");
 // const { restore_backup } = require("../markup/admin");
@@ -553,6 +553,28 @@ const no_views_logged_in = async (req, res) => {
  * @returns {Promise<boolean>}
  */
 const get_config_response = async (role_id, res, req) => {
+  const state = getState();
+  const maintenanceModeEnabled = state.getConfig("maintenance_mode_enabled", false);
+  const maintenanceModePage = state.getConfig("maintenance_mode_page", "");
+
+  if(maintenanceModeEnabled && (!req.user || req.user.role_id > 1) && maintenanceModePage) {
+    const db_page = await Page.findOne({ name: maintenanceModePage });
+    if (db_page) {
+      res.sendWrap(
+        {
+          title: db_page.title,
+          description: db_page.description,
+          bodyClass: "page_" + db.sqlsanitize(maintenanceModePage),
+        },
+        await db_page.run(req.query, { res, req })
+      );
+      return true;
+    } else {
+      res.status(503).send("Page Unavailable: in maintenance mode");
+      return true;
+    }
+  }
+
   const wrap = async (
     contents,
     homeCfg,

package/routes/menu.js

@@ -624,6 +624,20 @@ router.post(
   })
 );
 
+router.post(
+  "/action/:rndid",
+  error_catcher(async (req, res, next) => {
+    const state = getState();
+    const maintenanceModeEnabled = state.getConfig("maintenance_mode_enabled", false);
+
+    if (maintenanceModeEnabled && (!req.user || req.user.role_id > 1)) {
+      res.status(503).json({ error: "in maintenance mode" });
+      return;
+    }
+    next();
+  }),
+);
+
 const getIcons = () => {
   return getState().icons;
 };

package/routes/notifications.js

@@ -20,6 +20,18 @@ const db = require("@saltcorn/data/db");
 const router = new Router();
 module.exports = router;
 
+router.use(
+  error_catcher(async (req, res, next) => {
+    const state = getState();
+    const maintenanceModeEnabled = state.getConfig("maintenance_mode_enabled", false);
+    if (maintenanceModeEnabled && (!req.user || req.user.role_id > 1)) {
+      res.status(503).send("Page Unavailable: in maintenance mode");
+      return;
+    }
+    next();
+  })
+);
+
 const notificationSettingsForm = () =>
   new Form({
     action: `/notifications/settings`,

package/routes/page.js

@@ -145,8 +145,23 @@ const runPageGroup = async (pageGroup, req, res, tic) => {
 router.get(
   "/:pagename",
   error_catcher(async (req, res) => {
-    const { pagename } = req.params;
     const state = getState();
+    const maintenanceModeEnabled = state.getConfig("maintenance_mode_enabled", false);
+    const maintenanceModePage = state.getConfig("maintenance_mode_page", "");
+
+    if (
+      maintenanceModeEnabled &&
+      (!req.user || req.user.role_id > 1) &&
+      maintenanceModePage
+    ) {
+      const maintenancePage = await Page.findOne({ name: maintenanceModePage });
+      if (maintenancePage) {
+        await runPage(maintenancePage, req, res, new Date());
+        return;
+      }
+    }
+
+    const { pagename } = req.params;
     state.log(
       3,
       `Route /page/${pagename} user=${req.user?.id}${
@@ -177,6 +192,13 @@ router.post(
   "/:pagename/preview",
   isAdmin,
   error_catcher(async (req, res) => {
+    const state = getState();
+    const maintenanceModeEnabled = state.getConfig("maintenance_mode_enabled", false);
+    if (maintenanceModeEnabled && (!req.user || req.user.role_id > 1)) {
+      res.status(503).json({ error: "in maintenance mode" });
+      return;
+    }
+
     const { pagename } = req.params;
     const page = await Page.findOne({ name: pagename });
     if (!page) {
@@ -191,6 +213,13 @@ router.post(
 router.post(
   "/:pagename/action/:rndid",
   error_catcher(async (req, res) => {
+    const state = getState();
+    const maintenanceModeEnabled = state.getConfig("maintenance_mode_enabled", false);
+    if (maintenanceModeEnabled && (!req.user || req.user.role_id > 1)) {
+      res.status(503).json({ error: "in maintenance mode" });
+      return;
+    }
+
     const { pagename, rndid } = req.params;
     const role = req.user && req.user.id ? req.user.role_id : 100;
     const db_page = await Page.findOne({ name: pagename });

package/routes/registry.js

@@ -19,12 +19,14 @@ const {
   details,
   summary,
 } = require("@saltcorn/markup/tags");
-const Table = require("@saltcorn/data/models/table");
 const { isAdmin, error_catcher } = require("./utils");
 const { send_infoarch_page } = require("../markup/admin.js");
+const Table = require("@saltcorn/data/models/table");
 const View = require("@saltcorn/data/models/view");
 const Page = require("@saltcorn/data/models/page");
 const Form = require("@saltcorn/data/models/form");
+const Trigger = require("@saltcorn/data/models/trigger");
+const Plugin = require("@saltcorn/data/models/plugin");
 const {
   table_pack,
   view_pack,
@@ -40,8 +42,8 @@ const {
   event_log_pack,
   install_pack,
 } = require("@saltcorn/admin-models/models/pack");
-const Trigger = require("@saltcorn/data/models/trigger");
 const { getState } = require("@saltcorn/data/db/state");
+const { sleep } = require("@saltcorn/data/utils");
 /**
  * @type {object}
  * @const
@@ -81,6 +83,10 @@ router.get(
       {},
       { orderBy: "name", nocase: true }
     );
+    const all_plugins = await Plugin.find(
+      { name: { not: { in: ["base", "sbadmin2"] } } },
+      { orderBy: "name", nocase: true }
+    );
     const isRoot = db.getTenantSchema() === db.connectObj.default_schema;
 
     const all_configs_obj = await getState().getAllConfigOrDefaults();
@@ -91,7 +97,7 @@ router.get(
       }))
       .filter((c) => isRoot || !c.root_only);
 
-    let tables, views, pages, triggers, configs;
+    let tables, views, pages, triggers, configs, plugins;
     if (q) {
       const qlower = q.toLowerCase();
       const includesQ = (s) => s.toLowerCase().includes(qlower);
@@ -113,12 +119,17 @@ router.get(
         return includesQ(JSON.stringify(pack));
       });
       configs = all_configs.filter((c) => includesQ(JSON.stringify(c)));
+      plugins = all_plugins.filter(
+        (p) =>
+          includesQ(p.name) || includesQ(JSON.stringify(p.configuration || {}))
+      );
     } else {
       tables = all_tables;
       views = all_views;
       pages = all_pages;
       triggers = all_triggers;
       configs = all_configs;
+      plugins = all_plugins;
     }
     const li_link = (etype1, ename1) =>
       li(
@@ -224,6 +235,20 @@ router.get(
 
         edContents = renderForm(mkForm(trpack), req.csrfToken());
         break;
+      case "module":
+        const plugin = all_plugins.find((p) => p.name === ename);
+        cfg_link =
+          `${ename} ${etype}` +
+          a(
+            {
+              class: "ms-1 me-3",
+              href: `/plugins/configure/${encodeURIComponent(ename)}`,
+            },
+            "Configure ",
+            i({ class: "fas fa-cog" })
+          );
+        edContents = renderForm(mkForm(plugin.configuration), req.csrfToken());
+        break;
     }
     send_infoarch_page({
       res,
@@ -315,6 +340,16 @@ router.get(
                       configs.map((t) => li_link("config", t.name))
                     )
                   )
+                ),
+                li(
+                  details(
+                    { open: q || etype === "module" },
+                    summary("Modules"),
+                    ul(
+                      { class: "ps-3" },
+                      plugins.map((m) => li_link("module", m.name))
+                    )
+                  )
                 )
               )
             ),
@@ -372,7 +407,25 @@ router.post(
         break;
     }
     await db.withTransaction(async () => {
-      await install_pack(pack);
+      if (etype === "module") {
+        const plugin = await Plugin.findOne({ name: ename });
+        if (!plugin) throw new Error(`Module ${ename} not found`);
+        let module = getState().plugins[plugin.name];
+        if (!module) {
+          module =
+            getState().plugins[getState().plugin_module_names[plugin.name]];
+        }
+        if (module.configuration_workflow) {
+          const flow = module.configuration_workflow();
+          if (flow?.onStepSave) await flow.onStepSave({}, {}, entVal);
+          if (flow?.onDone) {
+            const doneRes = await flow.onDone(entVal);
+            if (doneRes?.cleanup) await doneRes.cleanup();
+          }
+        }
+        plugin.configuration = entVal;
+        await plugin.upsert();
+      } else await install_pack(pack);
     });
     switch (etype) {
       case "table":
@@ -390,6 +443,13 @@ router.post(
       case "config":
         await getState().refresh_config();
         break;
+      case "module":
+        getState().processSend({
+          refresh_plugin_cfg: ename,
+          tenant: db.getTenantSchema(),
+        });
+        await sleep(500);
+        break;
     }
     res.redirect(
       `/registry-editor?etype=${etype}&ename=${encodeURIComponent(

package/routes/search.js

@@ -365,6 +365,16 @@ const syntax_help_link = (req) => {
  */
 router.get(
   "/",
+  error_catcher(async (req, res, next) => {
+    const state = getState();
+    const maintenanceModeEnabled = state.getConfig("maintenance_mode_enabled", false);
+
+    if (maintenanceModeEnabled && (!req.user || req.user.role_id > 1)) {
+      res.status(503).send("Page Unavailable: in maintenance mode");
+      return;
+    }
+    next();
+  }),
   error_catcher(async (req, res) => {
     const min_role = getState().getConfig("min_role_search");
     const role = (req.user || {}).role_id || 100;

package/routes/view.js

@@ -9,6 +9,7 @@ const Router = require("express-promise-router");
 const View = require("@saltcorn/data/models/view");
 const Table = require("@saltcorn/data/models/table");
 const Trigger = require("@saltcorn/data/models/trigger");
+const Page = require("@saltcorn/data/models/page");
 
 const { text, style, div } = require("@saltcorn/markup/tags");
 const {
@@ -41,11 +42,27 @@ module.exports = router;
 router.get(
   ["/:viewname", "/:viewname/*slug"],
   error_catcher(async (req, res) => {
+    const state = getState();
+    const maintenanceModeEnabled = state.getConfig("maintenance_mode_enabled", false);
+    const maintenanceModePage = state.getConfig("maintenance_mode_page", "");
+
+    if (
+      maintenanceModeEnabled &&
+      (!req.user || req.user.role_id > 1) &&
+      maintenanceModePage
+    ) {
+      const maintenancePage = await Page.findOne({ name: maintenanceModePage });
+      if (maintenancePage) {
+        const tic = new Date();
+        await maintenancePage.run(req.query, { res, req });
+        return;
+      }
+    }
+
     const { viewname } = req.params;
     const query = { ...req.query };
     const view = await View.findOne({ name: viewname });
     const role = req.user && req.user.id ? req.user.role_id : 100;
-    const state = getState();
     state.log(
       3,
       `Route /view/${viewname} user=${req.user?.id}${
@@ -223,6 +240,16 @@ router.post(
  */
 router.post(
   "/:viewname/:route",
+  error_catcher(async (req, res, next) => {
+    const state = getState();
+    const maintenanceModeEnabled = state.getConfig("maintenance_mode_enabled", false);
+
+    if (maintenanceModeEnabled && (!req.user || req.user.role_id > 1)) {
+      res.status(503).json({ error: "in maintenance mode" });
+      return;
+    }
+    next();
+  }),
   error_catcher(async (req, res) => {
     const { viewname, route } = req.params;
     const role = req.user && req.user.id ? req.user.role_id : 100;
@@ -258,6 +285,15 @@ router.post(
  */
 router.post(
   ["/:viewname", "/:viewname/*slug"],
+  error_catcher(async (req, res, next) => {
+    const state = getState();
+    const maintenanceModeEnabled = state.getConfig("maintenance_mode_enabled", false);
+    if (maintenanceModeEnabled && (!req.user || req.user.role_id > 1)) {
+      res.status(503).send("Page Unavailable: in maintenance mode");
+      return;
+    }
+    next();
+  }),
   setTenant,
   error_catcher(async (req, res) => {
     const { viewname } = req.params;

package/serve.js

@@ -183,7 +183,10 @@ const initMaster = async ({ disableMigrate }, useClusterAdaptor = true) => {
   }
   eachTenant(async () => {
     const state = getState();
-    if (state) await state.setConfig("joined_log_socket_ids", []);
+    if (state) {
+      await state.setConfig("joined_log_socket_ids", []);
+      await state.setConfig("joined_real_time_socket_ids", []);
+    }
   });
   if (useClusterAdaptor) setupPrimary();
 };
@@ -518,6 +521,11 @@ const setupSocket = (subdomainOffset, pruneSessionInterval, ...servers) => {
       .emit("log_msg", { text: msg, time, level });
   });
 
+  // Real-time collaboration emitter
+  getState().setCollabEmitter((tenant, type, data) => {
+    io.of("/").to(`_${tenant}_collab_room_`).emit(type, data);
+  });
+
   io.of("/").on("connection", (socket) => {
     socket.on("join_room", ([viewname, room_id]) => {
       const ten = get_tenant_from_req(socket.request) || "public";
@@ -569,6 +577,38 @@ const setupSocket = (subdomainOffset, pruneSessionInterval, ...servers) => {
       else await f();
     });
 
+    // or join the room more generally and later register views ??
+    socket.on("join_collab_room", async (viewname, callback) => {
+      const tenant =
+        get_tenant_from_req(socket.request, subdomainOffset) || "public";
+      const f = async () => {
+        try {
+          const view = View.findOne({ name: viewname });
+          if (!view) throw new Error(`View ${viewname} not found`);
+          const user = socket.request.user;
+          const role_id = user ? user.role_id : 100;
+          if (view.min_role < role_id)
+            throw new Error("Not authorized to join collaboration room");
+          socket.join(`_${tenant}_collab_room_`);
+          const socketIds = await getState().getConfig(
+            "joined_real_time_socket_ids"
+          );
+          socketIds.push(socket.id);
+          await getState().setConfig(
+            "joined_real_time_socket_ids",
+            [...socketIds]
+          );
+          if (typeof callback === "function") callback({ status: "ok" });
+        } catch (err) {
+          getState().log(1, `Socket join_collab_room: ${err.stack}`);
+          if (typeof callback === "function")
+            callback({ status: "error", msg: err.message || "unknown error" });
+        }
+      };
+      if (tenant && tenant !== "public") db.runWithTenant(tenant, f);
+      else await f();
+    });
+
     socket.on("disconnect", async () => {
       const tenant =
         get_tenant_from_req(socket.request, subdomainOffset) || "public";

package/systemd.js

@@ -66,7 +66,7 @@ module.exports =
       notify.ready();
       const watchdogInterval = notify.watchdogInterval();
       if (watchdogInterval && watchdogInterval > 0) {
-        const interval = Math.floor(watchdogInterval / 2);
+        const interval = Math.floor(watchdogInterval / 3);
         setInterval(() => {
           watchDog(interval, notify, opts);
         }, interval);

package/tests/api.test.js

@@ -223,6 +223,57 @@ describe("API read", () => {
       );
   });
 });
+describe("API count", () => {
+  it("should count books for public simple", async () => {
+    const app = await getApp({ disableCsrf: true });
+    await request(app)
+      .get("/api/books/count")
+      .expect(succeedJsonWith((count) => count === 2));
+  });
+
+  // it("should count books for public fts", async () => {
+
+  it("should count books for public with search", async () => {
+    const app = await getApp({ disableCsrf: true });
+    await request(app)
+      .get("/api/books/count?pages=967")
+      .expect(succeedJsonWith((count) => count === 1));
+  });
+  it("should count with fkey args ", async () => {
+    const loginCookie = await getAdminLoginCookie();
+    const app = await getApp({ disableCsrf: true });
+    await request(app)
+      .get("/api/patients/count/?favbook=1")
+      .set("Cookie", loginCookie)
+      .expect(succeedJsonWith((count) => count === 1));
+  });
+  it("should count with fkey args with no value", async () => {
+    const loginCookie = await getAdminLoginCookie();
+    const app = await getApp({ disableCsrf: true });
+    await request(app)
+      .get("/api/patients/count/?favbook=")
+      .set("Cookie", loginCookie)
+      .expect(succeedJsonWith((count) => count === 0));
+  });
+  it("should count books for public with search and one field", async () => {
+    const app = await getApp({ disableCsrf: true });
+    await request(app)
+      .get("/api/books/count/?fields=author&pages=967")
+      .expect(succeedJsonWith((count) => count === 1));
+  });
+  it("should not allow public count access to patients", async () => {
+    const app = await getApp({ disableCsrf: true });
+    await request(app).get("/api/patients/count").expect(notAuthorized);
+  });
+  it("should allow staff count access to patients", async () => {
+    const loginCookie = await getStaffLoginCookie();
+    const app = await getApp({ disableCsrf: true });
+    await request(app)
+      .get("/api/patients/count")
+      .set("Cookie", loginCookie)
+      .expect(succeedJsonWith((count) => count === 2));
+  });
+});
 describe("API post", () => {
   it("should post books", async () => {
     const loginCookie = await getAdminLoginCookie();