saltcorn-samba 0.3.0

package/tree-view.js

@@ -0,0 +1,212 @@
+/**
+ * View template: `samba_tree`
+ *
+ * Renders a lazy-loading directory tree of a Samba share. Each directory can
+ * be expanded via AJAX; clicking a file opens the PDF viewer route (for PDFs
+ * and images) or triggers an "open in external app" link (smb://) for
+ * everything else.
+ *
+ * The view has two operating modes:
+ *   - "static"          – always show the same base_path from the config
+ *   - "from_field"      – append the value of a row field to base_path
+ *                         (only meaningful when embedded in a Show view)
+ */
+
+const { div, a, i, span, script, button } = require("@saltcorn/markup/tags");
+const Workflow = require("@saltcorn/data/models/workflow");
+const Form = require("@saltcorn/data/models/form");
+const Field = require("@saltcorn/data/models/field");
+const Table = require("@saltcorn/data/models/table");
+
+const { withClient, toSmbUrl, sanitizeRelativePath } = require("./smb-client");
+
+// ---------------------------------------------------------------------------
+// Configuration workflow
+// ---------------------------------------------------------------------------
+
+const configuration_workflow = () =>
+  new Workflow({
+    steps: [
+      {
+        name: "Tree options",
+        form: async (context) => {
+          const table = await Table.findOne({ id: context.table_id });
+          const fields = table ? await table.getFields() : [];
+          const stringFieldOptions = fields
+            .filter(
+              (f) =>
+                f.type &&
+                (f.type.name === "String" || f.type === "String" || f.type.name === "Text")
+            )
+            .map((f) => f.name);
+          return new Form({
+            fields: [
+              new Field({
+                name: "mode",
+                label: "Path mode",
+                type: "String",
+                required: true,
+                attributes: {
+                  options: ["static", "from_field"],
+                },
+                sublabel:
+                  "static = always show the plugin base_path; from_field = append a row field value",
+              }),
+              new Field({
+                name: "path_field",
+                label: "Row field with sub-path",
+                type: "String",
+                attributes: { options: stringFieldOptions },
+                showIf: { mode: "from_field" },
+              }),
+              new Field({
+                name: "extra_subpath",
+                label: "Extra sub-path (appended)",
+                type: "String",
+                sublabel:
+                  "Optional. Static suffix appended after the field value. Example: 'invoices'",
+              }),
+              new Field({
+                name: "show_hidden",
+                label: "Show hidden files",
+                type: "Bool",
+              }),
+              new Field({
+                name: "pdf_inline",
+                label: "Open PDFs inline",
+                type: "Bool",
+                default: true,
+              }),
+              new Field({
+                name: "expose_smb_link",
+                label: "Show 'Open in file manager' link (smb://)",
+                type: "Bool",
+                default: true,
+                sublabel:
+                  "Adds a button that opens the file/folder in Nemo, Nautilus, Dolphin, Explorer etc.",
+              }),
+            ],
+          });
+        },
+      },
+    ],
+  });
+
+// ---------------------------------------------------------------------------
+// Helpers
+// ---------------------------------------------------------------------------
+
+async function get_state_fields(table_id, viewname, { mode, path_field }) {
+  if (mode === "from_field" && !path_field) return [];
+  // The tree view can be embedded in a Show view and does not require any
+  // state fields on its own – we always operate on the current row.
+  return [];
+}
+
+/**
+ * Given the view configuration + a Saltcorn row, compute the effective
+ * relative path (below base_path) that the tree should start from.
+ */
+function computeStartPath(configuration, row) {
+  const parts = [];
+  if (configuration.mode === "from_field" && configuration.path_field && row) {
+    const v = row[configuration.path_field];
+    if (v) parts.push(String(v));
+  }
+  if (configuration.extra_subpath) parts.push(String(configuration.extra_subpath));
+  const joined = parts.join("/");
+  // sanitizeRelativePath throws on traversal – we let the caller handle it.
+  return sanitizeRelativePath(joined);
+}
+
+// ---------------------------------------------------------------------------
+// Render – client-side JS is served from /public/samba-tree.js
+// ---------------------------------------------------------------------------
+
+function renderShell(viewname, startPath, configuration) {
+  const treeId = `samba-tree-${Math.random().toString(36).slice(2, 10)}`;
+  const pluginVersion = configuration.__pluginVersion || "0.2.0";
+  const opts = {
+    viewname,
+    startPath,
+    pdfInline: !!configuration.pdf_inline,
+    exposeSmbLink: configuration.expose_smb_link !== false,
+    showHidden: !!configuration.show_hidden,
+  };
+  return (
+    div(
+      { class: "samba-tree-container card p-2" },
+      div(
+        { class: "samba-tree-toolbar d-flex align-items-center mb-2" },
+        span({ class: "text-muted small me-2" }, "Path:"),
+        span({ class: "samba-tree-breadcrumb small fw-bold" }, startPath || "/")
+      ),
+      div({ id: treeId, class: "samba-tree", "data-opts": JSON.stringify(opts) }),
+      div({ id: treeId + "-viewer", class: "samba-viewer mt-3" })
+    ) +
+    script(
+      `(function(){
+         function boot(){window.saltcornSambaMount && window.saltcornSambaMount(${JSON.stringify(
+           treeId
+         )});}
+         if(window.saltcornSambaMount){boot();return;}
+         var s=document.createElement('script');
+         s.src='/plugins/public/saltcorn-samba@${pluginVersion}/samba-tree.js';
+         s.onload=boot;
+         document.head.appendChild(s);
+       })();`
+    )
+  );
+}
+
+// ---------------------------------------------------------------------------
+// View: run (single row) and runMany
+// ---------------------------------------------------------------------------
+
+async function run(table_id, viewname, configuration, state, extra) {
+  // "state" typically contains the primary key of the row when the view is
+  // opened directly. If we are embedded in a Show view, `extra.row` is set.
+  let row = extra && extra.row;
+  if (!row && configuration.mode === "from_field") {
+    const table = await Table.findOne({ id: table_id });
+    if (table && state && Object.keys(state).length) {
+      row = await table.getRow(state);
+    }
+  }
+  let startPath = "";
+  try {
+    startPath = computeStartPath(configuration, row || {});
+  } catch (e) {
+    return div({ class: "alert alert-danger" }, "Samba tree: " + e.message);
+  }
+  return renderShell(viewname, startPath, configuration);
+}
+
+async function runMany(table_id, viewname, configuration, state, extra) {
+  const rows = extra && extra.rows ? extra.rows : [];
+  return rows.map((row) => ({
+    html: renderShell(
+      viewname,
+      (() => {
+        try {
+          return computeStartPath(configuration, row);
+        } catch {
+          return "";
+        }
+      })(),
+      configuration
+    ),
+    row,
+  }));
+}
+
+module.exports = {
+  name: "SambaTree",
+  display_state_form: false,
+  get_state_fields,
+  configuration_workflow,
+  run,
+  runMany,
+  description:
+    "Browse a Samba/CIFS share as a lazy-loading directory tree. Files open inline (PDF) or in the OS file manager.",
+};