[WIP] include_relative tag support

bkiers · Oct 14, 2023 · 5857938 · 5857938
1 parent adc2602
commit 5857938
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 7 deletions.
diff --git a/src/main/java/liqp/Template.java b/src/main/java/liqp/Template.java
@@ -2,11 +2,7 @@
 
 import java.io.File;
 import java.nio.file.Path;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
+import java.util.*;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.concurrent.Future;
@@ -47,6 +43,7 @@ public class Template {
 
 
     private final long templateSize;
+    private final String sourceName;
 
     private TemplateContext templateContext = null;
 
@@ -63,6 +60,7 @@ public class Template {
         this.templateSize = stream.size();
         LiquidLexer lexer = new LiquidLexer(stream, this.templateParser.isStripSpacesAroundTags(),
                 this.templateParser.isStripSingleLine(), blockNames, tagNames);
+        this.sourceName = IntStream.UNKNOWN_SOURCE_NAME.equals(stream.getSourceName()) ? null : stream.getSourceName();
         try {
             root = parse(lexer);
         } catch (LiquidException e) {
@@ -355,13 +353,18 @@ public Object renderToObjectUnguarded(Map<String, Object> variables, TemplateCon
         variables = templateParser.evaluate(templateParser.mapper, variables);
 
         final NodeVisitor visitor = new NodeVisitor(templateParser.insertions, templateParser.filters, templateParser.liquidStyleInclude);
+        Deque<String> includeStack = null;
         try {
             LNode node = visitor.visit(root);
             if (parent == null) {
                 this.templateContext = newRootContext(variables);
             } else {
                 this.templateContext = parent.newChildContext(variables);
             }
+
+            includeStack = getIncludeStackFromRegistry(templateContext);
+            includeStack.push(sourceName);
+
             if (this.contextHolder != null) {
                 contextHolder.setContext(templateContext);
             }
@@ -375,9 +378,18 @@ public Object renderToObjectUnguarded(Map<String, Object> variables, TemplateCon
             } else {
                 throw new RuntimeException(e);
             }
+        } finally {
+            if (includeStack != null) {
+                includeStack.pop();
+            }
         }
     }
 
+    public static Deque<String> getIncludeStackFromRegistry(TemplateContext templateContext) {
+        Map<String, Deque<String>> registry = templateContext.getRegistry(TemplateContext.REGISTRY_SOURCE_NAME);
+        return registry.putIfAbsent(TemplateContext.REGISTRY_SOURCE_NAME, new LinkedList<>());
+    }
+
     /**
      * Renders the template using parent context
      * 

diff --git a/src/main/java/liqp/TemplateContext.java b/src/main/java/liqp/TemplateContext.java
@@ -17,6 +17,7 @@ public class TemplateContext {
     public static final String REGISTRY_FOR = "for";
     public static final String REGISTRY_FOR_STACK = "for_stack";
     public static final String REGISTRY_ITERATION_PROTECTOR = "iteration_protector";
+    public static final String REGISTRY_SOURCE_NAME = "registry_source_name";
 
     protected TemplateContext parent;
 
@@ -164,7 +165,7 @@ public Map<String, Object> getEnvironmentMap() {
             return parent.getRegistry(registryName);
         }
 
-        if (!Arrays.asList(REGISTRY_CYCLE, REGISTRY_IFCHANGED, REGISTRY_FOR, REGISTRY_FOR_STACK, REGISTRY_ITERATION_PROTECTOR)
+        if (!Arrays.asList(REGISTRY_CYCLE, REGISTRY_IFCHANGED, REGISTRY_FOR, REGISTRY_FOR_STACK, REGISTRY_ITERATION_PROTECTOR, REGISTRY_SOURCE_NAME)
                 .contains(registryName)) {
             // this checking exists for safety of library, any listed type is expected, not more
             throw new RuntimeException("unknown registry type: " + registryName);

diff --git a/src/main/java/liqp/tags/Include.java b/src/main/java/liqp/tags/Include.java
@@ -1,6 +1,7 @@
 package liqp.tags;
 
 import java.io.File;
+import java.util.Deque;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -13,12 +14,16 @@ public class Include extends Tag {
 
     @Override
     public Object render(TemplateContext context, LNode... nodes) {
-
+        Deque<String> includeStackFromRegistry = Template.getIncludeStackFromRegistry(context);
+        boolean pushedStack = false;
         try {
             String includeResource = super.asString(nodes[0].render(context), context);
 
             CharStream source = context.getParser().nameResolver.resolve(includeResource);
 
+            includeStackFromRegistry.push(source.getSourceName());
+            pushedStack = true;
+
             Template template = context.getParser().parse(source);
 
             Map<String, Object> variables = new HashMap<String, Object>();
@@ -47,6 +52,11 @@ public Object render(TemplateContext context, LNode... nodes) {
             } else {
                 return "";
             }
+        } finally {
+            // flag variable in case exception is thrown before we push to the stack
+            if (pushedStack) {
+                includeStackFromRegistry.pop();
+            }
         }
     }
 }