#89 Handling spaces in asset directory paths

Author: rjrudin

src/main/java/com/marklogic/client/ext/modulesloader/impl/BaseModulesFinder.java

@@ -13,7 +13,6 @@
 import java.io.File;
 import java.io.FilenameFilter;
 import java.io.IOException;
-import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -62,7 +61,13 @@ protected void addAssetDirectories(Modules modules, String baseDir) {
 		// classpath needs the trailing / to find child dirs
 		findResources("asset module directories", baseDir, "*", "*/").stream().forEach(resource -> {
 			try {
-				File f = new File(resource.getURL().getFile());
+				String resourceFile = resource.getURL().getFile();
+				if (logger.isDebugEnabled()) {
+					logger.debug("Checking resource to see if it's a valid asset directory: " + resourceFile);
+				}
+
+				resourceFile = decodeAssetDirectoryResource(resourceFile);
+				File f = new File(resourceFile);
 				String uri = resource.getURI().toString();
 				boolean isRecognized = recognizedPaths.contains(f.getName());
 				// when the modules are in a jar inside a war
@@ -81,6 +86,29 @@ protected void addAssetDirectories(Modules modules, String baseDir) {
         modules.setAssetDirectories(dirs);
     }
 
+	/**
+	 * There may be other characters that need decoding, but for now, only %20 is being converted back into a space.
+	 *
+	 * The reason %20 exists is because a Resource that represents a potential asset directory is accessed as a URL in
+	 * order to support jar and war files. Accessing the directory as a URL results in spaces being converted to %20.
+	 * In order to construct a File, these must be converted back into spaces.
+	 *
+	 * It may be that performing a full URL decoding on the resourceFile is the correct solution, just don't have enough
+	 * test cases to know that this is safe for sure.
+	 *
+	 * @param resourceFile
+	 * @return
+	 */
+	protected String decodeAssetDirectoryResource(String resourceFile) {
+	    if (resourceFile.contains("%20")) {
+		    resourceFile = resourceFile.replaceAll("%20", " ");
+		    if (logger.isDebugEnabled()) {
+			    logger.debug("Replaced occurrences of %20 with a space in potential asset directory: " + resourceFile);
+		    }
+	    }
+	    return resourceFile;
+    }
+
     protected List<String> getRecognizedPaths() {
         return Arrays.asList(optionsPath, servicesPath, transformsPath, namespacesPath, schemasPath);
     }

src/test/java/com/marklogic/client/ext/modulesloader/impl/LoadModulesTest.java

@@ -2,6 +2,8 @@
 
 import com.marklogic.client.DatabaseClient;
 import com.marklogic.client.ext.AbstractIntegrationTest;
+import com.marklogic.client.ext.modulesloader.Modules;
+import com.marklogic.client.ext.modulesloader.ModulesFinder;
 import com.marklogic.client.ext.tokenreplacer.DefaultTokenReplacer;
 import com.marklogic.client.io.BytesHandle;
 import com.marklogic.client.io.StringHandle;
@@ -10,6 +12,7 @@
 import org.springframework.core.io.Resource;
 
 import java.nio.file.Paths;
+import java.util.List;
 import java.util.Properties;
 import java.util.Set;
 import java.util.regex.Pattern;
@@ -39,6 +42,20 @@ public void setup() {
 		modulesLoader.setModulesManager(null);
 	}
 
+	@Test
+	public void pathWithSpaces() {
+		String dir = Paths.get("src", "test", "resources", "path with spaces").toString();
+		ModulesFinder finder = new DefaultModulesFinder();
+		Modules modules = finder.findModules(dir);
+		List<Resource> assetDirectories = modules.getAssetDirectories();
+		assertEquals("Expecting one directory, the 'root' directory", 1, assetDirectories.size());
+
+		// Now load the modules for real
+		modulesLoader.loadModules(dir, finder, client);
+		String moduleXml = modulesClient.newXMLDocumentManager().read("/example/example.xqy", new StringHandle()).get();
+		assertEquals("<example/>", moduleXml.trim());
+	}
+
 	/**
 	 * This test is a little brittle because it assumes the URI of options/services/transforms that are loaded
 	 * into the Modules database.

src/test/resources/path with spaces/root/example/example.xqy

@@ -0,0 +1 @@
+<example/>