Help pages ship with the client (#216)

Local mode opens help from the install tree, but the pages were in the
server component, so a client-only install had none. They move to the
client component at the same path, data/client/WebHelp/EcceHelp; the
server's /EcceHelp Alias and the CGI seeding in ecce-dataserver-start
read that path and ecce-server depends on ecce-client, so server mode
is unchanged. Each file is in exactly one component.

In local mode a help.urls file:// entry naming a page the tree lacks
(Builder-Help.htm, Subsystems/...) now opens the home page instead of a
missing file. tests/filedsi checks every help.urls key against the
built tree in local mode.

Images on the pages stay missing under file://: they use /EcceHelp/
paths. Making them relative breaks the four help CGIs that echo pages
from /cgi-bin/ in server mode, and per-user seeded copies of those CGIs
are never refreshed, so that was not done.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WCGMAAjNSTNh14zEkhDJn1

Author: andy

CMakeLists.txt

@@ -612,15 +612,13 @@ if(EXISTS ${_ecce_help_tarball})
   add_custom_target(ecce_help_cgi_patch ALL
     DEPENDS ${CMAKE_BINARY_DIR}/ecce-help-extracted/.help-cgi-patched)
 
-  # Lives under data/client/ on disk (BrowserHelp's rare file:// fallback
-  # path expects that layout - see BrowserHelp::initialize()) but this is
-  # server content: served over HTTP by the data server's Apache instance
-  # (httpd.conf.ecce's "/EcceHelp" Alias) and the source of the help CGI
-  # scripts ecce-dataserver-start seeds into its own cgi-bin/ -- so it
-  # goes in the server component, not client, when packages are split.
+  # Client content: local mode (#216) opens these pages as files, with no
+  # data server.  A server serves the same files (httpd.conf.ecce's
+  # "/EcceHelp" Alias) and seeds its help CGIs from them, at this path,
+  # and ecce-server depends on ecce-client, so it always has them.
   install(DIRECTORY ${CMAKE_BINARY_DIR}/ecce-help-extracted/EcceHelp
           DESTINATION data/client/WebHelp
-          COMPONENT server)
+          COMPONENT client)
   set(ECCE_HELP_AVAILABLE TRUE)
 else()
   message(WARNING "No vendored help tarball at ${_ecce_help_tarball} - "

src/util/genutil/BrowserHelp.C

@@ -70,9 +70,13 @@ string BrowserHelp::URL(const string& key) const
     }
   }
 
-  if (!LocalData::dir().empty() && ret.find("http://") == string::npos &&
-      ret.find("file://") == string::npos)
-    return localURL(ret);
+  if (!LocalData::dir().empty() && ret.find("http://") == string::npos) {
+    // A file:// entry naming a page the install lacks opens the home page.
+    if (ret.find("file://") == 0 &&
+        access((p_filePrefix + ret.substr(7)).c_str(), R_OK) == 0)
+      return "file://" + p_filePrefix + ret.substr(7);
+    return localURL(ret.find("file://") == 0 ? string("HomeFallback") : ret);
+  }
 
   if (ret.size() > 0 && ret.find("http://") == string::npos &&
                         ret.find("file://") == string::npos)

tests/filedsi/run_tests.py

@@ -186,6 +186,32 @@ def line(text, url, fn):
         print("%s help %s: %s" % ("PASS" if good else "FAIL", label,
                                   "" if good else "%r, want %r" % (lines, want)))
         ok = ok and good
+
+    # The built help tree: in local mode every help.urls key must open a
+    # file that exists.
+    built = os.path.join(BUILD, "ecce-help-extracted", "EcceHelp")
+    if os.path.isdir(built):
+        real = os.path.join(state, "helpreal")
+        os.makedirs(os.path.join(real, "client", "WebHelp"))
+        os.symlink(built, os.path.join(real, "client", "WebHelp", "EcceHelp"))
+        os.symlink(os.path.join(REPO, "data", "client", "config"),
+                   os.path.join(real, "client", "config"))
+        keys = []
+        with open(os.path.join(REPO, "data", "client", "config", "help.urls")) as h:
+            for l in h:
+                if l.strip() and not l.startswith("#") and ":" in l:
+                    keys.append(l.split(":", 1)[0].strip())
+        _, out = run_url(new, env, "help", *keys, ECCE_DATA=real,
+                         ECCE_HELP="http://h:8096/", ECCE_LOCAL_DATA=root)
+        urls = [l.rsplit(" ", 1) for l in out.splitlines()]
+        missing = ["%s %s" % (k, u) for k, u in urls
+                   if not u.startswith("file://")
+                   or not os.path.isfile(u[7:].split("#")[0])]
+        good = not missing and len(keys) > 100
+        print("%s help local, built tree: %d keys, %d not a file%s" % (
+                  "PASS" if good else "FAIL", len(keys), len(missing),
+                  "" if not missing else ": " + "; ".join(missing)))
+        ok = ok and good
     return ok