@saltcorn/server 0.9.4-beta.1 → 0.9.4-beta.11

package/routes/page_groupedit.js

@@ -29,9 +29,17 @@ const groupPropsForm = async (req, isNew) => {
     ...(isNew
       ? {}
       : {
-          onChange: `saveAndContinue(this, (res) => {
-  history.replaceState(null, '', res.responseJSON.row.name);
-});`,
+          onChange: `
+  saveAndContinue(this, (res) => {
+    history.replaceState(null, '', res.responseJSON.row.name);
+    const arrowsVisible = $('#upDownArrowsId').length > 0;
+    if (
+      arrowsVisible && res.responseJSON.row.random_allocation ||
+      !arrowsVisible && !res.responseJSON.row.random_allocation
+    ) {
+      window.location.reload();
+    }    
+  });`,
         }),
     noSubmitButton: !isNew,
     fields: [
@@ -68,65 +76,78 @@ const groupPropsForm = async (req, isNew) => {
         input_type: "select",
         options: roles.map((r) => ({ value: r.id, label: r.role })),
       },
+      {
+        name: "random_allocation",
+        label: req.__("Random allocation"),
+        type: "Bool",
+        sublabel: req.__(
+          "Serve a random page, ignoring the eligible formula. " +
+            "Within a session, reloads will always deliver the same page. " +
+            "This is a basic requirement for A/B testing."
+        ),
+      },
     ],
   });
 };
 
-const memberForm = async (action, req, groupName, pageValidator) => {
+const memberForm = async (action, req, group, pageValidator) => {
   const pageOptions = (await Page.find()).map((p) => p.name);
-  return new Form({
-    action,
-    fields: [
-      {
-        name: "page_name",
-        label: req.__("Page"),
-        sublabel: req.__("Page to be served"),
-        type: "String",
-        required: true,
-        validator: pageValidator,
-        attributes: {
-          options: pageOptions,
-        },
-      },
-      {
-        name: "description",
-        label: req.__("Description"),
-        type: "String",
-        sublabel: req.__("A description of the group member"),
+  const fields = [
+    {
+      name: "page_name",
+      label: req.__("Page"),
+      sublabel: req.__("Page to be served"),
+      type: "String",
+      required: true,
+      validator: pageValidator,
+      attributes: {
+        options: pageOptions,
       },
-      {
-        name: "eligible_formula",
-        label: req.__("Eligible Formula"),
-        sublabel:
-          req.__("Formula to determine if this page should be served.") +
-          br() +
-          span(
-            "Variables in scope: ",
-            [
-              "width",
-              "height",
-              "innerWidth",
-              "innerHeight",
-              "user",
-              "locale",
-              "device",
-            ]
-              .map((f) => code(f))
-              .join(", ")
-          ),
-        help: {
-          topic: "Eligible Formula",
-        },
-        type: "String",
-        required: true,
-        class: "validate-expression",
+    },
+    {
+      name: "description",
+      label: req.__("Description"),
+      type: "String",
+      sublabel: req.__("A description of the group member"),
+    },
+  ];
+  if (!group.random_allocation) {
+    fields.push({
+      name: "eligible_formula",
+      label: req.__("Eligible Formula"),
+      sublabel:
+        req.__("Formula to determine if this page should be served.") +
+        br() +
+        span(
+          "Variables in scope: ",
+          [
+            "width",
+            "height",
+            "innerWidth",
+            "innerHeight",
+            "user",
+            "locale",
+            "device",
+          ]
+            .map((f) => code(f))
+            .join(", ")
+        ),
+      help: {
+        topic: "Eligible Formula",
       },
-    ],
+      type: "String",
+      required: true,
+      class: "validate-expression",
+    });
+  }
+  return new Form({
+    action,
+    fields,
     additionalButtons: [
       {
         label: req.__("Cancel"),
         class: "btn btn-primary",
-        onclick: `cancelMemberEdit('${groupName}');`,
+        onclick: `cancelMemberEdit('${group.name}');`,
       },
     ],
   });
@@ -142,7 +163,7 @@ const editMemberForm = async (member, req) => {
   return await memberForm(
     `/page_groupedit/edit-member/${member.id}`,
     req,
-    group.name,
+    group,
     validator
   );
 };
@@ -156,7 +177,7 @@ const addMemberForm = async (group, req) => {
   return await memberForm(
     `/page_groupedit/add-member/${group.name}`,
     req,
-    group.name,
+    group,
     validator
   );
 };
@@ -224,7 +245,7 @@ const pageGroupMembers = async (pageGroup, req) => {
     if (members.length <= 1) return "";
     else
       return div(
-        { class: "container" },
+        { class: "container", id: "upDownArrowsId" },
         div(
           { class: "row" },
           div(
@@ -266,38 +287,38 @@ const pageGroupMembers = async (pageGroup, req) => {
         )
       );
   };
-
-  return mkTable(
-    [
-      {
-        label: req.__("Page"),
-        key: (r) =>
-          link(`/page/${pageIdToName[r.page_id]}`, pageIdToName[r.page_id]),
-      },
-      {
-        label: "",
-        key: (r) => upDownBtns(r, req),
-      },
-      {
-        label: req.__("Edit"),
-        key: (member) =>
-          link(`/page_groupedit/edit-member/${member.id}`, req.__("Edit")),
-      },
-      {
-        label: req.__("Delete"),
-        key: (member) =>
-          post_delete_btn(
-            `/page_groupedit/remove-member/${member.id}`,
-            req,
-            req.__("Member %s", member.sequence)
-          ),
-      },
-    ],
-    members,
+  const tblArr = [
+    {
+      label: req.__("Page"),
+      key: (r) =>
+        link(`/page/${pageIdToName[r.page_id]}`, pageIdToName[r.page_id]),
+    },
+  ];
+  if (!pageGroup.random_allocation) {
+    tblArr.push({
+      label: "",
+      key: (r) => upDownBtns(r, req),
+    });
+  }
+  tblArr.push(
     {
-      hover: true,
+      label: req.__("Edit"),
+      key: (member) =>
+        link(`/page_groupedit/edit-member/${member.id}`, req.__("Edit")),
+    },
+    {
+      label: req.__("Delete"),
+      key: (member) =>
+        post_delete_btn(
+          `/page_groupedit/remove-member/${member.id}`,
+          req,
+          req.__("Member %s", member.sequence)
+        ),
     }
   );
+  return mkTable(tblArr, members, {
+    hover: true,
+  });
 };
 
 /**

package/routes/pageedit.js

@@ -21,6 +21,8 @@ const { getViews, traverseSync } = require("@saltcorn/data/models/layout");
 const { add_to_menu } = require("@saltcorn/admin-models/models/pack");
 const db = require("@saltcorn/data/db");
 const { getPageList, getPageGroupList } = require("./common_lists");
+const TagEntry = require("@saltcorn/data/models/tag_entry");
+const Tag = require("@saltcorn/data/models/tag");
 
 const {
   isAdmin,
@@ -293,7 +295,18 @@ router.get(
   "/",
   isAdmin,
   error_catcher(async (req, res) => {
-    const pages = await Page.find({}, { orderBy: "name", nocase: true });
+    const pageq = {};
+    let filterOnTag;
+
+    if (req.query._tag) {
+      const tagEntries = await TagEntry.find({
+        tag_id: +req.query._tag,
+        not: { page_id: null },
+      });
+      pageq.id = { in: tagEntries.map((te) => te.page_id).filter(Boolean) };
+      filterOnTag = await Tag.findOne({ id: +req.query._tag });
+    }
+    const pages = await Page.find(pageq, { orderBy: "name", nocase: true });
     const pageGroups = await PageGroup.find(
       {},
       { orderBy: "name", nocase: true }
@@ -311,7 +324,7 @@ router.get(
           title: req.__("Your pages"),
           class: "mt-0",
           contents: div(
-            getPageList(pages, roles, req),
+            await getPageList(pages, roles, req, { filterOnTag }),
             a(
               {
                 href: `/pageedit/new`,
@@ -370,7 +383,7 @@ const wrap = (contents, noCard, req, page) => ({
       crumbs: [
         { text: req.__("Pages"), href: "/pageedit" },
         page
-          ? { href: `/page/${page.name}`, text: page.name }
+          ? { href: `/page/${encodeURIComponent(page.name)}`, text: page.name }
           : { text: req.__("New") },
       ],
     },
@@ -677,9 +690,11 @@ router.post(
 
     if (id && req.body.layout) {
       await Page.update(+id, { layout: req.body.layout });
-      res.json({ success: "ok" });
+      res.json({
+        success: "ok",
+      });
     } else {
-      res.json({ error: "no page or no layout." });
+      res.json({ error: req.__("Unable to save: No page or no layout") });
     }
   })
 );

package/routes/tables.js

@@ -13,6 +13,7 @@ const View = require("@saltcorn/data/models/view");
 const User = require("@saltcorn/data/models/user");
 const Model = require("@saltcorn/data/models/model");
 const Trigger = require("@saltcorn/data/models/trigger");
+const TagEntry = require("@saltcorn/data/models/tag_entry");
 const {
   mkTable,
   renderForm,
@@ -59,10 +60,12 @@ const { tablesList, viewsList } = require("./common_lists");
 const {
   InvalidConfiguration,
   removeAllWhiteSpace,
+  comparingCaseInsensitive,
 } = require("@saltcorn/data/utils");
 const { EOL } = require("os");
 
 const path = require("path");
+const Tag = require("@saltcorn/data/models/tag");
 /**
  * @type {object}
  * @const
@@ -714,6 +717,7 @@ router.get(
       ...new Set(child_relations.map(({ table }) => table.name)),
     ];
     const triggers = table.id ? Trigger.find({ table_id: table.id }) : [];
+    triggers.sort(comparingCaseInsensitive("name"));
     let fieldCard;
     if (fields.length === 0) {
       fieldCard = [
@@ -785,7 +789,16 @@ router.get(
         triggers.length
           ? req.__("Table triggers: ") +
             triggers
-              .map((t) => link(`/actions/configure/${t.id}`, t.name))
+              .map((t) =>
+                link(
+                  `/actions/configure/${
+                    t.id
+                  }?on_done_redirect=${encodeURIComponent(
+                    `table/${table.name}`
+                  )}`,
+                  t.name
+                )
+              )
               .join(", ") +
             "<br>"
           : "",
@@ -1211,13 +1224,23 @@ router.get(
   "/",
   isAdmin,
   error_catcher(async (req, res) => {
-    const rows = await Table.find_with_external(
-      {},
-      { orderBy: "name", nocase: true }
-    );
+    const tblq = {};
+    let filterOnTag;
+    if (req.query._tag) {
+      const tagEntries = await TagEntry.find({
+        tag_id: +req.query._tag,
+        not: { table_id: null },
+      });
+      tblq.id = { in: tagEntries.map((te) => te.table_id).filter(Boolean) };
+      filterOnTag = await Tag.findOne({ id: +req.query._tag });
+    }
+    const rows = await Table.find_with_external(tblq, {
+      orderBy: "name",
+      nocase: true,
+    });
     const roles = await User.get_roles();
     const getRole = (rid) => roles.find((r) => r.id === rid).role;
-    const mainCard = await tablesList(rows, req);
+    const mainCard = await tablesList(rows, req, { filterOnTag });
     const createCard = div(
       a(
         { href: `/table/new`, class: "btn btn-primary mt-1 me-3" },

package/routes/tag_entries.js

@@ -5,6 +5,7 @@ const {
   select,
   option,
   label,
+  text,
 } = require("@saltcorn/markup/tags");
 
 const Tag = require("@saltcorn/data/models/tag");
@@ -94,15 +95,21 @@ router.get(
   isAdmin,
   error_catcher(async (req, res) => {
     const { entry_type, tag_id } = req.params;
-    res.sendWrap(req.__("Add %s to tag"), {
+    const tag = await Tag.findOne({ id: tag_id });
+
+    res.sendWrap(req.__("Add %s to tag %s", entry_type, tag.name), {
       above: [
         {
           type: "breadcrumbs",
-          crumbs: [{ text: req.__(`Tag entry`) }],
+          crumbs: [
+            { text: req.__(`Tags`), href: "/tag" },
+            { text: tag.name, href: `/tag/${tag.id}` },
+            { text: req.__(`Add %s`, text(entry_type)) },
+          ],
         },
         {
           type: "card",
-          title: req.__(`Add entries to tag`),
+          title: req.__(`Add entries to tag %s`, tag.name),
           contents: buildForm(
             entry_type,
             tag_id,
@@ -148,9 +155,10 @@ router.post(
       req.flash("error", req.__("Please select at least one item"));
       return res.redirect(`/tag-entries/add/${entry_type}/${tag_id}`);
     }
+    const ids_array = Array.isArray(ids) ? ids : [ids];
     const fieldName = idField(entry_type);
     const tag = await Tag.findOne({ id: tag_id });
-    for (const id of ids) {
+    for (const id of ids_array) {
       await tag.addEntry({ [fieldName]: id });
     }
     res.redirect(`/tag/${tag_id}?show_list=${entry_type}`);

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,10 @@ 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 router = new Router();
 module.exports = router;
 
@@ -42,7 +47,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 +62,7 @@ router.get(
           a(
             {
               href: `/tag/new`,
-              class: "btn btn-primary",
+              class: "btn btn-primary mt-3",
             },
             req.__("Create tag")
           ),
@@ -73,6 +78,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 +109,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 +138,8 @@ const headerWithCollapser = (title, cardId, showList) =>
       "aria-controls": cardId,
       role: "button",
     },
-    title
+    title,
+    ` (${count})`
   );
 
 const isShowList = (showList, listType) => showList === listType;
@@ -139,14 +171,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 +201,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 +224,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 +248,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 +266,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();
@@ -505,6 +508,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 +542,5 @@ module.exports = {
   sendHtmlFile,
   setRole,
   getEligiblePage,
+  getRandomPage,
 };

package/routes/view.js

@@ -71,10 +71,14 @@ router.get(
     const isModal = req.headers?.saltcornmodalrequest;
 
     const contents0 = await view.run_possibly_on_page(query, req, res);
-    const title =
+    let title =
       isModal && view.attributes?.popup_title
         ? view.attributes?.popup_title
-        : scan_for_page_title(contents0, view.name);
+        : view.attributes?.page_title ||
+          scan_for_page_title(contents0, view.name); //legacy
+    if ((title || "").includes("{{")) {
+      title = await view.interpolate_title_string(title, query);
+    }
     if (isModal && view.attributes?.popup_width)
       res.set(
         "SaltcornModalWidth",
@@ -82,10 +86,24 @@ 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 = { title, description };
+    }
     const tock = new Date();
     const ms = tock.getTime() - tic.getTime();
     if (!isTest())