@saltcorn/mobile-app 1.1.0-beta.9 → 1.1.0

package/src/init.js

@@ -0,0 +1,424 @@
+/*global saltcorn */
+
+import {
+  startOfflineMode,
+  networkChangeCallback,
+  sync,
+  getLastOfflineSession,
+} from "./helpers/offline_mode.js";
+import {
+  updateScPlugins,
+  createSyncInfoTables,
+  dbUpdateNeeded,
+  updateDb,
+  getTableIds,
+  createJwtTable,
+} from "./helpers/db_schema.js";
+import { publicLogin, checkJWT } from "./helpers/auth.js";
+import { router } from "./routing/index.js";
+import {
+  replaceIframe,
+  clearHistory,
+  gotoEntryView,
+  addRoute,
+} from "./helpers/navigation.js";
+
+import i18next from "i18next";
+import i18nextSprintfPostProcessor from "i18next-sprintf-postprocessor";
+import { jwtDecode } from "jwt-decode";
+
+import { Network } from "@capacitor/network";
+
+async function addScript(scriptObj) {
+  let waited = 0;
+  const maxWait = 3000;
+
+  const moduleAvailable = () =>
+    window.saltcorn && window.saltcorn[scriptObj.name];
+
+  return new Promise((resolve, reject) => {
+    let script = document.createElement("script");
+    document.head.appendChild(script);
+
+    const waitForModule = () => {
+      waited += 100;
+      if (waited >= maxWait)
+        return reject(`unable to load '${scriptObj.name}'`);
+      console.log("waiting for " + scriptObj.name);
+      setTimeout(function () {
+        if (moduleAvailable()) return resolve();
+        else waitForModule();
+      }, 100);
+    };
+
+    script.onload = () => {
+      if (!scriptObj.name || moduleAvailable()) return resolve();
+      waitForModule();
+    };
+    script.src = scriptObj.src;
+  });
+}
+
+async function loadPlugin(plugin) {
+  await addScript({
+    src: `js/bundle/${plugin.name}.bundle.js`,
+    name: plugin.name,
+  });
+}
+
+async function loadPlugins(state) {
+  const plugins = (await saltcorn.data.models.Plugin.find()).filter(
+    (plugin) => !["base", "sbadmin2"].includes(plugin.name)
+  );
+  for (const plugin of plugins) {
+    await loadPlugin(plugin);
+    state.registerPlugin(
+      plugin.name,
+      saltcorn[plugin.name],
+      plugin.configuration
+    );
+  }
+  return plugins;
+}
+
+/**
+ * add <script> tags dynamically
+ */
+async function addScripts(version_tag) {
+  const scripts = [
+    { src: `static_assets/${version_tag}/jquery-3.6.0.min.js` },
+    { src: "js/bundle/common_chunks.bundle.js" },
+    { src: "js/bundle/markup.bundle.js", name: "markup" },
+    { src: "js/bundle/data.bundle.js", name: "data" },
+    { src: "js/bundle/base_plugin.bundle.js", name: "base_plugin" },
+    { src: "js/bundle/sbadmin2.bundle.js", name: "sbadmin2" },
+  ];
+  for (const script of scripts) {
+    await addScript(script);
+  }
+}
+
+const prepareHeader = (header) => {
+  let result = Object.assign({}, header);
+  const replacer = (key) => {
+    const value = header[key];
+    if (value?.startsWith("/plugins") || value?.startsWith("plugins"))
+      result[key] = value.replace(/^\/?plugins/, "sc_plugins");
+  };
+  replacer("script");
+  replacer("css");
+  return result;
+};
+
+/*
+  A plugin exports headers either as array, as key values object, or
+  as a function with a configuration parameter that returns an Array.
+*/
+const collectPluginHeaders = (pluginRows) => {
+  const config = saltcorn.data.state.getState().mobileConfig;
+  config.pluginHeaders = [];
+  for (const row of pluginRows) {
+    const pluginHeaders = saltcorn[row.name].headers;
+    if (pluginHeaders) {
+      if (Array.isArray(pluginHeaders))
+        for (const header of pluginHeaders) {
+          config.pluginHeaders.push(prepareHeader(header));
+        }
+      else if (typeof pluginHeaders === "function") {
+        const headerResult = pluginHeaders(row.configuration || {});
+        if (Array.isArray(headerResult)) {
+          for (const header of headerResult)
+            config.pluginHeaders.push(prepareHeader(header));
+        }
+      } else
+        for (const value of Object.values(pluginHeaders)) {
+          config.pluginHeaders.push(prepareHeader(value));
+        }
+    }
+  }
+};
+
+const getJwt = async () => {
+  const rows = await saltcorn.data.db.select("jwt_table");
+  return rows?.length > 0 ? rows[0].jwt : null;
+};
+
+const initJwt = async () => {
+  if (!(await saltcorn.data.db.tableExists("jwt_table"))) {
+    await createJwtTable();
+  } else {
+    const jwt = await getJwt();
+    if (jwt) {
+      const state = saltcorn.data.state.getState();
+      state.mobileConfig.jwt = jwt;
+    }
+  }
+};
+
+const initI18Next = async (allLanguages) => {
+  await i18next.use(i18nextSprintfPostProcessor).init({
+    lng: "en",
+    allLanguages,
+  });
+};
+
+const showErrorPage = async (error) => {
+  const state = saltcorn.data.state.getState();
+  state.mobileConfig.inErrorState = true;
+  const page = await router.resolve({
+    pathname: "get/error_page",
+    fullWrap: true,
+    alerts: [
+      {
+        type: "error",
+        msg: error.message ? error.message : "An error occured.",
+      },
+    ],
+  });
+  await replaceIframe(page.content);
+};
+
+// the app comes back from background
+const onResume = async () => {
+  if (typeof saltcorn === "undefined") return;
+  const mobileConfig = saltcorn.data.state.getState().mobileConfig;
+  if (mobileConfig?.allowOfflineMode) {
+    const netStatus = await Network.getStatus();
+    mobileConfig.networkState = netStatus.connectionType;
+    if (
+      mobileConfig.networkState === "none" &&
+      !mobileConfig.isOfflineMode &&
+      mobileConfig.jwt
+    ) {
+      try {
+        await startOfflineMode();
+        clearHistory();
+        if (mobileConfig.user?.id) await gotoEntryView();
+        else {
+          const decodedJwt = jwtDecode(mobileConfig.jwt);
+          mobileConfig.user = decodedJwt.user;
+          mobileConfig.isPublicUser = false;
+        }
+        addRoute({ route: mobileConfig.entry_point, query: undefined });
+        const page = await router.resolve({
+          pathname: mobileConfig.entry_point,
+          fullWrap: true,
+          alerts: [],
+        });
+      } catch (error) {
+        await showErrorPage(error);
+      }
+    }
+  }
+};
+
+const isPublicJwt = (jwt) => {
+  try {
+    if (!jwt) return false;
+    const decoded = jwtDecode(jwt);
+    return decoded.sub === "public";
+  } catch (error) {
+    console.log(
+      `Unable to inspect '${jwt}': ${
+        error.message ? error.message : "Unknown error"
+      }`
+    );
+    return false;
+  }
+};
+
+const isPublicEntryPoint = async (entryPoint) => {
+  try {
+    const tokens = entryPoint.split("/");
+    if (tokens.length < 3) throw new Error("The format is incorrect");
+    const name = tokens[tokens.length - 1];
+    const entryObj =
+      tokens[tokens.length - 2] === "view"
+        ? saltcorn.data.models.View.findOne({ name: name })
+        : saltcorn.data.models.Page.findOne({ name: name });
+    if (!entryObj) throw new Error(`The object '${name}' does not exist`);
+    else return entryObj.min_role === 100;
+  } catch (error) {
+    console.log(
+      `Unable to inspect '${entryPoint}': ${
+        error.message ? error.message : "Unknown error"
+      }`
+    );
+    return false;
+  }
+};
+
+const showLogin = async (alerts) => {
+  const page = await router.resolve({
+    pathname: "get/auth/login",
+    alerts,
+  });
+  await replaceIframe(page.content);
+};
+
+const takeLastLocation = () => {
+  let result = null;
+  const lastLocation = localStorage.getItem("lastLocation");
+  localStorage.removeItem("lastLocation");
+  if (lastLocation) {
+    try {
+      result = JSON.parse(lastLocation);
+    } catch (error) {
+      console.log(
+        `Unable to parse the last location: ${
+          error.message ? error.message : "Unknown error"
+        }`
+      );
+    }
+  }
+  return result;
+};
+
+// device is ready
+export async function init({
+  mobileConfig,
+  tablesSchema,
+  schemaCreatedAt,
+  translations,
+  siteLogo,
+}) {
+  try {
+    const lastLocation = takeLastLocation();
+    document.addEventListener("resume", onResume, false);
+    const { created_at } = schemaCreatedAt;
+    await addScripts(mobileConfig.version_tag);
+    saltcorn.data.db.connectObj.version_tag = mobileConfig.version_tag;
+
+    await saltcorn.data.db.init();
+    const updateNeeded = await dbUpdateNeeded(created_at);
+    if (updateNeeded) {
+      // update '_sc_plugins' first because of loadPlugins()
+      await updateScPlugins(tablesSchema);
+    }
+    const state = saltcorn.data.state.getState();
+    state.mobileConfig = mobileConfig;
+    state.mobileConfig.user = {};
+    state.registerPlugin("base", saltcorn.base_plugin);
+    state.registerPlugin("sbadmin2", saltcorn.sbadmin2);
+    collectPluginHeaders(await loadPlugins(state));
+    if (updateNeeded) await updateDb(tablesSchema);
+    await createSyncInfoTables(mobileConfig.synchedTables);
+    await initJwt();
+    await state.refresh_tables();
+    await state.refresh_views();
+    await state.refresh_pages();
+    await state.refresh_page_groups();
+    await state.refresh_triggers();
+    state.mobileConfig.localTableIds = await getTableIds(
+      mobileConfig.localUserTables
+    );
+    await state.setConfig("base_url", mobileConfig.server_path);
+    const entryPoint = mobileConfig.entry_point;
+    await initI18Next(translations);
+    state.mobileConfig.encodedSiteLogo = siteLogo;
+
+    state.mobileConfig.networkState = await Network.getStatus();
+    Network.addListener("networkStatusChange", networkChangeCallback);
+    const networkDisabled = state.mobileConfig.networkState === "none";
+    const jwt = state.mobileConfig.jwt;
+    const alerts = [];
+    if ((networkDisabled && jwt) || (await checkJWT(jwt))) {
+      const mobileConfig = state.mobileConfig;
+      const decodedJwt = jwtDecode(mobileConfig.jwt);
+      mobileConfig.user = decodedJwt.user;
+      mobileConfig.isPublicUser = false;
+      await i18next.changeLanguage(mobileConfig.user.language);
+      if (mobileConfig.allowOfflineMode) {
+        const { offlineUser } = (await getLastOfflineSession()) || {};
+        if (networkDisabled) {
+          if (offlineUser && offlineUser !== mobileConfig.user.email)
+            throw new Error(
+              `The offline mode is not available, '${offlineUser}' has not yet uploaded offline data.`
+            );
+          else
+            try {
+              await startOfflineMode();
+            } catch (error) {
+              throw new Error(
+                `Neither an internet connection nor the offline mode are available: ${
+                  error.message ? error.message : "Unknown error"
+                }`
+              );
+            }
+        } else if (offlineUser) {
+          if (offlineUser === mobileConfig.user.email) {
+            await sync();
+            alerts.push({
+              type: "info",
+              msg: "Synchronized your offline data.",
+            });
+          } else
+            alerts.push({
+              type: "warning",
+              msg: `'${offlineUser}' has not yet uploaded offline data.`,
+            });
+        } else {
+          await sync();
+          alerts.push({
+            type: "info",
+            msg: "Synchronized your offline data.",
+          });
+        }
+      }
+      let page = null;
+      if (!lastLocation) {
+        addRoute({ route: entryPoint, query: undefined });
+        page = await router.resolve({
+          pathname: entryPoint,
+          fullWrap: true,
+          alerts,
+        });
+      } else {
+        addRoute({
+          route: lastLocation.route,
+          query: lastLocation.query,
+        });
+        page = await router.resolve({
+          pathname: lastLocation.route,
+          query: lastLocation.query,
+          fullWrap: true,
+          alerts,
+        });
+      }
+      if (page.content) await replaceIframe(page.content, page.isFile);
+    } else if (isPublicJwt(jwt)) {
+      const config = state.mobileConfig;
+      config.user = { role_id: 100, email: "public", language: "en" };
+      config.isPublicUser = true;
+      i18next.changeLanguage(config.user.language);
+      addRoute({ route: entryPoint, query: undefined });
+      const page = await router.resolve({
+        pathname: entryPoint,
+        fullWrap: true,
+        alerts,
+      });
+      if (page.content) await replaceIframe(page.content, page.isFile);
+    } else if (
+      (await isPublicEntryPoint(entryPoint)) &&
+      state.mobileConfig.autoPublicLogin
+    ) {
+      if (networkDisabled)
+        throw new Error(
+          "No internet connection or previous login is available. " +
+            "Please go online and reload, the public login is not yet supported."
+        );
+      await publicLogin(entryPoint);
+    } else await showLogin(alerts);
+  } catch (error) {
+    if (typeof saltcorn === "undefined" || typeof router === "undefined") {
+      const msg = `An error occured: ${
+        error.message ? error.message : "Unknown error"
+      }`;
+      console.log(msg);
+      alert(msg);
+    } else {
+      if (error.httpCode === 401) await showLogin([]);
+      else await showErrorPage(error);
+    }
+  }
+}

package/src/routing/index.js

@@ -0,0 +1,98 @@
+import UniversalRouter from "universal-router";
+
+import { updateTableRow, insertTableRow } from "./routes/api";
+import { getLoginView, logoutAction, getSignupView } from "./routes/auth";
+import { deleteRows } from "./routes/delete";
+import { postToggleField } from "./routes/edit";
+import { getErrorView } from "./routes/error";
+import { postShowCalculated } from "./routes/fields";
+import { postPageAction, getPage } from "./routes/page";
+import {
+  getSyncSettingsView,
+  getAskDeleteOfflineData,
+  getAskUploadNotEnded,
+} from "./routes/sync";
+
+import { postView, postViewRoute, getView } from "./routes/view";
+
+const routes = [
+  // api
+  {
+    path: "post/api/:tableName/:id",
+    action: updateTableRow,
+  },
+  {
+    path: "post/api/:tableName/",
+    action: insertTableRow,
+  },
+  // auth
+  {
+    path: "get/auth/login",
+    action: getLoginView,
+  },
+  {
+    path: "get/auth/logout",
+    action: logoutAction,
+  },
+  {
+    path: "get/auth/signup",
+    action: getSignupView,
+  },
+  // delete
+  {
+    path: "post/delete/:name/:id",
+    action: deleteRows,
+  },
+  // edit
+  {
+    path: "post/edit/toggle/:name/:id/:field_name",
+    action: postToggleField,
+  },
+  // error
+  {
+    path: "get/error_page",
+    action: getErrorView,
+  },
+  // field
+  {
+    path: "post/field/show-calculated/:tableName/:fieldName/:fieldview",
+    action: postShowCalculated,
+  },
+  // page
+  {
+    path: "post/page/:page_name/action/:rndid",
+    action: postPageAction,
+  },
+  {
+    path: "get/page/:page_name",
+    action: getPage,
+  },
+  // sync
+  {
+    path: "get/sync/sync_settings",
+    action: getSyncSettingsView,
+  },
+  {
+    path: "get/sync/ask_upload_not_ended",
+    action: getAskUploadNotEnded,
+  },
+  {
+    path: "get/sync/ask_delete_offline_data",
+    action: getAskDeleteOfflineData,
+  },
+  // view
+  {
+    path: "post/view/:viewname",
+    action: postView,
+  },
+  {
+    path: "post/view/:viewname/:route",
+    action: postViewRoute,
+  },
+  {
+    path: "get/view/:viewname",
+    action: getView,
+  },
+];
+
+export const router = new UniversalRouter(routes);

package/{www/js → src/routing}/mocks/request.js

@@ -1,6 +1,8 @@
-/*global i18next, saltcorn, currentLocation*/
+/*global saltcorn, */
 
-function MobileRequest({
+import i18next from "i18next";
+
+export function MobileRequest({
   xhr = false,
   files = undefined,
   query = undefined,
@@ -8,8 +10,6 @@ function MobileRequest({
   refererRoute = undefined,
 } = {}) {
   const cfg = saltcorn.data.state.getState().mobileConfig;
-  const roleId = cfg.role_id ? cfg.role_id : 100;
-  const userId = cfg.user_id ? cfg.user_id : undefined;
   const flashMessages = [];
   const refererPath = refererRoute ? refererRoute.route : undefined;
   const referQuery =
@@ -33,7 +33,7 @@ function MobileRequest({
     },
     getLocale: () => {
       const mobileCfg = saltcorn.data.state.getState().mobileConfig;
-      return mobileCfg?.language ? mobileCfg.language : "en";
+      return mobileCfg?.user?.language ? mobileCfg.user.language : "en";
     },
     user: cfg.user,
     flash: (type, msg) => {

package/{www/js → src/routing}/mocks/response.js

@@ -1,4 +1,4 @@
-function MobileResponse() {
+export function MobileResponse() {
   let jsonData = null;
   let sendData = null;
   let wrapHtml = null;

package/{www/js → src/routing}/routes/api.js

@@ -1,13 +1,12 @@
-/*global saltcorn, apiCall, MobileRequest, offlineHelper*/
+/*global saltcorn */
+
+import { apiCall } from "../../helpers/api";
+import { setHasOfflineData } from "../../helpers/offline_mode";
 
 // post/api/:tableName/:id
-const updateTableRow = async (context) => {
+export const updateTableRow = async (context) => {
   const { tableName, id } = context.params;
   const mobileConfig = saltcorn.data.state.getState().mobileConfig;
-  const user = {
-    id: mobileConfig.user_id,
-    role_id: mobileConfig.role_id || 100,
-  };
   const table = saltcorn.data.models.Table.findOne({ name: tableName });
   if (!table) throw new Error(`The table '${tableName}' does not exist.`);
   if (
@@ -24,10 +23,10 @@ const updateTableRow = async (context) => {
       id
     );
     if (errors.length > 0) throw new Error(errors.join(", "));
-    const ins_res = await table.tryUpdateRow(row, id, user);
+    const ins_res = await table.tryUpdateRow(row, id, mobileConfig.user);
     if (ins_res.error)
       throw new Error(`Update '${table.name}' error: ${ins_res.error}`);
-    if (mobileConfig.isOfflineMode) await offlineHelper.setHasOfflineData(true);
+    if (mobileConfig.isOfflineMode) await setHasOfflineData(true);
     return ins_res;
   } else {
     const response = await apiCall({
@@ -40,14 +39,10 @@ const updateTableRow = async (context) => {
 };
 
 // post/api/:tableName
-const insertTableRow = async (context) => {
+export const insertTableRow = async (context) => {
   const { tableName } = context.params;
   const table = saltcorn.data.models.Table.findOne({ name: tableName });
   const mobileConfig = saltcorn.data.state.getState().mobileConfig;
-  const user = {
-    id: mobileConfig.user_id,
-    role_id: mobileConfig.role_id || 100,
-  };
   if (!table) throw new Error(`The table '${tableName}' does not exist.`);
   if (
     mobileConfig.isOfflineMode ||
@@ -62,11 +57,11 @@ const insertTableRow = async (context) => {
       table.getFields()
     );
     if (errors.length > 0) throw new Error(errors.join(", "));
-    const ins_res = await table.tryInsertRow(row, user);
+    const ins_res = await table.tryInsertRow(row, mobileConfig.user);
     if (ins_res.error) {
       throw new Error(`Insert '${table.name}' error: ${ins_res.error}`);
     }
-    if (mobileConfig.isOfflineMode) await offlineHelper.setHasOfflineData(true);
+    if (mobileConfig.isOfflineMode) await setHasOfflineData(true);
     return ins_res;
   } else {
     const response = await apiCall({

package/{www/js → src/routing}/routes/auth.js

@@ -1,4 +1,10 @@
-/*global sbAdmin2Layout, apiCall, removeJwt, saltcorn, clearHistory, MobileRequest, MobileResponse, getHeaders*/
+/*global saltcorn */
+import { MobileRequest } from "../mocks/request";
+import { MobileResponse } from "../mocks/response";
+import { apiCall } from "../../helpers/api";
+import { removeJwt } from "../../helpers/auth";
+import { sbAdmin2Layout, getHeaders } from "../utils";
+import { clearHistory } from "../../helpers/navigation";
 
 const prepareAuthForm = () => {
   return new saltcorn.data.models.Form({
@@ -75,7 +81,7 @@ const renderLoginView = async (entryPoint, versionTag, alerts = []) => {
     alerts,
     headers: [
       { css: `static_assets/${versionTag}/saltcorn.css` },
-      { script: "js/utils/iframe_view_utils.js" },
+      { script: "js/iframe_view_utils.js" },
     ],
     csrfToken: false,
   });
@@ -92,13 +98,13 @@ const renderSignupView = (entryPoint, versionTag) => {
     alerts: [],
     headers: [
       { css: `static_assets/${versionTag}/saltcorn.css` },
-      { script: "js/utils/iframe_view_utils.js" },
+      { script: "js/iframe_view_utils.js" },
     ],
     csrfToken: false,
   });
 };
 
-const getLoginView = async (context) => {
+export const getLoginView = async (context) => {
   const mobileConfig = saltcorn.data.state.getState().mobileConfig;
   return {
     content: await renderLoginView(
@@ -110,7 +116,7 @@ const getLoginView = async (context) => {
   };
 };
 
-const getSignupView = async () => {
+export const getSignupView = async () => {
   const config = saltcorn.data.state.getState().mobileConfig;
   return {
     content: renderSignupView(config.entry_point, config.version_tag),
@@ -118,7 +124,7 @@ const getSignupView = async () => {
   };
 };
 
-const logoutAction = async () => {
+export const logoutAction = async () => {
   const config = saltcorn.data.state.getState().mobileConfig;
   const response = await apiCall({ method: "GET", path: "/auth/logout" });
   if (response.data.success) {

package/{www/js → src/routing}/routes/delete.js

@@ -1,19 +1,22 @@
-/*global i18next, apiCall, saltcorn, offlineHelper*/
+/*global saltcorn */
+import { apiCall } from "../../helpers/api";
+import { setHasOfflineData, hasOfflineRows } from "../../helpers/offline_mode";
+import i18next from "i18next";
 
 // post/delete/:name/:id
-const deleteRows = async (context) => {
+export const deleteRows = async (context) => {
   const { name, id } = context.params;
   const table = await saltcorn.data.models.Table.findOne({ name });
-  const { isOfflineMode, localTableIds, role_id } =
+  const { isOfflineMode, localTableIds, user } =
     saltcorn.data.state.getState().mobileConfig;
   if (isOfflineMode || localTableIds.indexOf(table.id) >= 0) {
-    if (role_id <= table.min_role_write) {
+    if (user.role_id <= table.min_role_write) {
       await table.deleteRows({ id });
       // TODO 'table.is_owner' check?
     } else
       throw new saltcorn.data.utils.NotAuthorized(i18next.t("Not authorized"));
-    if (isOfflineMode && (await offlineHelper.hasOfflineRows()))
-      await offlineHelper.setHasOfflineData(true);
+    if (isOfflineMode && (await hasOfflineRows()))
+      await setHasOfflineData(true);
     // if (isOfflineMode && !(await offlineHelper.hasOfflineRows())) {
     //   await offlineHelper.setOfflineSession(null);
     // }