signalk-charts-provider-simple 2.0.2 → 2.0.3

package/README.md

@@ -107,9 +107,9 @@ The interface provides four tabs:
 - **Node.js >= 22.5** — uses the built-in `node:sqlite` module, no native compilation needed
 - **Not supported on Cerbo GX** — Venus OS ships Node.js 20, which lacks the `node:sqlite` module. Use v1.6.x if you need Cerbo support.
 
-### Required for chart conversion: `signalk-container` plugin
+### Recommended for chart conversion: `signalk-container` plugin
 
-To convert S-57 ENC, BSB raster, Pilot Charts, or basemaps, this plugin delegates all container work to the [`signalk-container`](https://github.com/dirkwa/signalk-container) plugin. The Signal K App Store handles installing it for you when you install Charts Provider Simple — the plugin's detail page shows it as a required plugin and offers a one-click bulk install.
+Displaying charts (serving tiles from `.mbtiles`) needs nothing extra. The [`signalk-container`](https://github.com/dirkwa/signalk-container) plugin is only needed to **convert** charts (S-57 ENC, BSB raster, Pilot Charts, or basemaps), where this plugin delegates all container work to it. The Signal K App Store lists it as a recommended plugin on the Charts Provider Simple detail page and offers a one-click bulk install; without it the plugin still loads and serves charts — only the Convert tab is disabled.
 
 `signalk-container` itself needs a Docker- or Podman-compatible runtime on the host. Both engines work the same way; pick whichever is easier:
 
@@ -133,7 +133,7 @@ The plugin uses one combined image that `signalk-container` pulls automatically
 - **Signal K in Docker / Podman with a named volume** — the helper container mounts the same named volume. (1.x couldn't do this; named-volume deployments were unable to convert.)
 - **Signal K in Docker / Podman with bind-mounted data** — the helper container gets the resolved host path, even when the in-container path doesn't match the host path. (1.x relied on host/container paths matching exactly; mismatches silently failed.)
 
-**Signal K running in Docker?** See [docs/running-in-docker.md](docs/running-in-docker.md) for the docker-compose snippet.
+**Signal K running in Docker?** Runtime and socket setup is handled by `signalk-container` — see [docs/running-in-docker.md](docs/running-in-docker.md) for how conversion is delegated and where to configure the host.
 
 Conversion concurrency is configurable — see the [CPU budget](#cpu-budget-for-chart-conversion) section. MBTiles charts (display only, no conversion) work without any container runtime, and without `signalk-container`.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "signalk-charts-provider-simple",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Simple Signal K chart provider for local MBTiles with web and download management",
   "type": "module",
   "main": "dist/index.js",

package/public/css/chart-catalog.css

@@ -382,6 +382,10 @@ select.catalog-folder-select:hover {
     appearance: auto;
 }
 
+option.catalog-folder-option-new {
+    color: var(--md-sys-color-primary);
+}
+
 /* Source attribution note */
 .catalog-source-note {
     padding: var(--md-sys-spacing-3) var(--md-sys-spacing-4);

package/public/js/chart-catalog.js

@@ -364,7 +364,7 @@ function renderCatalogCard(catalog) {
         </div>
       </div>
       <div class="catalog-card-body" id="catalog-body-${catalogEscapeId(catalog.file)}">
-        ${isExpanded && catalogChartData[catalog.file] ? renderChartList(catalog.file) : ''}
+        ${isExpanded && catalogChartData[catalog.file] ? renderChartList(catalog.file, catalog.label) : ''}
       </div>
     </div>
   `;
@@ -408,11 +408,12 @@ async function toggleCatalog(catalogFile) {
     // Re-render to show charts
     renderCatalogList();
 }
-function renderChartList(catalogFile) {
+function renderChartList(catalogFile, catalogLabel) {
     const data = catalogChartData[catalogFile];
     if (!data?.charts || data.charts.length === 0) {
         return `<div class="catalog-empty">No charts in this catalog.</div>`;
     }
+    const defaultFolder = catalogLabelToFolder(catalogLabel);
     return data.charts
         .map((chart) => {
         const cls = chart.urlClassification ?? {
@@ -495,7 +496,7 @@ function renderChartList(catalogFile) {
           ${podmanHint}
           ${zoomHtml}
           <select class="catalog-folder-select" id="catalog-folder-${catalogEscapeId(chart.number)}">
-            ${catalogFolders.map((f) => `<option value="${catalogEscapeAttr(f)}">${catalogEscapeHtml(f)}</option>`).join('')}
+            ${buildFolderOptions(defaultFolder)}
           </select>
           <button class="btn-catalog-download" ${btnDisabled}
                   data-catalog-download="${catalogEscapeAttr(chart.number)}"
@@ -926,6 +927,40 @@ function categoryLabel(category) {
     };
     return labels[category] ?? category;
 }
+/**
+ * Derive a filesystem-safe folder name from a catalog label.
+ * Strips path separators and illegal characters, collapses whitespace, removes
+ * leading dots/spaces, and rejects a result of '.' or '..' so a label can't
+ * resolve to a traversal or a hidden/relative folder. Falls back to '/' when
+ * nothing usable remains.
+ */
+function catalogLabelToFolder(label) {
+    if (!label) {
+        return '/';
+    }
+    const safe = label
+        .replace(/[/\\:*?"<>|]/g, '')
+        .replace(/\s+/g, ' ')
+        .trim()
+        .replace(/^[.\s]+/, '')
+        .trim();
+    return safe && safe !== '.' && safe !== '..' ? safe : '/';
+}
+function folderDisplayName(folder) {
+    return folder === '/' ? '/' : `/${folder}`;
+}
+function buildFolderOptions(defaultFolder) {
+    const isNew = defaultFolder !== '/' && !catalogFolders.includes(defaultFolder);
+    const options = [];
+    if (isNew) {
+        options.push(`<option value="${catalogEscapeAttr(defaultFolder)}" selected class="catalog-folder-option-new">${catalogEscapeHtml(folderDisplayName(defaultFolder))} (new)</option>`);
+    }
+    for (const folder of catalogFolders) {
+        const selected = !isNew && folder === defaultFolder ? ' selected' : '';
+        options.push(`<option value="${catalogEscapeAttr(folder)}"${selected}>${catalogEscapeHtml(folderDisplayName(folder))}</option>`);
+    }
+    return options.join('');
+}
 function catalogEscapeHtml(str) {
     if (!str) {
         return '';

package/public/js/chart-catalog.ts

@@ -481,7 +481,7 @@ function renderCatalogCard(catalog: CatalogRegistryEntry): string {
         </div>
       </div>
       <div class="catalog-card-body" id="catalog-body-${catalogEscapeId(catalog.file)}">
-        ${isExpanded && catalogChartData[catalog.file] ? renderChartList(catalog.file) : ''}
+        ${isExpanded && catalogChartData[catalog.file] ? renderChartList(catalog.file, catalog.label) : ''}
       </div>
     </div>
   `;
@@ -533,11 +533,12 @@ async function toggleCatalog(catalogFile: string): Promise<void> {
   renderCatalogList();
 }
 
-function renderChartList(catalogFile: string): string {
+function renderChartList(catalogFile: string, catalogLabel: string): string {
   const data = catalogChartData[catalogFile];
   if (!data?.charts || data.charts.length === 0) {
     return `<div class="catalog-empty">No charts in this catalog.</div>`;
   }
+  const defaultFolder = catalogLabelToFolder(catalogLabel);
 
   return data.charts
     .map((chart) => {
@@ -625,7 +626,7 @@ function renderChartList(catalogFile: string): string {
           ${podmanHint}
           ${zoomHtml}
           <select class="catalog-folder-select" id="catalog-folder-${catalogEscapeId(chart.number)}">
-            ${catalogFolders.map((f) => `<option value="${catalogEscapeAttr(f)}">${catalogEscapeHtml(f)}</option>`).join('')}
+            ${buildFolderOptions(defaultFolder)}
           </select>
           <button class="btn-catalog-download" ${btnDisabled}
                   data-catalog-download="${catalogEscapeAttr(chart.number)}"
@@ -1092,6 +1093,50 @@ function categoryLabel(category: CatalogCategory | string): string {
   return labels[category] ?? category;
 }
 
+/**
+ * Derive a filesystem-safe folder name from a catalog label.
+ * Strips path separators and illegal characters, collapses whitespace, removes
+ * leading dots/spaces, and rejects a result of '.' or '..' so a label can't
+ * resolve to a traversal or a hidden/relative folder. Falls back to '/' when
+ * nothing usable remains.
+ */
+function catalogLabelToFolder(label: string | undefined | null): string {
+  if (!label) {
+    return '/';
+  }
+  const safe = label
+    .replace(/[/\\:*?"<>|]/g, '')
+    .replace(/\s+/g, ' ')
+    .trim()
+    .replace(/^[.\s]+/, '')
+    .trim();
+  return safe && safe !== '.' && safe !== '..' ? safe : '/';
+}
+
+function folderDisplayName(folder: string): string {
+  return folder === '/' ? '/' : `/${folder}`;
+}
+
+function buildFolderOptions(defaultFolder: string): string {
+  const isNew = defaultFolder !== '/' && !catalogFolders.includes(defaultFolder);
+  const options: string[] = [];
+
+  if (isNew) {
+    options.push(
+      `<option value="${catalogEscapeAttr(defaultFolder)}" selected class="catalog-folder-option-new">${catalogEscapeHtml(folderDisplayName(defaultFolder))} (new)</option>`
+    );
+  }
+
+  for (const folder of catalogFolders) {
+    const selected = !isNew && folder === defaultFolder ? ' selected' : '';
+    options.push(
+      `<option value="${catalogEscapeAttr(folder)}"${selected}>${catalogEscapeHtml(folderDisplayName(folder))}</option>`
+    );
+  }
+
+  return options.join('');
+}
+
 function catalogEscapeHtml(str: string | undefined | null): string {
   if (!str) {
     return '';

package/public/js/chart-convert.js

@@ -36,8 +36,11 @@ async function initConvertTab() {
       ${!convertPodmanAvailable
         ? `
         <div class="catalog-podman-warning">
-          <strong>Container runtime not reachable.</strong>
-          Chart conversion needs a Docker- or Podman-compatible socket.
+          <strong>Chart conversion unavailable.</strong>
+          Converting charts needs the
+          <a href="https://github.com/dirkwa/signalk-container" target="_blank" rel="noopener">signalk-container</a>
+          plugin (install it from the App Store) plus a Docker- or Podman-compatible
+          runtime on the host. Chart display works without it.
           <a href="https://github.com/dirkwa/signalk-charts-provider-simple/blob/main/docs/running-in-docker.md" target="_blank" rel="noopener">See setup notes</a>.
         </div>
       `
@@ -143,7 +146,7 @@ function setupDropZone(zoneId, inputId) {
     }
     zone.onclick = () => {
         if (!convertPodmanAvailable) {
-            alert('Chart conversion needs a Docker- or Podman-compatible socket. See the warning above.');
+            alert('Chart conversion needs the signalk-container plugin and a Docker- or Podman-compatible runtime. See the warning above.');
             return;
         }
         input.click();
@@ -159,7 +162,7 @@ function setupDropZone(zoneId, inputId) {
         e.preventDefault();
         zone.classList.remove('dragover');
         if (!convertPodmanAvailable) {
-            alert('Chart conversion needs a Docker- or Podman-compatible socket. See the warning above.');
+            alert('Chart conversion needs the signalk-container plugin and a Docker- or Podman-compatible runtime. See the warning above.');
             return;
         }
         const dt = e.dataTransfer;

package/public/js/chart-convert.ts

@@ -61,8 +61,11 @@ async function initConvertTab(): Promise<void> {
         !convertPodmanAvailable
           ? `
         <div class="catalog-podman-warning">
-          <strong>Container runtime not reachable.</strong>
-          Chart conversion needs a Docker- or Podman-compatible socket.
+          <strong>Chart conversion unavailable.</strong>
+          Converting charts needs the
+          <a href="https://github.com/dirkwa/signalk-container" target="_blank" rel="noopener">signalk-container</a>
+          plugin (install it from the App Store) plus a Docker- or Podman-compatible
+          runtime on the host. Chart display works without it.
           <a href="https://github.com/dirkwa/signalk-charts-provider-simple/blob/main/docs/running-in-docker.md" target="_blank" rel="noopener">See setup notes</a>.
         </div>
       `
@@ -178,7 +181,7 @@ function setupDropZone(zoneId: string, inputId: string): void {
   zone.onclick = () => {
     if (!convertPodmanAvailable) {
       alert(
-        'Chart conversion needs a Docker- or Podman-compatible socket. See the warning above.'
+        'Chart conversion needs the signalk-container plugin and a Docker- or Podman-compatible runtime. See the warning above.'
       );
       return;
     }
@@ -199,7 +202,7 @@ function setupDropZone(zoneId: string, inputId: string): void {
     zone.classList.remove('dragover');
     if (!convertPodmanAvailable) {
       alert(
-        'Chart conversion needs a Docker- or Podman-compatible socket. See the warning above.'
+        'Chart conversion needs the signalk-container plugin and a Docker- or Podman-compatible runtime. See the warning above.'
       );
       return;
     }