@saltcorn/server 0.9.4-beta.2 → 0.9.4-beta.21

package/routes/tags.js

@@ -1,9 +1,10 @@
-const { a, text } = require("@saltcorn/markup/tags");
+const { a, text, i } = require("@saltcorn/markup/tags");
 
 const Tag = require("@saltcorn/data/models/tag");
 const Router = require("express-promise-router");
 const Form = require("@saltcorn/data/models/form");
 const User = require("@saltcorn/data/models/user");
+const stream = require("stream");
 
 const { isAdmin, error_catcher, csrfField } = require("./utils");
 const { send_infoarch_page } = require("../markup/admin");
@@ -23,6 +24,11 @@ const {
   getTriggerList,
 } = require("./common_lists");
 
+const db = require("@saltcorn/data/db");
+const { getState } = require("@saltcorn/data/db/state");
+const { create_pack_from_tag } = require("@saltcorn/admin-models/models/pack");
+const Table = require("@saltcorn/data/models/table");
+
 const router = new Router();
 module.exports = router;
 
@@ -42,7 +48,7 @@ router.get(
           mkTable(
             [
               {
-                label: req.__("Tagname"),
+                label: req.__("Tag name"),
                 key: (r) =>
                   link(`/tag/${r.id || r.name}?show_list=tables`, text(r.name)),
               },
@@ -57,7 +63,7 @@ router.get(
           a(
             {
               href: `/tag/new`,
-              class: "btn btn-primary",
+              class: "btn btn-primary mt-3",
             },
             req.__("Create tag")
           ),
@@ -73,6 +79,13 @@ router.get(
   error_catcher(async (req, res) => {
     res.sendWrap(req.__(`New tag`), {
       above: [
+        {
+          type: "breadcrumbs",
+          crumbs: [
+            { text: req.__(`Tags`), href: "/tag" },
+            { text: req.__(`New`) },
+          ],
+        },
         {
           type: "card",
           title: req.__(`New tag`),
@@ -97,7 +110,26 @@ router.get(
   })
 );
 
-const headerWithCollapser = (title, cardId, showList) =>
+router.get(
+  "/download-pack/:idorname",
+  isAdmin,
+  error_catcher(async (req, res) => {
+    const { idorname } = req.params;
+    const id = parseInt(idorname);
+    const tag = await Tag.findOne(id ? { id } : { name: idorname });
+    if (!tag) {
+      req.flash("error", req.__("Tag not found"));
+      return res.redirect(`/tag`);
+    }
+    const pack = await create_pack_from_tag(tag);
+    const readStream = new stream.PassThrough();
+    readStream.end(JSON.stringify(pack));
+    res.type("application/json");
+    res.attachment(`${tag.name}-pack.json`);
+    readStream.pipe(res);
+  })
+);
+const headerWithCollapser = (title, cardId, showList, count) =>
   a(
     {
       class: `card-header-left-collapse ${!showList ? "collapsed" : ""} ps-3`,
@@ -107,7 +139,8 @@ const headerWithCollapser = (title, cardId, showList) =>
       "aria-controls": cardId,
       role: "button",
     },
-    title
+    title,
+    ` (${count})`
   );
 
 const isShowList = (showList, listType) => showList === listType;
@@ -129,6 +162,9 @@ router.get(
     await setTableRefs(views);
     const pages = await tag.getPages();
     const triggers = await tag.getTriggers();
+    triggers.forEach((tr) => {
+      if (tr.table_id) tr.table_name = Table.findOne(tr.table_id)?.name;
+    });
     const roles = await User.get_roles();
 
     const tablesDomId = "tablesListId";
@@ -139,14 +175,15 @@ router.get(
       above: [
         {
           type: "breadcrumbs",
-          crumbs: [{ text: req.__(`Tag: %s`, tag.name) }],
+          crumbs: [{ text: req.__(`Tags`), href: "/tag" }, { text: tag.name }],
         },
         {
           type: "card",
           title: headerWithCollapser(
             req.__("Tables"),
             tablesDomId,
-            isShowList(show_list, "tables")
+            isShowList(show_list, "tables"),
+            tables.length
           ),
           contents: [
             await tablesList(tables, req, {
@@ -168,7 +205,8 @@ router.get(
           title: headerWithCollapser(
             req.__("Views"),
             viewsDomId,
-            isShowList(show_list, "views")
+            isShowList(show_list, "views"),
+            views.length
           ),
           contents: [
             await viewsList(views, req, {
@@ -190,10 +228,11 @@ router.get(
           title: headerWithCollapser(
             req.__("Pages"),
             pagesDomId,
-            isShowList(show_list, "pages")
+            isShowList(show_list, "pages"),
+            pages.length
           ),
           contents: [
-            getPageList(pages, roles, req, {
+            await getPageList(pages, roles, req, {
               tagId: tag.id,
               domId: pagesDomId,
               showList: isShowList(show_list, "pages"),
@@ -213,10 +252,11 @@ router.get(
           title: headerWithCollapser(
             req.__("Triggers"),
             triggersDomId,
-            isShowList(show_list, "triggers")
+            isShowList(show_list, "triggers"),
+            triggers.length
           ),
           contents: [
-            getTriggerList(triggers, req, {
+            await getTriggerList(triggers, req, {
               tagId: tag.id,
               domId: triggersDomId,
               showList: isShowList(show_list, "triggers"),
@@ -230,6 +270,19 @@ router.get(
             ),
           ],
         },
+        {
+          type: "card",
+          contents: [
+            a(
+              {
+                class: "btn btn-outline-primary",
+                href: `/tag/download-pack/${tag.id}`,
+              },
+              i({ class: "fas fa-download me-2" }),
+              "Download pack"
+            ),
+          ],
+        },
       ],
     });
   })

package/routes/utils.js

@@ -13,6 +13,7 @@ const {
   features,
 } = require("@saltcorn/data/db/state");
 const { get_base_url } = require("@saltcorn/data/models/config");
+const { hash } = require("@saltcorn/data/utils");
 const { input, script, domReady } = require("@saltcorn/markup/tags");
 const session = require("express-session");
 const cookieSession = require("cookie-session");
@@ -21,6 +22,7 @@ const { validateHeaderName, validateHeaderValue } = require("http");
 const Crash = require("@saltcorn/data/models/crash");
 const File = require("@saltcorn/data/models/file");
 const User = require("@saltcorn/data/models/user");
+const Page = require("@saltcorn/data/models/page");
 const si = require("systeminformation");
 const {
   config_fields_form,
@@ -30,6 +32,7 @@ const {
 } = require("../markup/admin.js");
 const path = require("path");
 const { UAParser } = require("ua-parser-js");
+const crypto = require("crypto");
 
 const get_sys_info = async () => {
   const disks = await si.fsSize();
@@ -144,9 +147,10 @@ const set_custom_http_headers = (res, req, state) => {
 /**
  * Tries to recognize tenant from HTTP Request
  * @param {object} req
+ * @param {number|undefined} hostPartsOffset (optional) for socketIO, to get the tenant with localhost
  * @returns {string}
  */
-const get_tenant_from_req = (req) => {
+const get_tenant_from_req = (req, hostPartsOffset) => {
   if (req.subdomains && req.subdomains.length > 0)
     return req.subdomains[req.subdomains.length - 1];
 
@@ -154,7 +158,8 @@ const get_tenant_from_req = (req) => {
     return db.connectObj.default_schema;
   if (!req.subdomains && req.headers.host) {
     const parts = req.headers.host.split(".");
-    if (parts.length < 3) return db.connectObj.default_schema;
+    if (parts.length < (!hostPartsOffset ? 3 : 3 - hostPartsOffset))
+      return db.connectObj.default_schema;
     else return parts[0];
   }
 };
@@ -505,6 +510,21 @@ const getEligiblePage = async (pageGroup, req, res) => {
   }
 };
 
+/**
+ * @param {PageGroup} pageGroup
+ * @param {any} req
+ * @returns the page, null or an error msg
+ */
+const getRandomPage = (pageGroup, req) => {
+  if (pageGroup.members.length === 0)
+    return req.__("Pagegroup %s has no members", pageGroup.name);
+  const hash = crypto.createHash("sha1").update(req.sessionID).digest("hex");
+  const idx =
+    parseInt(hash.substring(hash.length - 4), 16) % pageGroup.members.length;
+  const sessionMember = pageGroup.members[idx];
+  return Page.findOne({ id: sessionMember.page_id });
+};
+
 module.exports = {
   sqlsanitize,
   csrfField,
@@ -524,4 +544,5 @@ module.exports = {
   sendHtmlFile,
   setRole,
   getEligiblePage,
+  getRandomPage,
 };

package/routes/view.js

@@ -74,10 +74,12 @@ router.get(
     let title =
       isModal && view.attributes?.popup_title
         ? view.attributes?.popup_title
-        : scan_for_page_title(contents0, view.name);
-    if (isModal && (title || "").includes("{{")) {
+        : view.attributes?.page_title ||
+          scan_for_page_title(contents0, view.name); //legacy
+    if ((title || "").includes("{{")) {
       title = await view.interpolate_title_string(title, query);
     }
+    title = { title };
     if (isModal && view.attributes?.popup_width)
       res.set(
         "SaltcornModalWidth",
@@ -85,10 +87,27 @@ router.get(
           view.attributes?.popup_width_units || "px"
         }`
       );
+    if (isModal && view.attributes?.popup_minwidth)
+      res.set(
+        "SaltcornModalMinWidth",
+        `${view.attributes?.popup_minwidth}${
+          view.attributes?.popup_minwidth_units || "px"
+        }`
+      );
     if (isModal && view.attributes?.popup_save_indicator)
       res.set("SaltcornModalSaveIndicator", `true`);
     if (isModal && view.attributes?.popup_link_out)
       res.set("SaltcornModalLinkOut", `true`);
+    if (view.attributes?.page_description) {
+      let description = view.attributes?.page_description;
+      if ((description || "").includes("{{")) {
+        description = await view.interpolate_title_string(description, query);
+      }
+      title.description = description;
+    }
+    if (view.attributes?.no_menu) {
+      title.no_menu = true;
+    }
     const tock = new Date();
     const ms = tock.getTime() - tic.getTime();
     if (!isTest())

package/routes/viewedit.js

@@ -29,6 +29,9 @@ const Workflow = require("@saltcorn/data/models/workflow");
 const User = require("@saltcorn/data/models/user");
 const Page = require("@saltcorn/data/models/page");
 const File = require("@saltcorn/data/models/file");
+const Tag = require("@saltcorn/data/models/tag");
+const TagEntry = require("@saltcorn/data/models/tag_entry");
+
 const db = require("@saltcorn/data/db");
 const { sleep } = require("@saltcorn/data/utils");
 
@@ -56,7 +59,18 @@ router.get(
   error_catcher(async (req, res) => {
     let orderBy = "name";
     if (req.query._sortby === "viewtemplate") orderBy = "viewtemplate";
-    const views = await View.find({}, { orderBy, nocase: true });
+    const viewq = {};
+    let filterOnTag;
+    if (req.query._tag) {
+      const tagEntries = await TagEntry.find({
+        tag_id: +req.query._tag,
+        not: { view_id: null },
+      });
+      viewq.id = { in: tagEntries.map((te) => te.view_id).filter(Boolean) };
+      filterOnTag = await Tag.findOne({ id: +req.query._tag });
+    }
+
+    const views = await View.find(viewq, { orderBy, nocase: true });
     await setTableRefs(views);
 
     if (req.query._sortby === "table")
@@ -64,7 +78,7 @@ router.get(
         a.table.toLowerCase() > b.table.toLowerCase() ? 1 : -1
       );
 
-    const viewMarkup = await viewsList(views, req);
+    const viewMarkup = await viewsList(views, req, { filterOnTag });
     const tables = await Table.find();
 
     res.sendWrap(req.__(`Views`), {
@@ -183,6 +197,27 @@ const viewForm = async (req, tableOptions, roles, pages, values) => {
         options: roles.map((r) => ({ value: r.id, label: r.role })),
       }),
       new Field({
+        name: "page_title",
+        label: req.__("Page title"),
+        type: "String",
+        parent_field: "attributes",
+        tab: "View settings",
+        sublabel: req.__(
+          "Some view patterns accept interpolations. Ex: <code>{{ name }}</code> or <code>{{ row ? `Edit ${row.name}` : `New person` }}</code>"
+        ),
+      }),
+      new Field({
+        name: "page_description",
+        label: req.__("Page description"),
+        type: "String",
+        parent_field: "attributes",
+        tab: "View settings",
+        sublabel: req.__(
+          "For search engines. Some view patterns accept interpolations."
+        ),
+      }),
+      new Field({
+        // legacy
         name: "default_render_page",
         label: req.__("Show on page"),
         sublabel: req.__(
@@ -209,6 +244,14 @@ const viewForm = async (req, tableOptions, roles, pages, values) => {
         },
         showIf: { viewtemplate: hasTable },
       }),
+      new Field({
+        name: "no_menu",
+        label: req.__("No menu"),
+        sublabel: req.__("Omit the menu from this view"),
+        tab: "View settings",
+        parent_field: "attributes",
+        type: "Bool",
+      }),
       new Field({
         name: "popup_title",
         label: req.__("Title"),
@@ -238,6 +281,26 @@ const viewForm = async (req, tableOptions, roles, pages, values) => {
           options: ["px", "%", "vw", "em", "rem"],
         },
       },
+      {
+        name: "popup_minwidth",
+        label: req.__("Popup min width"),
+        type: "Integer",
+        tab: "Popup settings",
+        parent_field: "attributes",
+        attributes: { asideNext: true },
+      },
+      {
+        name: "popup_minwidth_units",
+        label: req.__("Units"),
+        type: "String",
+        tab: "Popup settings",
+        fieldview: "radio_group",
+        parent_field: "attributes",
+        attributes: {
+          inline: true,
+          options: ["px", "%", "vw", "em", "rem"],
+        },
+      },
       {
         name: "popup_save_indicator",
         label: req.__("Save indicator"),
@@ -571,7 +634,10 @@ const respondWorkflow = (view, wf, wfres, req, res, table) => {
   else if (wfres.renderBuilder) {
     wfres.renderBuilder.options.view_id = view.id;
     res.sendWrap(
-      req.__(`%s configuration`, view.name),
+      {
+        title: req.__(`%s configuration`, view.name),
+        requestFluidLayout: true,
+      },
       wrap(renderBuilder(wfres.renderBuilder, req.csrfToken()), true)
     );
   } else res.redirect(wfres.redirect);
@@ -759,7 +825,7 @@ router.post(
       await View.update({ configuration: newcfg }, +id);
       res.json({ success: "ok" });
     } else {
-      res.json({ error: "no view" });
+      res.json({ error: req.__("Unable to save: No view") });
     }
   })
 );

package/serve.js

@@ -112,6 +112,10 @@ const initMaster = async ({ disableMigrate }, useClusterAdaptor = true) => {
     const tenants = await getAllTenants();
     await init_multi_tenant(loadAllPlugins, disableMigrate, tenants);
   }
+  eachTenant(async () => {
+    const state = getState();
+    if (state) await state.setConfig("joined_log_socket_ids", []);
+  });
   if (useClusterAdaptor) setupPrimary();
 };
 
@@ -283,7 +287,7 @@ module.exports =
           })
           .ready((glx) => {
             const httpsServer = glx.httpsServer();
-            setupSocket(httpsServer);
+            setupSocket(appargs?.subdomainOffset, httpsServer);
             httpsServer.setTimeout(timeout * 1000);
             process.on("message", workerDispatchMsg);
             glx.serveApp(app);
@@ -350,7 +354,7 @@ const nonGreenlockWorkerSetup = async (appargs, port) => {
     // todo timeout to config
     httpServer.setTimeout(timeout * 1000);
     httpsServer.setTimeout(timeout * 1000);
-    setupSocket(httpServer, httpsServer);
+    setupSocket(appargs?.subdomainOffset, httpServer, httpsServer);
     httpServer.listen(port, () => {
       console.log("HTTP Server running on port 80");
     });
@@ -363,7 +367,7 @@ const nonGreenlockWorkerSetup = async (appargs, port) => {
     // server with http only
     const http = require("http");
     const httpServer = http.createServer(app);
-    setupSocket(httpServer);
+    setupSocket(appargs?.subdomainOffset, httpServer);
 
     // todo timeout to config
     // todo refer in doc to httpserver doc
@@ -380,7 +384,7 @@ const nonGreenlockWorkerSetup = async (appargs, port) => {
  *
  * @param  {...*} servers
  */
-const setupSocket = (...servers) => {
+const setupSocket = (subdomainOffset, ...servers) => {
   // https://socket.io/docs/v4/middlewares/
   const wrap = (middleware) => (socket, next) =>
     middleware(socket.request, {}, next);
@@ -390,15 +394,29 @@ const setupSocket = (...servers) => {
     io.attach(server);
   }
 
-  //io.use(wrap(setTenant));
-  io.use(wrap(getSessionStore()));
-  io.use(wrap(passport.initialize()));
-  io.use(wrap(passport.authenticate(["jwt", "session"])));
+  const passportInit = passport.initialize();
+  const sessionStore = getSessionStore();
+  const setupNamespace = (namespace) => {
+    //io.of(namespace).use(wrap(setTenant));
+    io.of(namespace).use(wrap(sessionStore));
+    io.of(namespace).use(wrap(passportInit));
+    io.of(namespace).use(wrap(passport.authenticate(["jwt", "session"])));
+  };
+  setupNamespace("/");
+  setupNamespace("/datastream");
   if (process.send && !cluster.isMaster) io.adapter(createAdapter());
   getState().setRoomEmitter((tenant, viewname, room_id, msg) => {
-    io.to(`${tenant}_${viewname}_${room_id}`).emit("message", msg);
+    io.of("/").to(`${tenant}_${viewname}_${room_id}`).emit("message", msg);
   });
-  io.on("connection", (socket) => {
+
+  getState().setLogEmitter((tenant, level, msg) => {
+    const time = new Date().valueOf();
+    io.of("/")
+      .to(`_logs_${tenant}_`)
+      .emit("log_msg", { text: msg, time, level });
+  });
+
+  io.of("/").on("connection", (socket) => {
     socket.on("join_room", ([viewname, room_id]) => {
       const ten = get_tenant_from_req(socket.request) || "public";
       const f = () => {
@@ -418,5 +436,154 @@ const setupSocket = (...servers) => {
       if (ten && ten !== "public") db.runWithTenant(ten, f);
       else f();
     });
+
+    socket.on("join_log_room", async (callback) => {
+      const tenant =
+        get_tenant_from_req(socket.request, subdomainOffset) || "public";
+      const f = async () => {
+        try {
+          const user = socket.request.user;
+          if (!user || user.role_id !== 1) throw new Error("Not authorized");
+          else {
+            socket.join(`_logs_${tenant}_`);
+            const socketIds = await getState().getConfig(
+              "joined_log_socket_ids"
+            );
+            socketIds.push(socket.id);
+            await getState().setConfig("joined_log_socket_ids", [...socketIds]);
+            callback({ status: "ok" });
+          }
+        } catch (err) {
+          getState().log(1, `Socket join_logs stream: ${err.stack}`);
+          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";
+      const f = async () => {
+        const socketIds = await getState().getConfig("joined_log_socket_ids");
+        const newSocketIds = socketIds.filter((id) => id !== socket.id);
+        await getState().setConfig("joined_log_socket_ids", newSocketIds);
+      };
+      if (tenant && tenant !== "public") db.runWithTenant(tenant, f);
+      else f();
+    });
+  });
+
+  io.of("/datastream").on("connection", (socket) => {
+    let dataStream = null;
+    let dataTarget = null;
+    socket.on(
+      "open_data_stream",
+      async ([viewName, id, fieldName, fieldView, targetOpts], callback) => {
+        const tenant =
+          get_tenant_from_req(socket.request, subdomainOffset) || "public";
+        const f = async () => {
+          try {
+            const user = socket.request.user;
+            const view = View.findOne({ name: viewName });
+            if (view.viewtemplateObj.authorizeDataStream) {
+              const authorized = await view.viewtemplateObj.authorizeDataStream(
+                view,
+                id,
+                fieldName,
+                user,
+                targetOpts
+              );
+              if (!authorized) throw new Error("Not authorized");
+            }
+            const { stream, target } = await view.openDataStream(
+              id,
+              fieldName,
+              fieldView,
+              user,
+              targetOpts
+            );
+            dataStream = stream;
+            dataTarget = target;
+            getState().log(
+              5,
+              `opened data stram to: ${JSON.stringify(dataTarget)}`
+            );
+            callback({ status: "ok", target });
+          } catch (err) {
+            getState().log(
+              1,
+              `Socket open_data_stream: ${err.message || "unknown error"}`
+            );
+            callback({ status: "error", msg: err.message || "unknown error" });
+          }
+        };
+        if (tenant && tenant !== "public") db.runWithTenant(tenant, f);
+        else f();
+      }
+    );
+    socket.on("write_to_stream", async (data, callback) => {
+      if (!dataStream) {
+        getState().log(1, "Socket write_to_stream: No stream available");
+        callback({ status: "error", msg: "No stream available" });
+      } else
+        dataStream.write(data, (err) => {
+          if (err) {
+            getState().log(1, "Socket write_to_stream: No stream available");
+            callback({ status: "error", msg: err.message || "unknown error" });
+          } else callback({ status: "ok" });
+        });
+    });
+
+    socket.on("close_data_stream", async (callback) => {
+      if (!dataStream) {
+        getState().log(1, "Socket close_data_stream: No stream available");
+        callback({ status: "error", msg: "No stream available" });
+      } else {
+        dataStream.close((err) => {
+          if (err) {
+            getState().log(
+              1,
+              `Socket close_data_stream: ${err.message || "unknown error"}`
+            );
+            callback({ status: "error", msg: err.message || "unknown error" });
+          } else {
+            getState().log(
+              5,
+              `closed data stram of: ${JSON.stringify(dataTarget)}`
+            );
+            callback({ status: "ok" });
+            dataStream = null;
+          }
+        });
+      }
+    });
+
+    socket.on("disconnect", async () => {
+      const tenant =
+        get_tenant_from_req(socket.request, subdomainOffset) || "public";
+      const f = async () => {
+        if (dataStream)
+          dataStream.close((err) => {
+            if (err) {
+              getState().log(
+                1,
+                `Socket disconnect close_data_stream: ${
+                  err.message || "unknown error"
+                }`
+              );
+            } else {
+              getState().log(
+                5,
+                `closed data stram of: ${JSON.stringify(dataTarget)}`
+              );
+              dataStream = null;
+            }
+          });
+      };
+      if (tenant && tenant !== "public") db.runWithTenant(tenant, f);
+      else f();
+    });
   });
 };