@saltcorn/server 1.3.0-beta.4 → 1.3.0-beta.6

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/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/tables.js

@@ -72,6 +72,7 @@ const {
   removeAllWhiteSpace,
   comparingCaseInsensitive,
   validSqlId,
+  interpolate,
 } = require("@saltcorn/data/utils");
 const { EOL } = require("os");
 
@@ -934,14 +935,12 @@ router.get(
       if (user_can_edit_views) {
         let create_basic_link = "";
         if (views.length === 0) {
-          create_basic_link = post_btn(
-            `/table/create-basic-views/${table.id}`,
-            "Create basic views",
-            req.csrfToken(),
+          create_basic_link = a(
             {
-              btnClass: "btn-outline-secondary",
-              formClass: "d-inline me-2",
-            }
+              class: "btn btn-outline-secondary ms-2",
+              href: `javascript:ajax_modal('/table/create-basic-views/${table.id}')`,
+            },
+            req.__("Create basic views")
           );
         }
         viewCard = {
@@ -2452,6 +2451,77 @@ router.post(
   })
 );
 
+const basicViewForm = async (table, req) => {
+  const tables = await Table.find();
+  const vts = viewtemplates_with_create_basic_option();
+  return new Form({
+    submitLabel: req.__("Create views"),
+    action: `/table/create-basic-views/${table.id}`,
+    formStyle: "vert",
+    fields: [
+      {
+        type: "String",
+        label: "View naming convention",
+        name: "naming_convention",
+        attributes: { spellcheck: false },
+        sublabel:
+          "Use <code>{{ }}</code> to access: <code>viewpattern</code>, <code>tablename</code>",
+      },
+      {
+        type: "String",
+        label: "Template table",
+        name: "template_table",
+        attributes: { options: tables.map((t) => t.name) },
+        help: {
+          topic: "Template tables",
+        },
+      },
+      ...vts.map((vt) => ({
+        type: "Bool",
+        label: vt,
+        name: vt,
+        default: true,
+      })),
+    ],
+  });
+};
+
+const viewtemplates_with_create_basic_option = () => {
+  const vts = [];
+  Object.entries(getState().viewtemplates).forEach(([nm, obj]) => {
+    if (obj.createBasicView) vts.push(nm);
+  });
+  return vts;
+};
+
+router.get(
+  "/create-basic-views/:id",
+  isAdminOrHasConfigMinRole("min_role_edit_tables"),
+  isAdminOrHasConfigMinRole("min_role_edit_views"),
+  error_catcher(async (req, res) => {
+    const { id } = req.params;
+
+    const table = Table.findOne({ id });
+    if (!table) {
+      req.flash("error", `Table not found`);
+      res.redirect(`/table`);
+      return;
+    }
+    res.set("Page-Title", req.__("Create basic views"));
+    const form = await basicViewForm(table, req);
+    form.values.naming_convention = getState().getConfig(
+      "viewgen_naming_convention"
+    );
+    form.values.template_table = getState().getConfig(
+      "viewgen_template_table",
+      ""
+    );
+    const page = renderForm(form, req.csrfToken());
+
+    res.send(page);
+  })
+);
+
 router.post(
   "/create-basic-views/:id",
   isAdminOrHasConfigMinRole("min_role_edit_tables"),
@@ -2465,68 +2535,74 @@ router.post(
       res.redirect(`/table`);
       return;
     }
+    const form = await basicViewForm(table, req);
+    form.validate(req.body || {});
+    if (form.hasErrors) {
+      req.flash("error", req.__("An error occurred"));
+      res.redirect(`/table/${table.id}`);
+      return;
+    }
+
+    if (
+      form.values.naming_convention &&
+      form.values.naming_convention !==
+        getState().getConfig("viewgen_naming_convention")
+    )
+      await getState().setConfig(
+        "viewgen_naming_convention",
+        form.values.naming_convention
+      );
+    if (
+      form.values.template_table !==
+      getState().getConfig("viewgen_template_table")
+    )
+      await getState().setConfig(
+        "viewgen_template_table",
+        form.values.template_table
+      );
+
     await db.withTransaction(async () => {
+      const getName = (viewtemplate) =>
+        interpolate(form.values.naming_convention, {
+          viewpattern: viewtemplate,
+          tablename: table.name,
+        }).trim();
+      const all_views_created = {};
+      const vts = viewtemplates_with_create_basic_option();
+      vts.forEach((vt) => {
+        if (form.values[vt]) all_views_created[vt] = getName(vt);
+      });
+
       const initial_view = async (table, viewtemplate) => {
-        const configuration = await initial_config_all_fields(
-          viewtemplate === "Edit"
-        )({ table_id: table.id });
-        //console.log(configuration);
-        const name = `${viewtemplate} ${table.name}`;
+        const isEdit = viewtemplate === "Edit";
+        const vtObj = getState().viewtemplates[viewtemplate];
+        const name = getName(viewtemplate);
+        const configuration = await vtObj.createBasicView({
+          table,
+          viewname: name,
+          all_views_created,
+          template_table: form.values.template_table
+            ? Table.findOne(form.values.template_table)
+            : undefined,
+          template_view: form.values.template_table
+            ? View.findOne({
+                table_id: Table.findOne(form.values.template_table).id,
+                viewtemplate,
+              })
+            : undefined,
+        });
         const view = await View.create({
           name,
           configuration,
           viewtemplate,
           table_id: table.id,
-          min_role: 100,
+          min_role: isEdit ? table.min_role_write : table.min_role_read,
         });
         return view;
       };
-      const list = await initial_view(table, "List");
-      const edit = await initial_view(table, "Edit");
-      const show = await initial_view(table, "Show");
-      await View.update(
-        {
-          configuration: {
-            ...list.configuration,
-            columns: [
-              ...list.configuration.columns,
-              {
-                type: "ViewLink",
-                view: `Own:Show ${table.name}`,
-                view_name: `Show ${table.name}`,
-                link_style: "",
-                view_label: "Show",
-                header_label: "Show",
-              },
-              {
-                type: "ViewLink",
-                view: `Own:Edit ${table.name}`,
-                view_name: `Edit ${table.name}`,
-                link_style: "",
-                view_label: "Edit",
-                header_label: "Edit",
-              },
-              {
-                type: "Action",
-                action_name: "Delete",
-                action_style: "btn-primary",
-              },
-            ],
-            view_to_create: `Edit ${table.name}`,
-          },
-        },
-        list.id
-      );
-      await View.update(
-        {
-          configuration: {
-            ...edit.configuration,
-            view_when_done: `List ${table.name}`,
-            destination_type: "View",
-          },
-        },
-        edit.id
-      );
+      for (const vtnm of Object.keys(all_views_created)) {
+        await initial_view(table, vtnm);
+      }
     });
     await getState().refresh_views();
     res.redirect(`/table/${table.id}`);

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();