Figure numbers working in generated HTML and PDF

Clay-Ferguson · Clay-Ferguson · commit 5b1b979fb55f · 2024-11-19T17:54:46.000-06:00
diff --git a/src/main/java/quanta/model/TreeNode.java b/src/main/java/quanta/model/TreeNode.java
@@ -12,4 +12,5 @@ public TreeNode(SubNode node) {
     public SubNode node;
     public TreeNode parent;
     public LinkedList<TreeNode> children;
+    public int figNumStart;
 }
diff --git a/src/main/java/quanta/service/exports/ExportArchiveBase.java b/src/main/java/quanta/service/exports/ExportArchiveBase.java
@@ -97,6 +97,8 @@ private class MarkdownLink {
 
     // markdown links keyed by link url
     private HashMap<String, MarkdownLink> markdownLinks = new HashMap<>();
+    private HashMap<String, TreeNode> treeItemsByNodeName = new HashMap<>();
+    private int figNumStart = 1;
 
     private SubNode node;
     private SubNode parentSiteNode;
@@ -145,6 +147,7 @@ public String export(String nodeId) {
         }
 
         TreeNode rootNode = svc_mongoRead.getSubGraphTree(nodeId, criteria, null, null);
+        prePocessTree(rootNode);
         node = rootNode.node;
         baseSlashCount = StringUtils.countMatches(node.getPath(), "/");
 
@@ -186,6 +189,30 @@ public String export(String nodeId) {
         }
     }
 
+    private void prePocessTree(TreeNode root) {
+
+        if (root.node.getAttachments() != null && root.node.getAttachments().size() > 0) {
+            root.figNumStart = figNumStart;
+            figNumStart += root.node.getAttachments().size();
+        }
+
+        String nodeName = root.node.getName();
+        if (nodeName != null) {
+            if (treeItemsByNodeName.containsKey(nodeName)) {
+                log.warn("Duplicate node name: " + nodeName + " on nodeId " + root.node.getIdStr());
+            } else {
+                treeItemsByNodeName.put(nodeName, root);
+            }
+        }
+
+        if (root.children == null)
+            return;
+
+        for (TreeNode c : root.children) {
+            prePocessTree(c);
+        }
+    }
+
     private void writeMainFile() {
         switch (contentType) {
             case "md":
@@ -409,6 +436,7 @@ private boolean processNodeExport(String parentFolder, String deeperPath, TreeNo
 
             String content = node.getContent() != null ? node.getContent() : "";
             parseMarkdownLinks(content);
+            content = injectFigureLinks(content);
             content = content.trim();
 
             if (updateHeadings) {
@@ -443,12 +471,14 @@ private boolean processNodeExport(String parentFolder, String deeperPath, TreeNo
 
             // Process all attachments just to insert File Tags into content
             if (atts != null) {
+                int figNum = tn.figNumStart;
                 for (Attachment att : atts) {
                     // Process File Tag type attachments here first
                     if (!"ft".equals(att.getPosition())) {
                         continue;
                     }
-                    handleAttachment(node, true, contentVal, deeperPath, targetFolder, writeFile, att);
+                    handleAttachment(node, true, contentVal, deeperPath, targetFolder, writeFile, att, figNum);
+                    figNum++;
                 }
             }
 
@@ -471,12 +501,14 @@ private boolean processNodeExport(String parentFolder, String deeperPath, TreeNo
                     // special handling for htmlContent we have to do this File Tag injection AFTER
                     // the html escaping and processing that's done in the line above
                     if (atts != null) {
+                        int figNum = tn.figNumStart;
                         for (Attachment att : atts) {
                             // Process File Tag type attachments here first
                             if (!"ft".equals(att.getPosition())) {
                                 continue;
                             }
-                            handleAttachment(node, true, contentVal, deeperPath, targetFolder, writeFile, att);
+                            handleAttachment(node, true, contentVal, deeperPath, targetFolder, writeFile, att, figNum);
+                            figNum++;
                         }
                     }
 
@@ -498,13 +530,15 @@ private boolean processNodeExport(String parentFolder, String deeperPath, TreeNo
             }
 
             if (atts != null) {
+                int figNum = tn.figNumStart;
                 for (Attachment att : atts) {
                     // Skip File Tag type attachments because they'll already have been processed
                     // above
                     if ("ft".equals(att.getPosition())) {
                         continue;
                     }
-                    handleAttachment(node, false, null, deeperPath, targetFolder, writeFile, att);
+                    handleAttachment(node, false, null, deeperPath, targetFolder, writeFile, att, figNum);
+                    figNum++;
                 }
             }
 
@@ -524,6 +558,27 @@ private boolean processNodeExport(String parentFolder, String deeperPath, TreeNo
         return ret;
     }
 
+    private String injectFigureLinks(String content) {
+        // using regex we find the pattern {{figure:[node_name]}} and iterate over all of them where the
+        // [node_name]
+        // is a variable that we need to have during iteration
+        String regex = "\\{\\{figure:([^\\}]+)\\}\\}";
+        Pattern pattern = Pattern.compile(regex);
+        Matcher matcher = pattern.matcher(content);
+        while (matcher.find()) {
+            String nodeName = matcher.group(1);
+            log.debug("FIGURE: " + nodeName);
+            TreeNode tn = treeItemsByNodeName.get(nodeName);
+            if (tn == null) {
+                // needs to be a reported error that makes it's way to the screen.
+                log.warn("Figure node not found: " + nodeName);
+                continue;
+            }
+            content = content.replace("{{figure:" + nodeName + "}}", "Fig. " + tn.figNumStart);
+        }
+        return content;
+    }
+
     private String getTitleFromContent(String content) {
         String title = null;
         int newLineIdx = content.indexOf("\n");
@@ -780,7 +835,7 @@ private void writeAttachmentFileForNode(String parentFolder, SubNode node, Strin
      * content and return the content
      */
     private void handleAttachment(SubNode node, boolean injectingTag, Val<String> content, String deeperPath,
-            String parentFolder, boolean writeFile, Attachment att) {
+            String parentFolder, boolean writeFile, Attachment att, int figNum) {
         String nodeId = node.getIdStr();
 
         String af = getAttachmentFileName(att, node);
@@ -845,6 +900,11 @@ private void handleAttachment(SubNode node, boolean injectingTag, Val<String> co
                     // mdLink = "\n![" + displayName + "](" + fullUrl + ")\n\n";
                     String domId = "img_" + nodeId + "_" + att.getKey();
                     mdLink = "<img id='%s' src='%s' %s/>\n\n".formatted(domId, fullUrl, sizePart);
+
+                    if (figNum > 0) {
+                        mdLink = "<figure>\n" + mdLink + "<figcaption>Fig. " + figNum + "</figcaption>\n</figure>\n";
+                    }
+
                     processMdAtt(injectingTag, content, att, mdLink);
                     break;
                 default:
diff --git a/src/main/java/quanta/service/exports/ExportServicePDF.java b/src/main/java/quanta/service/exports/ExportServicePDF.java
@@ -6,6 +6,8 @@
 import java.nio.charset.StandardCharsets;
 import java.util.HashMap;
 import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -42,6 +44,9 @@ public class ExportServicePDF extends ServiceBase {
     private ExportRequest req;
     private int baseSlashCount = 0;
 
+    private HashMap<String, TreeNode> treeItemsByNodeName = new HashMap<>();
+    private int figNumStart = 1;
+
     /*
      * Exports the node specified in the req. If the node specified is "/", or the repository root, then
      * we don't expect a filename, because we will generate a timestamped one.
@@ -70,6 +75,8 @@ private void exportNodeToFile(String nodeId) {
         TreeNode rootNode = req.isThreadAsPDF() ? svc_mongoRead.getThreadGraphTree(nodeId) : //
                 svc_mongoRead.getSubGraphTree(nodeId, null, null, null);
 
+        prePocessTree(rootNode);
+
         SubNode exportNode = rootNode.node;
         String fileName = svc_snUtil.getExportFileName(req.getFileName(), exportNode);
         shortFileName = fileName + ".pdf";
@@ -106,10 +113,33 @@ private void exportNodeToFile(String nodeId) {
         }
     }
 
+    private void prePocessTree(TreeNode root) {
+        if (root.node.getAttachments() != null && root.node.getAttachments().size() > 0) {
+            root.figNumStart = figNumStart;
+            figNumStart += root.node.getAttachments().size();
+        }
+
+        String nodeName = root.node.getName();
+        if (nodeName != null) {
+            if (treeItemsByNodeName.containsKey(nodeName)) {
+                log.warn("Duplicate node name: " + nodeName + " on nodeId " + root.node.getIdStr());
+            } else {
+                treeItemsByNodeName.put(nodeName, root);
+            }
+        }
+
+        if (root.children == null)
+            return;
+
+        for (TreeNode c : root.children) {
+            prePocessTree(c);
+        }
+    }
+
     private void recurseNode(TreeNode tn, int level) {
         if (tn.node == null)
             return;
-        processNode(tn.node);
+        processNode(tn);
 
         if (level == 0 && req.isIncludeToc()) {
             markdown.append("[TOC]");
@@ -128,12 +158,12 @@ private void recurseNode(TreeNode tn, int level) {
         }
     }
 
-    private void processNode(SubNode node) {
+    private void processNode(TreeNode tn) {
         String nodeMarkdown = req.isDividerLine() ? "\n----\n" : "\n";
 
-        String id = req.isIncludeIDs() ? (" (id:" + node.getIdStr() + ")") : "";
+        String id = req.isIncludeIDs() ? (" (id:" + tn.node.getIdStr() + ")") : "";
         if (req.isIncludeOwners()) {
-            AccountNode accntNode = svc_user.getAccountNode(node.getOwner());
+            AccountNode accntNode = svc_user.getAccountNode(tn.node.getOwner());
             if (accntNode != null) {
                 nodeMarkdown += "Owner: " + accntNode.getStr(NodeProp.USER) + id + "\n";
             }
@@ -143,27 +173,49 @@ private void processNode(SubNode node) {
         }
         nodeMarkdown += "\n";
 
-        String content = node.getContent();
-        TypeBase plugin = svc_typeMgr.getPluginByType(node.getType());
+        String content = tn.node.getContent();
+        TypeBase plugin = svc_typeMgr.getPluginByType(tn.node.getType());
         if (plugin != null) {
-            content = plugin.formatExportText("pdf", node);
+            content = plugin.formatExportText("pdf", tn.node);
         }
 
         if (content != null && req.isUpdateHeadings()) {
             content = content.trim();
-            int slashCount = StringUtils.countMatches(node.getPath(), "/");
+            int slashCount = StringUtils.countMatches(tn.node.getPath(), "/");
             int lev = slashCount - baseSlashCount; // top level node comes here with lev=0
             if (lev > 6)
                 lev = 6;
             content = svc_edit.translateHeadingsForLevel(content, lev);
         }
 
-        content = insertPropertySubstitutions(content, node);
+        content = insertPropertySubstitutions(content, tn.node);
+        content = injectFigureLinks(content);
         nodeMarkdown += content + "\n";
-        nodeMarkdown = writeImages(node, nodeMarkdown);
+        nodeMarkdown = writeImages(tn, nodeMarkdown);
         markdown.append(nodeMarkdown);
     }
 
+    private String injectFigureLinks(String content) {
+        // using regex we find the pattern {{figure:[node_name]}} and iterate over all of them where the
+        // [node_name]
+        // is a variable that we need to have during iteration
+        String regex = "\\{\\{figure:([^\\}]+)\\}\\}";
+        Pattern pattern = Pattern.compile(regex);
+        Matcher matcher = pattern.matcher(content);
+        while (matcher.find()) {
+            String nodeName = matcher.group(1);
+            log.debug("FIGURE: " + nodeName);
+            TreeNode tn = treeItemsByNodeName.get(nodeName);
+            if (tn == null) {
+                // needs to be a reported error that makes it's way to the screen.
+                log.warn("Figure node not found: " + nodeName);
+                continue;
+            }
+            content = content.replace("{{figure:" + nodeName + "}}", "Fig. " + tn.figNumStart);
+        }
+        return content;
+    }
+
     private String insertPropertySubstitutions(String content, SubNode node) {
         HashMap<String, Object> propMap = node.getProps();
         if (propMap != null && propMap.keySet() != null) {
@@ -177,13 +229,15 @@ private String insertPropertySubstitutions(String content, SubNode node) {
         return content;
     }
 
-    private String writeImages(SubNode node, String content) {
-        List<Attachment> atts = node.getOrderedAttachments();
+    private String writeImages(TreeNode tn, String content) {
+        List<Attachment> atts = tn.node.getOrderedAttachments();
         if (atts == null)
             return content;
 
+        int figNum = tn.figNumStart - 1;
         // process all attachments specifically to embed the image ones
         for (Attachment att : atts) {
+            figNum++;
             // Since GIFs are really only ever used for animated GIFs nowadays, and since PDF files cannot
             // render them we just always ignore GIF files when generating PDFs.
             if (att.getFileName() != null && att.getFileName().toLowerCase().endsWith(".gif")) {
@@ -218,7 +272,7 @@ private String writeImages(SubNode node, String content) {
 
             String src = null;
             if (bin != null) {
-                String path = AppController.API_PATH + "/bin/" + bin + "?nodeId=" + node.getIdStr() + "&token="
+                String path = AppController.API_PATH + "/bin/" + bin + "?nodeId=" + tn.node.getIdStr() + "&token="
                         + URLEncoder.encode(TL.getSC().getUserToken(), StandardCharsets.UTF_8);
                 src = svc_prop.getProtocolHostAndPort() + path;
             } //
@@ -230,6 +284,10 @@ else if (url != null) {
 
             String imgHtml = "\n<img src='" + src + "' " + style + "/>\n";
 
+            if (figNum > 0) {
+                imgHtml = "<figure>\n" + imgHtml + "<figcaption>Fig. " + figNum + "</figcaption>\n</figure>\n";
+            }
+
             if ("ft".equals(att.getPosition())) {
                 content = content.replace("{{" + att.getFileName() + "}}", imgHtml);
             } else {

Original file line number	Diff line number	Diff line change
`@@ -12,4 +12,5 @@ public TreeNode(SubNode node) {`
`12`	`12`	`public SubNode node;`
`13`	`13`	`public TreeNode parent;`
`14`	`14`	`public LinkedList<TreeNode> children;`
	`15`	`+ public int figNumStart;`
`15`	`16`	`}`