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

package/help/Extra state formula.tmd

@@ -1,5 +1,5 @@
 {{# const srcTable = Table.findOne({ name: query.srcTable }) }}
-{{# const view = View.findOne({ name: query.view_name }) }}
+{{# const view = View.findOne({ name: query.view_name || query.view }) }}
 {{# const destTable = Table.findOne({ id: view.table_id }) }}
 
 The extra state formula when embedding or linking to a view is used

package/help/Group by formula.tmd

@@ -0,0 +1,15 @@
+The Group by formula allows you specify group headings. The formula should evaluate to a value, which will be used as the group header.
+
+For example, if you have a String field `Category` with options "Home", "Work", "Sports", you can use this as the group by formula:
+
+`category`
+
+Or, if you want to have Even and Odd headings based on the ID:
+
+`id % 2 ? "Odd" : "Even"`
+
+You can also use join fields to group based on a related table, for instance:
+
+`departmentⱵname`
+
+If a user is logged in, the `user` variable can be used to access user fields, such as `user?.department`.

package/help/JavaScript action code.tmd

@@ -212,6 +212,10 @@ Use `emit_to_client' to send socket.io events to one or multiple clients. For ex
 ```
 emit_to_client({notify: "hello admin"}, 1);
 ```
-This event goes to each tab (and window) where the user is logged in. Otherwise, you can use an array or omit the second parameter to emit to default to the originating user. All return directives from the block above can be used.
+This event goes to each tab (and window) where the user is logged in. You can pass an array of user IDs, omit the second parameter to default to the originating user, or pass `null` to emit only to public (unauthenticated) users:
+```
+emit_to_client({notify: "hello public"}, null);
+```
+All return directives from the block above can be used.
 
 Include the constant `page_load_tag` in the object to only appear on the originating tab, for instance: `emit_to_client({notify: "Hello", page_load_tag})`.

package/load_plugins.js

@@ -1,402 +1,11 @@
-/**
- * Load plugins
- * File: load_plugins.js
- *
- * @category server
- * @module load_plugins
- */
-const db = require("@saltcorn/data/db");
-const { getState, getRootState } = require("@saltcorn/data/db/state");
 const Plugin = require("@saltcorn/data/models/plugin");
-const { isRoot, getFetchProxyOptions } = require("@saltcorn/data/utils");
-const { eachTenant } = require("@saltcorn/admin-models/models/tenant");
-
-const PluginInstaller = require("@saltcorn/plugins-loader/plugin_installer");
-const npmFetch = require("npm-registry-fetch");
-const packagejson = require("./package.json");
-const {
-  supportedVersion,
-  resolveLatest,
-} = require("@saltcorn/plugins-loader/stable_versioning");
-const path = require("path");
-const isFixedPlugin = (plugin) =>
-  plugin.location === "@saltcorn/sbadmin2" ||
-  plugin.location === "@saltcorn/base-plugin";
-
-/**
- * return the cached engine infos or fetch them from npm and update the cache
- * @param plugin plugin to load
- */
-const getEngineInfos = async (plugin, forceFetch) => {
-  const cached = getRootState().getConfig("engines_cache", {}) || {};
-  const airgap = getState().getConfig("airgap", false);
-
-  if (airgap || (cached[plugin.location] && !forceFetch)) {
-    return cached[plugin.location] || {};
-  } else {
-    getState().log(5, `Fetching versions for '${plugin.location}'`);
-    const pkgInfo = await npmFetch.json(
-      `https://registry.npmjs.org/${plugin.location}`,
-      getFetchProxyOptions()
-    );
-    const versions = pkgInfo.versions;
-    const newCached = {};
-    for (const [k, v] of Object.entries(versions)) {
-      newCached[k] = v.engines?.saltcorn
-        ? { engines: { saltcorn: v.engines.saltcorn } }
-        : {};
-    }
-    cached[plugin.location] = newCached;
-    await getRootState().setConfig("engines_cache", { ...cached });
-    return newCached;
-  }
-};
-
-/**
- * checks the saltcorn engine property and changes the plugin version if necessary
- * @param plugin plugin to load
- */
-const ensurePluginSupport = async (plugin, forceFetch) => {
-  let versions = await getEngineInfos(plugin, forceFetch);
-  if (
-    plugin.version &&
-    plugin.version !== "latest" &&
-    !versions[plugin.version] &&
-    !forceFetch
-  ) {
-    versions = await getEngineInfos(plugin, true);
-  }
-  const supported = supportedVersion(
-    plugin.version || "latest",
-    versions,
-    packagejson.version
-  );
-  if (!supported) {
-    if (getState().getConfig("airgap", false))
-      getState().log(
-        5,
-        `Warning: No supported version for '${plugin.location}' in airgap mode"}`
-      );
-    else
-      throw new Error(
-        `Unable to find a supported version for '${plugin.location}'`
-      );
-  } else if (
-    supported !== plugin.version ||
-    (plugin.version === "latest" && supported !== resolveLatest(versions))
-  )
-    plugin.version = supported;
-};
-
-/**
- * Load one plugin
- * TODO correct names for functions loadPlugin, requirePlugin - currently uncler
- * @param plugin - plugin to load
- * @param force - force flag
- */
-const loadPlugin = async (plugin, force, forceFetch, reloadModule = false) => {
-  if (plugin.source === "npm" && !isFixedPlugin(plugin)) {
-    try {
-      await ensurePluginSupport(plugin, forceFetch);
-    } catch (e) {
-      console.log(
-        `Warning: Unable to find a supported version for '${plugin.location}' Continuing with the installed version`
-      );
-    }
-  }
-
-  const airgap = getState().getConfig("airgap", false);
-  if (airgap && !Plugin.is_fixed_plugin(plugin.location))
-    ensureAirgapedVersion(
-      plugin,
-      getRootState().getConfig("pre_installed_module_infos", [])
-    );
-
-  // load plugin
-  const loader = new PluginInstaller(plugin, {
-    scVersion: packagejson.version,
-    envVars: { PUPPETEER_SKIP_DOWNLOAD: true },
-    reloadModule,
-    force,
-  });
-  const res = await loader.install();
-  const configuration =
-    typeof plugin.configuration === "string"
-      ? JSON.parse(plugin.configuration)
-      : plugin.configuration;
-  try {
-    // register plugin
-    getState().registerPlugin(
-      res.plugin_module.plugin_name || plugin.name,
-      res.plugin_module,
-      configuration,
-      res.location,
-      res.name
-    );
-  } catch (error) {
-    getState().log(
-      3,
-      `Error loading plugin ${plugin.name}: ${error.message || error}`
-    );
-    if (force) {
-      // remove the install dir and try again
-      await loader.remove();
-      await loader.install();
-      getState().registerPlugin(
-        res.plugin_module.plugin_name || plugin.name,
-        res.plugin_module,
-        configuration,
-        res.location,
-        res.name
-      );
-    }
-  }
-  if (res.plugin_module.user_config_form)
-    await getState().refresh_userlayouts();
-  if (res.plugin_module.onLoad) {
-    try {
-      await res.plugin_module.onLoad(plugin.configuration);
-    } catch (error) {
-      console.error(error); // todo i think that situation is not resolved
-    }
-  }
-
-  if (isRoot() && res.plugin_module.authentication)
-    await eachTenant(reloadAuthFromRoot);
-  return res;
-};
-
-const reloadAuthFromRoot = () => {
-  if (isRoot()) return;
-  const rootState = getRootState();
-  const tenantState = getState();
-  if (!rootState || !tenantState || rootState === tenantState) return;
-  tenantState.auth_methods = {};
-  for (const [k, v] of Object.entries(rootState.auth_methods)) {
-    if (v.shareWithTenants) tenantState.auth_methods[k] = v;
-  }
-};
-
-/**
- * Install plugin
- * @param plugin - plugin name
- * @param force - force flag
- * @returns {Promise<{plugin_module: *}|{plugin_module: any}>}
- */
-const requirePlugin = async (plugin, force) => {
-  const airgap = getState().getConfig("airgap", false);
-  if (airgap && !Plugin.is_fixed_plugin(plugin.location))
-    ensureAirgapedVersion(
-      plugin,
-      getRootState().getConfig("pre_installed_module_infos", [])
-    );
-
-  const loader = new PluginInstaller(plugin, {
-    scVersion: packagejson.version,
-    envVars: { PUPPETEER_SKIP_DOWNLOAD: true },
-    force: force,
-  });
-  return await loader.install();
-};
-
-/**
- * When the databse has another plugin version then don't override the pr-installed module
- * @param {Plugin} plugin plugin from database
- * @param {any} airgapedStore json content from store_entries.json
- */
-const ensureAirgapedVersion = (plugin, airgapedStore) => {
-  const airgapedPlugin = airgapedStore.find(
-    (p) => p.location === plugin.location
-  );
-  if (!airgapedPlugin) {
-    throw new Error(
-      `Plugin ${plugin.name} from location ${plugin.location} not found in local airgapped store`
-    );
-  }
-  if (airgapedPlugin.version !== plugin.version) {
-    getState().log(
-      5,
-      `Overriding plugin ${plugin.name} version ${plugin.version} with airgapped store version ${airgapedPlugin.version}`
-    );
-    plugin.version = airgapedPlugin.version;
-  }
-};
-
-/**
- * Load all plugins
- * @returns {Promise<void>}
- */
-const loadAllPlugins = async (force, reloadModule = false) => {
-  await getState().refresh(true);
-  const plugins = await db.select("_sc_plugins");
-  for (const plugin of plugins) {
-    try {
-      await loadPlugin(plugin, force, undefined, reloadModule);
-    } catch (e) {
-      console.error(e);
-    }
-  }
-  await getState().refresh_userlayouts();
-  await getState().refresh(true, true);
-  if (!isRoot()) reloadAuthFromRoot();
-};
-
-/**
- * Load Plugin and its dependencies and save into local installation
- * @param plugin
- * @param force
- * @param noSignalOrDB
- * @param __ translation function
- * @param allowUnsafeOnTenantsWithoutConfigSetting
- * @param overwriteDependencies plugin dependencies to overwrite with local paths. Please only use this in testing (the force flag could cause trouble in multi process environments)
- * @returns {Promise<void>}
- */
-const loadAndSaveNewPlugin = async (
-  plugin,
-  force,
-  noSignalOrDB,
-  __ = (str) => str,
-  allowUnsafeOnTenantsWithoutConfigSetting,
-  overwriteDependencies
-) => {
-  const tenants_unsafe_plugins = getRootState().getConfig(
-    "tenants_unsafe_plugins",
-    false
-  );
-  if (!isRoot() && !tenants_unsafe_plugins) {
-    if (plugin.source !== "npm") {
-      console.error("\nWARNING: Skipping unsafe plugin ", plugin.name);
-      return;
-    }
-    //get allowed plugins
-
-    //refresh root store
-    await db.runWithTenant(
-      db.connectObj.default_schema,
-      async () => await Plugin.store_plugins_available()
-    );
-
-    const instore = getRootState().getConfig("available_plugins", []);
-    const safes = instore.filter((p) => !p.unsafe).map((p) => p.location);
-    if (
-      !safes.includes(plugin.location) &&
-      !allowUnsafeOnTenantsWithoutConfigSetting
-    ) {
-      console.error("\nWARNING: Skipping unsafe plugin ", plugin.name);
-      return;
-    }
-  }
-  const airgap = getState().getConfig("airgap", false);
-  if (plugin.source === "npm" && !airgap) await ensurePluginSupport(plugin);
-  if (airgap && !Plugin.is_fixed_plugin(plugin.location))
-    ensureAirgapedVersion(
-      plugin,
-      getRootState().getConfig("pre_installed_module_infos", [])
-    );
-
-  const loadMsgs = [];
-  const loader = new PluginInstaller(plugin, {
-    scVersion: packagejson.version,
-    envVars: { PUPPETEER_SKIP_DOWNLOAD: true },
-    force: force,
-  });
-  const { version, plugin_module, location, loadedWithReload, msgs } =
-    await loader.install();
-  if (msgs) loadMsgs.push(...msgs);
-  // install dependecies
-  for (const loc of plugin_module.dependencies || []) {
-    const overwrite = (overwriteDependencies || {})[loc];
-    if (overwrite) {
-      const pckJson = require(path.join(overwrite, "package.json"));
-      await loadAndSaveNewPlugin(
-        new Plugin({
-          name: pckJson.name,
-          location: overwrite,
-          source: "local",
-        }),
-        true,
-        noSignalOrDB
-      );
-    } else {
-      const existing = await Plugin.findOne({ location: loc });
-      if (!existing && loc !== plugin.location) {
-        await loadAndSaveNewPlugin(
-          new Plugin({
-            name: loc.replace("@saltcorn/", ""),
-            location: loc,
-            source: "npm",
-          }),
-          force,
-          noSignalOrDB
-        );
-      }
-    }
-  }
-  let registeredWithReload = false;
-  try {
-    getState().registerPlugin(
-      plugin_module.plugin_name || plugin.name,
-      plugin_module,
-      plugin.configuration,
-      location,
-      plugin.name
-    );
-  } catch (error) {
-    if (force) {
-      getState().log(
-        2,
-        `Error registering plugin ${plugin.name}. Removing and trying again.`
-      );
-      await loader.remove();
-      await loader.install();
-      getState().registerPlugin(
-        plugin_module.plugin_name || plugin.name,
-        plugin_module,
-        plugin.configuration,
-        location,
-        plugin.name
-      );
-      registeredWithReload = true;
-    } else {
-      throw error;
-    }
-  }
-  if (loadedWithReload || registeredWithReload) {
-    loadMsgs.push(
-      __(
-        "The plugin was corrupted and had to be repaired. We recommend restarting your server.",
-        plugin.name
-      )
-    );
-  }
-  if (plugin_module.onLoad) {
-    try {
-      await plugin_module.onLoad(plugin.configuration);
-    } catch (error) {
-      console.error(error);
-    }
-  }
-  if (version) plugin.version = version;
-
-  if (isRoot() && plugin_module.authentication)
-    await eachTenant(reloadAuthFromRoot);
-
-  if (!noSignalOrDB) {
-    await plugin.upsert();
-    getState().processSend({
-      installPlugin: plugin,
-      tenant: db.getTenantSchema(),
-      force: false, // okay ??
-    });
-  }
-  return loadMsgs;
-};
 
+/** @deprecated Import directly from @saltcorn/data/models/plugin (Plugin static methods) */
 module.exports = {
-  loadAndSaveNewPlugin,
-  loadAllPlugins,
-  loadPlugin,
-  requirePlugin,
-  getEngineInfos,
-  ensurePluginSupport,
+  loadAndSaveNewPlugin: Plugin.loadAndSaveNewPlugin,
+  loadAllPlugins: Plugin.loadAllPlugins,
+  loadPlugin: Plugin.loadPlugin,
+  requirePlugin: Plugin.requirePlugin,
+  getEngineInfos: Plugin.getEngineInfos,
+  ensurePluginSupport: Plugin.ensurePluginSupport,
 };