Add opt-in dynamic-publish-box (client-side current-version + page-versions)

When publish-setup.json website.dynamic-publish-box=true, the publish box emits
version-agnostic placeholders for the 'current version' reference and the
'Page versions:' list, filled in client-side at page load from package-list.json
(same origin; already the source of truth). The emitted markup is then identical on
every page of every version regardless of which version is current, so cutting a new
milestone no longer rewrites the publish box in past versions.

- PublishBoxStatementGenerator: version-agnostic placeholder + one inline script that
  fills the current version/link, toggles superseded/is-current/pre-release wording, and
  builds the Page-versions list (HEAD-probing each milestone for the page).
- IGReleaseVersionUpdater: addPageVersions emits the placeholder when enabled.
- PublicationProcess / IGReleaseUpdater / IGWebSiteMaintainer: thread the flag through
  -go-publish and -publish-update at every call site.

Off by default.

Author: KyleOps

org.hl7.fhir.publisher.core/src/main/java/org/hl7/fhir/igtools/web/IGReleaseUpdater.java

@@ -92,14 +92,20 @@ public static ServerType fromCode(String st) {
   private File sft;
   private boolean fullUpdate;
   private String historySource;
+  private boolean dynamicPublishBox;
 
   public IGReleaseUpdater(String folder, String url, String rootFolder, IGRegistryMaintainer reg, ServerType serverType, List<String> otherSpecs, File sft, boolean full, String historySource) throws IOException {
+    this(folder, url, rootFolder, reg, serverType, otherSpecs, sft, full, historySource, false);
+  }
+
+  public IGReleaseUpdater(String folder, String url, String rootFolder, IGRegistryMaintainer reg, ServerType serverType, List<String> otherSpecs, File sft, boolean full, String historySource, boolean dynamicPublishBox) throws IOException {
     this.folder = folder;
     this.url = url;
     this.rootFolder = rootFolder;
     this.fullUpdate = full;
     this.sft = sft;
     this.historySource = historySource;
+    this.dynamicPublishBox = dynamicPublishBox;
     if (!"".equals("http://hl7.org/fhir")) { // keep the main spec out of the registry
       this.reg = reg;
     }
@@ -329,11 +335,11 @@ private boolean updateStatement(String vf, List<String> ignoreList, List<String>
       return false;
     }
     boolean vc = false;
-    IGReleaseVersionUpdater igvu = new IGReleaseVersionUpdater(vf, url, rootFolder, ignoreList, ignoreListOuter, version, folder);
+    IGReleaseVersionUpdater igvu = new IGReleaseVersionUpdater(vf, url, rootFolder, ignoreList, ignoreListOuter, version, folder, dynamicPublishBox);
     if (updateStatements) {
       PackageList pl = new PackageList(ig);
       PackageListEntry pv = pl.findByVersion(version.asString("version"));
-      String fragment = PublishBoxStatementGenerator.genFragment(pl, pv, pl.current(), canonical, pv == pl.current(), false);
+      String fragment = PublishBoxStatementGenerator.genFragment(pl, pv, pl.current(), canonical, pv == pl.current(), false, dynamicPublishBox);
       System.out.println("  "+vf+": "+fragment);
       igvu.updateStatement(fragment, ignoreList != null ? 0 : 1, milestones);
       System.out.println("  .. "+igvu.getCountTotal()+" files checked, "+igvu.getCountUpdated()+" updated");

org.hl7.fhir.publisher.core/src/main/java/org/hl7/fhir/igtools/web/IGReleaseVersionUpdater.java

@@ -58,16 +58,22 @@ public class IGReleaseVersionUpdater {
   private int clonedTotal;
   private String rootUrl;
   private String rootFolder;
+  private boolean dynamicPublishBox;
 
 
   public IGReleaseVersionUpdater(String folder, String rootUrl, String rootFolder, List<String> ignoreList, List<String> ignoreListOuter, JsonObject version, String currentFolder) {
+    this(folder, rootUrl, rootFolder, ignoreList, ignoreListOuter, version, currentFolder, false);
+  }
+
+  public IGReleaseVersionUpdater(String folder, String rootUrl, String rootFolder, List<String> ignoreList, List<String> ignoreListOuter, JsonObject version, String currentFolder, boolean dynamicPublishBox) {
     this.folder = folder;
     this.ignoreList = ignoreList;
     this.ignoreListOuter = ignoreListOuter;
     this.version = version;
     this.currentFolder = currentFolder;
     this.rootFolder = rootFolder;
     this.rootUrl = rootUrl;
+    this.dynamicPublishBox = dynamicPublishBox;
   }
 
   public void updateStatement(String fragment, int level, List<PackageListEntry> milestones) throws FileNotFoundException, IOException {
@@ -160,7 +166,13 @@ private String addPageVersions(File f, List<PackageListEntry> milestones) throws
     if (milestones == null) {
       return "";
     }
-    String relpath = FileUtilities.getRelativePath(folder, f.getAbsolutePath()); 
+    if (dynamicPublishBox) {
+      // version-agnostic placeholder: the "Page versions: ..." list is resolved client-side from
+      // package-list.json (see PublishBoxStatementGenerator's script), so adding a new milestone
+      // folder no longer rewrites this line in every past version's pages.
+      return "<span class=\"fhir-pb-page-versions\" data-pb-version=\""+Utilities.escapeXml(version.asString("version"))+"\"></span>";
+    }
+    String relpath = FileUtilities.getRelativePath(folder, f.getAbsolutePath());
     CommaSeparatedStringBuilder b = new CommaSeparatedStringBuilder(" ");
     int i = 0;
     for (PackageListEntry t : milestones) {

org.hl7.fhir.publisher.core/src/main/java/org/hl7/fhir/igtools/web/IGWebSiteMaintainer.java

@@ -71,6 +71,7 @@ public static void execute(String folder, IGRegistryMaintainer reg, boolean doCo
     if (reg == null && !pubSetup.forceObject("website").asBoolean("no-registry"))
       throw new Error("This web site contains IGs that are registered in the implementation guide registry, and you must pass in a reference to the registry");
     ServerType serverType = ServerType.fromCode(pubSetup.forceObject("website").asString("server"));
+    boolean dynamicPublishBox = pubSetup.forceObject("website").asBoolean("dynamic-publish-box");
 
     File sft = null;
     if (pubSetup.forceObject("website").has("search-template")) {
@@ -110,7 +111,7 @@ public static void execute(String folder, IGRegistryMaintainer reg, boolean doCo
       }
     }
     for (String s : igs) {
-      new IGReleaseUpdater(s, url, folder, reg, serverType, igs, sft, filter == null || filter.equalsIgnoreCase(s), historyRepo).check(indexes, true, updateStatements, templateSrc, "??");
+      new IGReleaseUpdater(s, url, folder, reg, serverType, igs, sft, filter == null || filter.equalsIgnoreCase(s), historyRepo, dynamicPublishBox).check(indexes, true, updateStatements, templateSrc, "??");
     }
     for (IndexMaintainer index : indexes.values()) {
       index.buildJson();

org.hl7.fhir.publisher.core/src/main/java/org/hl7/fhir/igtools/web/PublicationProcess.java

@@ -597,6 +597,7 @@ private void doPublish(File fSource, File fOutput, JsonObject qa, String destina
                          Date genDate, String username, String version, String gitSrcId, String tcName, String tcPath, PackageListEntry tcVer, String workingRoot, boolean jsonXmlClones, File igBuildZipDir, File previousPackageFile, String[] args, String replaces) throws Exception {
     // ok. all our tests have passed.
     // 1. do the publication build(s)
+    boolean dynamicPublishBox = pubSetup.getJsonObject("website").asBoolean("dynamic-publish-box");
     List<String> existingFiles = new ArrayList<>();
     if (mode == PublicationProcessMode.CREATION) {
       System.out.println("All checks passed. Create an empty history at "+destination);              
@@ -646,7 +647,7 @@ private void doPublish(File fSource, File fOutput, JsonObject qa, String destina
       System.out.println("Update "+Utilities.path(destination, "package-list.json"));    
       PackageListEntry plVer = updatePackageList(pl, fSource.getAbsolutePath(), prSrc, pathVer,  Utilities.path(destination, "package-list.json"), mode, date,
               npm.fhirVersion(), Utilities.pathURL(pubSetup.asString("url"), tcName), subPackages, prSrc.asString("previouslyPublishedAs"));
-      updatePublishBox(pl, plVer, destVer, pathVer, destination, fRoot.getAbsolutePath(), false, ServerType.fromCode(pubSetup.getJsonObject("website").asString("server")), sft, null, url, jsonXmlClones);
+      updatePublishBox(pl, plVer, destVer, pathVer, destination, fRoot.getAbsolutePath(), false, ServerType.fromCode(pubSetup.getJsonObject("website").asString("server")), sft, null, url, jsonXmlClones, dynamicPublishBox);
 
       if (mode != PublicationProcessMode.WORKING || prSrc.has("movedFrom")) {
         String igSrc = tempM == null ? null : Utilities.path(tempM.getAbsolutePath(), "output");
@@ -676,7 +677,7 @@ private void doPublish(File fSource, File fOutput, JsonObject qa, String destina
                 String vCode = pv.substring(pv.lastIndexOf("/")+1);
                 String dv = Utilities.path(fRoot, relPath);
                 System.out.println("Update publish box for version "+v.version()+" @ "+v.path());
-                updatePublishBox(pl, v, dv, pv, destination, fRoot.getAbsolutePath(), false, null, null, null, url, jsonXmlClones);
+                updatePublishBox(pl, v, dv, pv, destination, fRoot.getAbsolutePath(), false, null, null, null, url, jsonXmlClones, dynamicPublishBox);
               }
             }
           }
@@ -698,11 +699,11 @@ private void doPublish(File fSource, File fOutput, JsonObject qa, String destina
           }
           String vCode = tcPath.substring(tcPath.lastIndexOf("/")+1);
           String dv = Utilities.path(destination, vCode);
-          updatePublishBox(pl, tcVer, dv, tcPath, destination, fRoot.getAbsolutePath(), false, null, null, null, url, jsonXmlClones);
+          updatePublishBox(pl, tcVer, dv, tcPath, destination, fRoot.getAbsolutePath(), false, null, null, null, url, jsonXmlClones, dynamicPublishBox);
         }
         // we do this first in the output so we can get a proper diff
         if (igSrc != null) {
-          updatePublishBox(pl, plVer, igSrc, pathVer, igSrc, fRoot.getAbsolutePath(), true, ServerType.fromCode(pubSetup.getJsonObject("website").asString("server")), sft, null, url, jsonXmlClones);
+          updatePublishBox(pl, plVer, igSrc, pathVer, igSrc, fRoot.getAbsolutePath(), true, ServerType.fromCode(pubSetup.getJsonObject("website").asString("server")), sft, null, url, jsonXmlClones, dynamicPublishBox);
 
           System.out.println("Check for Files to delete");
           List<String> newFiles = igSrc == null ? new ArrayList<>() : FileUtilities.listAllFiles(igSrc, null);
@@ -730,7 +731,7 @@ private void doPublish(File fSource, File fOutput, JsonObject qa, String destina
               ignoreList.add(Utilities.path(dpath, v.path().substring(path.length()+1)));
             }
           }
-          updatePublishBox(pl, pl.current(), dpath, path, dpath, fRoot.getAbsolutePath(), true, null, null, ignoreList, url, jsonXmlClones);
+          updatePublishBox(pl, pl.current(), dpath, path, dpath, fRoot.getAbsolutePath(), true, null, null, ignoreList, url, jsonXmlClones, dynamicPublishBox);
         }
       } else {
         src.cleanFolder(relDest);
@@ -1044,9 +1045,9 @@ public String presentDate(Date date) {
     return sdf.format(date);
   }
 
-  private void updatePublishBox(PackageList pl, PackageListEntry plVer, String destVer, String pathVer, String destination, String rootFolder, boolean current, ServerType serverType, File sft, List<String> ignoreList, String url, boolean jsonXmlClones) throws FileNotFoundException, IOException {
-    IGReleaseVersionUpdater igvu = new IGReleaseVersionUpdater(destVer, url, rootFolder, ignoreList, null, plVer.json(), destination);
-    String fragment = PublishBoxStatementGenerator.genFragment(pl, plVer, pl.current(), pl.canonical(), current, false);
+  private void updatePublishBox(PackageList pl, PackageListEntry plVer, String destVer, String pathVer, String destination, String rootFolder, boolean current, ServerType serverType, File sft, List<String> ignoreList, String url, boolean jsonXmlClones, boolean dynamicPublishBox) throws FileNotFoundException, IOException {
+    IGReleaseVersionUpdater igvu = new IGReleaseVersionUpdater(destVer, url, rootFolder, ignoreList, null, plVer.json(), destination, dynamicPublishBox);
+    String fragment = PublishBoxStatementGenerator.genFragment(pl, plVer, pl.current(), pl.canonical(), current, false, dynamicPublishBox);
     System.out.println("Publish Box Statement: "+fragment);
     igvu.updateStatement(fragment, current ? 0 : 1, pl.milestones());
     System.out.println("  .. "+igvu.getCountTotal()+" files checked, "+igvu.getCountUpdated()+" updated");
@@ -1343,7 +1344,7 @@ private List<ValidationMessage> processWithdrawal(String source, String web, Str
         String vCode = pv.substring(pv.lastIndexOf("/")+1);
         String dv = Utilities.path(destination, vCode);
         System.out.println("Update publish box for version "+v.version()+" @ "+v.path());
-        updatePublishBox(pl, v, dv, pv, destination, fRoot.getAbsolutePath(), false, null, null, null, url, false);
+        updatePublishBox(pl, v, dv, pv, destination, fRoot.getAbsolutePath(), false, null, null, null, url, false, pubSetup.getJsonObject("website").asBoolean("dynamic-publish-box"));
       }
     }