add option to disable escaping; update documentation

panc-docs/src/docbkx/appendix/appendix-commands.xml

@@ -62,6 +62,8 @@
 
         <arg>--nthread <replaceable>number</replaceable></arg>
 
+        <arg>--no-disable-escaping | --disable-escaping</arg>
+
         <arg>--logging <replaceable>string</replaceable></arg>
 
         <arg>--log-file <replaceable>file</replaceable></arg>
@@ -204,6 +206,16 @@
           </listitem>
         </varlistentry>
 
+        <varlistentry>
+          <term><option>--no-disable-escaping,
+          --disable-escaping</option></term>
+
+          <listitem>
+            <para>Enable or disable the escaping of path elements. The default
+            value is to enable the escaping of path elements.</para>
+          </listitem>
+        </varlistentry>
+
         <varlistentry>
           <term><option>--logging=<replaceable>string</replaceable></option></term>
 

panc-docs/src/docbkx/appendix/appendix-run-panc.xml

@@ -323,6 +323,14 @@ $ mvn clean install
 
             <entry>No. Default value: 0.</entry>
           </row>
+
+          <row>
+            <entry>disableEscaping</entry>
+
+            <entry>Disable the escaping of path elements.</entry>
+
+            <entry>No. Default value: false.</entry>
+          </row>
         </tbody>
       </tgroup>
     </table>
@@ -640,6 +648,14 @@ $ mvn clean install
 
             <entry>No. Default value: 0</entry>
           </row>
+
+          <row>
+            <entry>disableEscaping</entry>
+
+            <entry>Disable the escaping of path elements.</entry>
+
+            <entry>No. Default value: false</entry>
+          </row>
         </tbody>
       </tgroup>
     </table>

panc-maven-plugin/src/main/java/org/quattor/maven/PanBuildMojo.java

@@ -90,6 +90,14 @@ public class PanBuildMojo extends AbstractPanMojo {
      */
     private int nthread = 0;
 
+    /**
+     * disable escaping/unescaping of path elements
+     *
+     * @parameter property="panc.disableEscaping" default-value=false
+     * @required
+     */
+    private boolean disableEscaping = false;
+
     /**
      * logging types
      *
@@ -155,7 +163,7 @@ private CompilerOptions createCompilerOptions()
             return new CompilerOptions(Pattern.compile(debugNsInclude),
                     Pattern.compile(debugNsExclude), maxIteration,
                     maxRecursion, formatters, outputDir, includeDirectories,
-                    warningsFromString(warnings), null, null, initialData, nthread);
+                    warningsFromString(warnings), null, null, initialData, nthread, disableEscaping);
 
         } catch (SyntaxException e) {
             throw new MojoExecutionException(

panc/src/main/clojure/org/quattor/pan/pan_compiler.clj

@@ -35,7 +35,8 @@ Please file a bug report including the stack trace.
                 annotationDirectory
                 annotationBaseDirectory
                 rootElement
-                nthread]} settings/*settings*]
+                nthread
+                disableEscaping]} settings/*settings*]
     (CompilerOptions. debug-ns-include
                       debug-ns-exclude
                       max-iteration
@@ -47,7 +48,8 @@ Please file a bug report including the stack trace.
                       annotationDirectory
                       annotationBaseDirectory
                       rootElement
-                      nthread)))
+                      nthread
+                      disableEscaping)))
 
 (defn default-compiler-options []
   (let [{:keys [debug-ns-include
@@ -61,7 +63,8 @@ Please file a bug report including the stack trace.
                 annotationDirectory
                 annotationBaseDirectory
                 rootElement
-                nthread]} (settings/defaults)]
+                nthread
+                disableEscaping]} (settings/defaults)]
     (CompilerOptions. debug-ns-include
                       debug-ns-exclude
                       max-iteration
@@ -73,7 +76,8 @@ Please file a bug report including the stack trace.
                       annotationDirectory
                       annotationBaseDirectory
                       rootElement
-                      nthread)))
+                      nthread
+                      disableEscaping)))
 
 (defn parse-int
   [^String s]
@@ -94,11 +98,12 @@ Please file a bug report including the stack trace.
    [nil "--max-iteration LIMIT" "set max. no. of iterations" :default "10000"]
    [nil "--max-recursion LIMIT" "set max. depth of recursion" :default "50"]
    [nil "--nthread NUM" "no. of executor threads (0=no. CPU)" :default "0"]
+   [nil "--disable-escaping" "disable path element escaping" :default false]
    [nil "--logging LOG_TYPES" "set logging types"]
    [nil "--log-file FILE" "specify log file"]
    [nil "--warnings FLAG" "off, on, fatal" :default "on"]
-   ["-v" "--verbose" "show statistics and progress" :default false :flag true]
-   ["-h" "--help" "print command help" :default false :flag true]])
+   ["-v" "--verbose" "show statistics and progress" :default false]
+   ["-h" "--help" "print command help" :default false]])
 
 (defn banner-and-exit [banner]
   (println (str "\npanc [options] [pan source files...]\n\n" banner))

panc/src/main/clojure/org/quattor/pan/settings.clj

@@ -30,7 +30,8 @@
    :annotationDirectory nil
    :annotationBaseDirectory nil
    :rootElement nil
-   :nthread 0})
+   :nthread 0
+   :disableEscaping false})
 
 (def ^:dynamic *settings* (defaults))
 

panc/src/main/java/org/quattor/ant/PanCompilerTask.java

@@ -89,6 +89,8 @@ public class PanCompilerTask extends Task {
 
     private int nthread = 0;
 
+    private boolean disableEscaping = false;
+
     private int maxIteration = 10000;
 
     private int maxRecursion = 50;
@@ -136,7 +138,7 @@ public void execute() throws BuildException {
         try {
             options = new CompilerOptions(debugNsInclude, debugNsExclude,
                     maxIteration, maxRecursion, formatters, outputDir, includeDirectories,
-                    deprecationWarnings, null, null, initialData, nthread);
+                    deprecationWarnings, null, null, initialData, nthread, disableEscaping);
         } catch (SyntaxException e) {
             throw new BuildException("invalid root element: " + e.getMessage());
         }
@@ -496,6 +498,14 @@ public void setNthread(int nthread) {
         this.nthread = (nthread > 0) ? nthread : 0;
     }
 
+    public boolean getDisableEscaping() {
+        return disableEscaping;
+    }
+
+    public void setDisableEscaping(boolean disableEscaping) {
+        this.disableEscaping = disableEscaping;
+    }
+
     /**
      * This utility method will group the file into a set of equal sized batches
      * (except for possibly the last batch).

panc/src/main/java/org/quattor/pan/CompilerOptions.java

@@ -136,6 +136,8 @@ public static DeprecationWarnings fromString(String s) {
 
     public final int nthread;
 
+    public final boolean disableEscapes;
+
     /**
      * Construct a CompilerOptions instance to drive a Compiler run. Instances
      * of this class are immutable.
@@ -169,13 +171,16 @@ public static DeprecationWarnings fromString(String s) {
      * @param nthread
      *            number of threads to use for each executor queue; 0 uses number
      *            of CPU cores on the machine
+     * @param disableEscapes
+     *            disable the escaping and unescaping functions for path
+     *            elements
      * @throws SyntaxException
      *             if the expression for the rootElement is invalid
      */
     public CompilerOptions(Pattern debugNsInclude, Pattern debugNsExclude, int maxIteration, int maxRecursion, Set
             <Formatter> formatters,
                            File outputDirectory, List<File> includeDirectories, DeprecationWarnings deprecationWarnings, File annotationDirectory,
-                           File annotationBaseDirectory, String rootElement, int nthread)
+                           File annotationBaseDirectory, String rootElement, int nthread, boolean disableEscapes)
             throws SyntaxException {
 
         // Check that the iteration and call depth limits are sensible. If
@@ -260,6 +265,8 @@ public CompilerOptions(Pattern debugNsInclude, Pattern debugNsExclude, int maxIt
         } else {
             this.nthread = nthread;
         }
+
+        this.disableEscapes = disableEscapes;
     }
 
     // Utility method to turn old options into new deprecation flag.
@@ -299,7 +306,7 @@ public static CompilerOptions createCheckSyntaxOptions(
             return new CompilerOptions(debugNsInclude, debugNsExclude,
                     maxIteration, maxRecursion, formatters, outputDirectory,
                     includeDirectories, deprecationWarnings,
-                    annotationDirectory, annotationBaseDirectory, null, 0);
+                    annotationDirectory, annotationBaseDirectory, null, 0, false);
 
         } catch (SyntaxException consumed) {
             throw CompilerError.create(MSG_FILE_BUG_REPORT);
@@ -330,7 +337,7 @@ public static CompilerOptions createAnnotationOptions(
             return new CompilerOptions(debugNsInclude, debugNsExclude,
                     maxIteration, maxRecursion, formatters, outputDirectory,
                     includeDirectories, DeprecationWarnings.OFF,
-                    annotationDirectory, annotationBaseDirectory, null, 0);
+                    annotationDirectory, annotationBaseDirectory, null, 0, false);
 
         } catch (SyntaxException consumed) {
             throw CompilerError.create(MSG_FILE_BUG_REPORT);
@@ -418,9 +425,8 @@ public Set<File> resolveFileList(List<String> objectNames,
                 if (!source.isAbsent()) {
                     filesToProcess.add(source.getPath());
                 } else {
-                    throw EvaluationException.create((SourceRange) null,
-                            (Context) null, MSG_CANNOT_LOCATE_OBJECT_TEMPLATE,
-                            oname);
+                    throw EvaluationException.create((SourceRange) null, (Context) null,
+                            MSG_CANNOT_LOCATE_OBJECT_TEMPLATE, oname);
                 }
             }
         }

panc/src/test/java/org/quattor/pan/CompilerOptionsTest.java

@@ -58,7 +58,7 @@ public void testConstructorAndGetters1() throws SyntaxException {
         CompilerOptions options = new CompilerOptions(null, null,
                 iterationLimit, callDepthLimit, formatters, outputDirectory,
                 includeDirectories, CompilerOptions.DeprecationWarnings.ON,
-                null, null, null, 0);
+                null, null, null, 0, false);
 
         assertTrue(iterationLimit == options.maxIteration);
         assertTrue(callDepthLimit == options.maxRecursion);
@@ -84,7 +84,7 @@ public void testConstructorAndGetters2() throws SyntaxException {
         CompilerOptions options = new CompilerOptions(null, null,
                 iterationLimit, callDepthLimit, formatters, outputDirectory,
                 includeDirectories, CompilerOptions.DeprecationWarnings.ON,
-                null, null, null, 0);
+                null, null, null, 0, false);
 
         assertTrue(iterationLimit == options.maxIteration);
         assertTrue(callDepthLimit == options.maxRecursion);
@@ -110,7 +110,7 @@ public void checkUnlimitedValues() throws SyntaxException {
         CompilerOptions options = new CompilerOptions(null, null,
                 iterationLimit, callDepthLimit, formatters, outputDirectory,
                 includeDirectories, CompilerOptions.DeprecationWarnings.ON,
-                null, null, null, 0);
+                null, null, null, 0, false);
 
         assertTrue(Integer.MAX_VALUE == options.maxIteration);
         assertTrue(Integer.MAX_VALUE == options.maxRecursion);
@@ -131,7 +131,7 @@ public void checkBadOutputDirectory() throws SyntaxException {
 
         new CompilerOptions(null, null, iterationLimit, callDepthLimit,
                 formatters, outputDirectory, includeDirectories,
-                CompilerOptions.DeprecationWarnings.ON, null, null, null, 0);
+                CompilerOptions.DeprecationWarnings.ON, null, null, null, 0, false);
     }
 
     @Test(expected = IllegalArgumentException.class)
@@ -149,7 +149,7 @@ public void checkIncludeDirectory() throws SyntaxException {
 
         new CompilerOptions(null, null, iterationLimit, callDepthLimit,
                 formatters, outputDirectory, includeDirectories,
-                CompilerOptions.DeprecationWarnings.ON, null, null, null, 0);
+                CompilerOptions.DeprecationWarnings.ON, null, null, null, 0, false);
     }
 
     @Test(expected = IllegalArgumentException.class)
@@ -167,7 +167,7 @@ public void checkMissingOutputDirectory1() throws SyntaxException {
 
         new CompilerOptions(null, null, iterationLimit, callDepthLimit,
                 formatters, outputDirectory, includeDirectories,
-                CompilerOptions.DeprecationWarnings.ON, null, null, null, 0);
+                CompilerOptions.DeprecationWarnings.ON, null, null, null, 0, false);
     }
 
     @Test(expected = IllegalArgumentException.class)
@@ -184,7 +184,7 @@ public void checkMissingOutputDirectory2() throws SyntaxException {
 
         new CompilerOptions(null, null, iterationLimit, callDepthLimit,
                 formatters, outputDirectory, includeDirectories,
-                CompilerOptions.DeprecationWarnings.ON, null, null, null, 0);
+                CompilerOptions.DeprecationWarnings.ON, null, null, null, 0, false);
     }
 
     @Test(expected = IllegalArgumentException.class)
@@ -202,7 +202,7 @@ public void checkNullIncludeDirectory() throws SyntaxException {
 
         new CompilerOptions(null, null, iterationLimit, callDepthLimit,
                 formatters, outputDirectory, includeDirectories,
-                CompilerOptions.DeprecationWarnings.ON, null, null, null, 0);
+                CompilerOptions.DeprecationWarnings.ON, null, null, null, 0, false);
     }
 
     @Test

panc/src/test/java/org/quattor/pan/JavaCompilerTest.java

@@ -69,7 +69,7 @@ protected Compiler getDefaultCompiler(File tplfile, File dir,
 		formatters.add(DepFormatter.getInstance());
 		CompilerOptions options = new CompilerOptions(null, null, 100, 50,
 				formatters, getTmpdir(), path,
-				CompilerOptions.DeprecationWarnings.ON, null, null, null, 0);
+				CompilerOptions.DeprecationWarnings.ON, null, null, null, 0, false);
 		List<File> tplfiles = new LinkedList<File>();
 		tplfiles.add(tplfile);
 		return new Compiler(options, new LinkedList<String>(), tplfiles);
@@ -86,7 +86,7 @@ protected Compiler getRootElementCompiler(File tplfile, File dir,
 		CompilerOptions options = new CompilerOptions(null, null, 100, 50,
 				formatters, getTmpdir(), path,
 				CompilerOptions.DeprecationWarnings.ON, null, null,
-				"nlist('root-element-test', 'OK')", 0);
+				"nlist('root-element-test', 'OK')", 0, false);
 		List<File> tplfiles = new LinkedList<File>();
 		tplfiles.add(tplfile);
 		return new Compiler(options, new LinkedList<String>(), tplfiles);
@@ -103,7 +103,7 @@ protected Compiler getDependencyCompiler(File tplfile, File dir)
 		formatters.add(DepFormatter.getInstance());
 		CompilerOptions options = new CompilerOptions(null, null, 100, 50,
 				formatters, getTmpdir(), path,
-				CompilerOptions.DeprecationWarnings.ON, null, null, null, 0);
+				CompilerOptions.DeprecationWarnings.ON, null, null, null, 0, false);
 		List<File> tplfiles = new LinkedList<File>();
 		tplfiles.add(tplfile);
 		return new Compiler(options, new LinkedList<String>(), tplfiles);
@@ -122,7 +122,7 @@ public void testErrorOnMissingObjectFile() throws SyntaxException {
 		formatters.add(DepFormatter.getInstance());
 		CompilerOptions options = new CompilerOptions(null, null, 100, 50,
 				formatters, getTmpdir(), path,
-				CompilerOptions.DeprecationWarnings.ON, null, null, null, 0);
+				CompilerOptions.DeprecationWarnings.ON, null, null, null, 0, false);
 
 		List<String> objects = new LinkedList<String>();
 		objects.add("non-existant/object/template");
@@ -168,7 +168,7 @@ public void testErrorOnMisplacedObjectFile() throws FileNotFoundException,
 
 		CompilerOptions options = new CompilerOptions(null, null, 100, 50,
 				formatters, tmpdir, path,
-				CompilerOptions.DeprecationWarnings.ON, null, null, null, 0);
+				CompilerOptions.DeprecationWarnings.ON, null, null, null, 0, false);
 
 		// Create the list of input files.
 		List<File> tplfiles = new LinkedList<File>();

panc/src/test/java/org/quattor/pan/statement/StatementTestUtils.java

@@ -80,7 +80,7 @@ protected void runExpectingException(String name, String statement)
 
 		CompilerOptions options = new CompilerOptions(null, null, 1000, 50,
 				formatters, tmpfile, paths, CompilerOptions.DeprecationWarnings.OFF, null, null,
-				null, 0);
+				null, 0, false);
 
 		Compiler compiler = new Compiler(options, new LinkedList<String>(),
 				files);
@@ -124,7 +124,7 @@ protected Context setupTemplateToRun2(String name, String statement,
 
 		CompilerOptions options = new CompilerOptions(null, null, 1000, 50,
 				formatters, tmpfile, paths, CompilerOptions.DeprecationWarnings.OFF, null, null,
-				null, 0);
+				null, 0, false);
 
 		Compiler compiler = new Compiler(options, new LinkedList<String>(),
 				files);
@@ -176,7 +176,7 @@ protected Context setupTemplateToRun3(String name, String statement1,
 
 		CompilerOptions options = new CompilerOptions(null, null, 1000, 50,
 				formatters, tmpfile, paths, CompilerOptions.DeprecationWarnings.OFF, null, null,
-				null, 0);
+				null, 0, false);
 
 		Compiler compiler = new Compiler(options, new LinkedList<String>(),
 				files);