refactoring

Author: raydac

jcp/src/main/java/com/igormaznitsa/jcp/context/PreprocessorContext.java

@@ -69,29 +69,28 @@ public class PreprocessorContext {
       List.of("java", "txt", "htm", "html");
   public static final List<String> DEFAULT_EXCLUDED_EXTENSIONS = singletonList("xml");
   public static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
-
+  private static final List<AbstractDirectiveHandler> directiveHandlers =
+      AbstractDirectiveHandler.findAllDirectives();
   private final Map<String, Value> globalVarTable = new HashMap<>();
   private final Map<String, Value> localVarTable = new HashMap<>();
   private final Map<String, SpecialVariableProcessor> mapVariableNameToSpecialVarProcessor =
       new HashMap<>();
   private final Map<String, Object> sharedResources = new HashMap<>();
   private final List<File> configFiles = new ArrayList<>();
-
   @Setter(AccessLevel.NONE)
   private final boolean cloned;
   @Setter(AccessLevel.NONE)
   private final TextFileDataContainer currentInCloneSource;
   private final List<SourceFolder> sources = new ArrayList<>();
   private final File baseDir;
   private final Collection<File> activatedConfigFiles;
-
   @Setter(AccessLevel.NONE)
   @Getter(AccessLevel.NONE)
   private final Collection<FileInfoContainer> preprocessedResources;
-
   @Setter(AccessLevel.NONE)
   @Getter(AccessLevel.NONE)
   private final AtomicReference<PreprocessingState> preprocessingState = new AtomicReference<>();
+  private final List<CommentTextProcessor> commentTextProcessors;
   private String eol = GetUtils
       .ensureNonNull(System.getProperty("jcp.line.separator", System.getProperty("line.separator")),
           "\n");
@@ -116,8 +115,6 @@ public class PreprocessorContext {
   @Setter(AccessLevel.NONE)
   private PreprocessorLogger preprocessorLogger = new SystemOutLogger();
   private List<String> excludeFolders = new ArrayList<>();
-  private static final List<AbstractDirectiveHandler> directiveHandlers = AbstractDirectiveHandler.findAllDirectives();
-  private final List<CommentTextProcessor> commentTextProcessors;
 
   /**
    * Constructor
@@ -135,7 +132,7 @@ public PreprocessorContext(final File baseDir) {
     this.currentInCloneSource = null;
     this.commentTextProcessors = new ArrayList<>();
     this.preprocessingState
-            .set(new PreprocessingState(this, this.sourceEncoding, this.targetEncoding));
+        .set(new PreprocessingState(this, this.sourceEncoding, this.targetEncoding));
   }
 
   /**
@@ -200,6 +197,52 @@ public PreprocessorContext(final PreprocessorContext context) {
     this.currentInCloneSource = context.getPreprocessingState().peekFile();
   }
 
+  private static String makeStackView(
+      final TextFileDataContainer cloneSource,
+      final boolean cloned,
+      final List<TextFileDataContainer> list
+  ) {
+    if (list == null || list.isEmpty()) {
+      return "";
+    }
+    final StringBuilder builder = new StringBuilder();
+    int tab = 5;
+
+    builder.append(" ".repeat(tab));
+
+    builder.append('{');
+    if (cloned) {
+      builder.append(cloneSource == null ? "*No src info" :
+          "*" + cloneSource.getFile().getName() + ':' + cloneSource.getNextStringIndex());
+    } else {
+      builder.append("File chain");
+    }
+    builder.append('}');
+    tab += 5;
+
+    int fileIndex = 1;
+    for (int i = list.size() - 1; i >= 0; i--) {
+      final TextFileDataContainer cur = list.get(i);
+      builder.append('\n');
+      builder.append(" ".repeat(Math.max(0, tab)));
+      builder.append("└>");
+      builder.append(fileIndex++).append(". ");
+      builder.append(cur.getFile().getName()).append(':').append(cur.getLastReadStringIndex() + 1);
+      tab += 3;
+    }
+
+    return builder.toString();
+  }
+
+  private static Charset decodeCharset(final String charsetName) {
+    final String normalized = charsetName.trim();
+    if (Charset.isSupported(normalized)) {
+      return Charset.forName(normalized);
+    } else {
+      throw new IllegalArgumentException("Unsupported charset: " + charsetName);
+    }
+  }
+
   /**
    * Add comment text processor.
    *
@@ -222,6 +265,7 @@ public void removeCommentTextProcessor(final CommentTextProcessor commentTextPro
 
   /**
    * Get all directive handlers allowed for processing.
+   *
    * @return list of direction handlers for the context
    * @since 7.0.6
    */
@@ -268,52 +312,6 @@ public void fireNotificationStop(final Throwable error) {
         .values().forEach(x -> x.onContextStopped(this, error));
   }
 
-  private static String makeStackView(
-      final TextFileDataContainer cloneSource,
-      final boolean cloned,
-      final List<TextFileDataContainer> list
-  ) {
-    if (list == null || list.isEmpty()) {
-      return "";
-    }
-    final StringBuilder builder = new StringBuilder();
-    int tab = 5;
-
-    builder.append(" ".repeat(tab));
-
-    builder.append('{');
-    if (cloned) {
-      builder.append(cloneSource == null ? "*No src info" :
-          "*" + cloneSource.getFile().getName() + ':' + cloneSource.getNextStringIndex());
-    } else {
-      builder.append("File chain");
-    }
-    builder.append('}');
-    tab += 5;
-
-    int fileIndex = 1;
-    for (int i = list.size() - 1; i >= 0; i--) {
-      final TextFileDataContainer cur = list.get(i);
-      builder.append('\n');
-      builder.append(" ".repeat(Math.max(0, tab)));
-      builder.append("└>");
-      builder.append(fileIndex++).append(". ");
-      builder.append(cur.getFile().getName()).append(':').append(cur.getLastReadStringIndex() + 1);
-      tab += 3;
-    }
-
-    return builder.toString();
-  }
-
-  private static Charset decodeCharset(final String charsetName) {
-    final String normalized = charsetName.trim();
-    if (Charset.isSupported(normalized)) {
-      return Charset.forName(normalized);
-    } else {
-      throw new IllegalArgumentException("Unsupported charset: " + charsetName);
-    }
-  }
-
   /**
    * Find all files which have been used during preprocess, it includes configs, source files, copied files,
    * generated files, included files and binary files used by functions. Excluded files are not added if
@@ -841,13 +839,40 @@ public File createDestinationFileForPath(final String path) {
   }
 
   /**
-   * Finds file in source folders, the file can be found only inside source folders and external placement is disabled for security purposes.
+   * Ensure that the file is in the project folder hierarchy.
+   *
+   * @param file the file to be checked
+   * @return true if there is no info about hierarchy or the file in the hierarchy, false if the file is outbounds
+   * @since 7.2.1
+   */
+  public boolean isFileInBaseDir(final File file) {
+    final String normalizedPath =
+        FilenameUtils.normalizeNoEndSeparator(file.getAbsolutePath());
+    return normalizedPath.startsWith(
+        FilenameUtils.normalizeNoEndSeparator(this.baseDir.getAbsolutePath()));
+  }
+
+  /**
+   * It finds file among source folders, the file can be found only among source folders and
+   * any outside place is disabled for security purposes.
    *
    * @param path the file path to find, it must not be null and must be existing file
-   * @return detected file object for the path, must not be null
-   * @throws IOException if it is impossible to find a file for the path
+   * @return found existing file object for the path, must not be null
    */
-  public File findFileInSources(final String path) throws IOException {
+  public File findFileInSources(final String path) {
+    return this.findFileInSources(path, true);
+  }
+
+  /**
+   * It finds file among source folders, the file can be found only among source folders and
+   * any outside place is disabled for security purposes.
+   *
+   * @param path      the file path to find, it must not be null and must be existing file
+   * @param mustExist if true then the file must exist, false otherwise
+   * @return created file object for the path
+   * @since 7.2.1
+   */
+  public File findFileInSources(final String path, final boolean mustExist) {
     if (path == null) {
       throw makeException("File path is null", null);
     }
@@ -890,7 +915,7 @@ public File findFileInSources(final String path) throws IOException {
       final List<File> setOfFoundFiles = new ArrayList<>();
       getSources().stream().map((root) -> new File(root.getAsFile(), path))
           .filter((variant) -> (variant.exists() && variant.isFile())).forEachOrdered(
-          setOfFoundFiles::add);
+              setOfFoundFiles::add);
 
       if (setOfFoundFiles.size() == 1) {
         result = setOfFoundFiles.get(0);
@@ -904,7 +929,7 @@ public File findFileInSources(final String path) throws IOException {
       if (result == null) {
         throw makeException("Can't find file for path '" + path +
             "' among source files registered for preprocessing.", null);
-      } else if (!result.isFile()) {
+      } else if (mustExist && !result.isFile()) {
         throw makeException("File '" + PreprocessorUtils.getFilePath(result) +
             "' is either not found or not a file", null);
       }

jcp/src/main/java/com/igormaznitsa/jcp/expression/functions/FunctionBINFILE.java

@@ -199,12 +199,7 @@ public Value executeStrStr(final PreprocessorContext context, final Value strFil
     final int lengthOfLine = hasSplitFlag(encodeTypeAsString, type) ? 80 : -1;
     final boolean doDeflate = hasDeflateFlag(encodeTypeAsString, type);
 
-    final File theFile;
-    try {
-      theFile = context.findFileInSources(filePath);
-    } catch (IOException ex) {
-      throw context.makeException("Can't find bin file '" + filePath + '\'', null);
-    }
+    final File theFile = context.findFileInSources(filePath);
 
     if (context.isVerbose()) {
       context.logForVerbose("Loading content of bin file '" + theFile + '\'');

jcp/src/main/java/com/igormaznitsa/jcp/expression/functions/FunctionEVALFILE.java

@@ -31,7 +31,6 @@
 import com.igormaznitsa.jcp.expression.Value;
 import com.igormaznitsa.jcp.expression.ValueType;
 import java.io.File;
-import java.io.IOException;
 import java.io.StringWriter;
 
 /**
@@ -87,13 +86,7 @@ private PreprocessorContext prepareContext(final PreprocessorContext base) {
 
   public Value executeStr(final PreprocessorContext context, final Value strFilePath) {
     final String filePath = strFilePath.asString();
-
-    final File fileToEvaluate;
-    try {
-      fileToEvaluate = context.findFileInSources(filePath);
-    } catch (IOException ex) {
-      throw context.makeException("Can't get get source file '" + filePath + '\'', null);
-    }
+    final File fileToEvaluate = context.findFileInSources(filePath);
 
     if (context.isVerbose()) {
       context.logForVerbose("Eval file '" + fileToEvaluate + '\'');

jcp/src/main/java/com/igormaznitsa/jcp/expression/functions/xml/FunctionXML_OPEN.java

@@ -23,7 +23,6 @@
 
 import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findFirstActiveFileContainer;
 
-
 import com.igormaznitsa.jcp.context.PreprocessorContext;
 import com.igormaznitsa.jcp.expression.Value;
 import com.igormaznitsa.jcp.expression.ValueType;
@@ -61,13 +60,7 @@ public Value executeStr(final PreprocessorContext context, final Value filePath)
 
     NodeContainer docContainer = (NodeContainer) context.getSharedResource(documentId);
     if (docContainer == null) {
-      File file;
-      try {
-        file = context.findFileInSources(name);
-      } catch (IOException unexpected) {
-        throw context.makeException("Can't read '" + name + '\'', null);
-      }
-
+      final File file = context.findFileInSources(name);
       final Document document = openFileAndParse(context, file);
 
       findFirstActiveFileContainer(context)