From 4b5847990b41e548ce099d21c7dddef50f159baf Mon Sep 17 00:00:00 2001
From: gmantele <gmantele@ari.uni-heidelberg.de>
Date: Fri, 27 Feb 2015 17:28:56 +0100
Subject: [PATCH] [TAP] Allow the TAP configuration file properties
'file_root_path' and 'metadata_file' be file pathes relative to WebContent.
---
.../config/ConfigurableServiceConnection.java | 35 ++++++++++---
src/tap/config/ConfigurableTAPServlet.java | 2 +-
.../TestConfigurableServiceConnection.java | 51 +++++++++++++++++++
3 files changed, 81 insertions(+), 7 deletions(-)
diff --git a/src/tap/config/ConfigurableServiceConnection.java b/src/tap/config/ConfigurableServiceConnection.java
index ab4be58..c444954 100644
--- a/src/tap/config/ConfigurableServiceConnection.java
+++ b/src/tap/config/ConfigurableServiceConnection.java
@@ -57,6 +57,8 @@ import java.io.File;
import java.io.IOException;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
+import java.net.URI;
+import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
@@ -127,11 +129,15 @@ public final class ConfigurableServiceConnection implements ServiceConnection {
private Collection<FunctionDef> udfs = new ArrayList<FunctionDef>(0);
public ConfigurableServiceConnection(final Properties tapConfig) throws NullPointerException, TAPException, UWSException{
+ this(tapConfig, null);
+ }
+
+ public ConfigurableServiceConnection(final Properties tapConfig, final String webAppRootDir) throws NullPointerException, TAPException, UWSException{
if (tapConfig == null)
throw new NullPointerException("Missing TAP properties! ");
// 1. INITIALIZE THE FILE MANAGER:
- initFileManager(tapConfig);
+ initFileManager(tapConfig, webAppRootDir);
// 2. CREATE THE LOGGER:
initLogger(tapConfig);
@@ -140,7 +146,7 @@ public final class ConfigurableServiceConnection implements ServiceConnection {
initFactory(tapConfig);
// 4. GET THE METADATA:
- metadata = initMetadata(tapConfig);
+ metadata = initMetadata(tapConfig, webAppRootDir);
// 5. SET ALL GENERAL SERVICE CONNECTION INFORMATION:
providerName = getProperty(tapConfig, KEY_PROVIDER_NAME);
@@ -173,7 +179,7 @@ public final class ConfigurableServiceConnection implements ServiceConnection {
initUDFs(tapConfig);
}
- private void initFileManager(final Properties tapConfig) throws TAPException{
+ private void initFileManager(final Properties tapConfig, final String webAppRootDir) throws TAPException{
// Read the desired file manager:
String fileManagerType = getProperty(tapConfig, KEY_FILE_MANAGER);
if (fileManagerType == null)
@@ -187,7 +193,7 @@ public final class ConfigurableServiceConnection implements ServiceConnection {
String rootPath = getProperty(tapConfig, KEY_FILE_ROOT_PATH);
if (rootPath == null)
throw new TAPException("The property \"" + KEY_FILE_ROOT_PATH + "\" is missing! It is required to create a TAP Service. Please provide a path toward a directory which will contain all files related to the service.");
- File rootFile = new File(rootPath);
+ File rootFile = getFile(rootPath, webAppRootDir, KEY_FILE_ROOT_PATH);
// Determine whether there should be one directory for each user:
String propValue = getProperty(tapConfig, KEY_DIRECTORY_PER_USER);
@@ -209,6 +215,23 @@ public final class ConfigurableServiceConnection implements ServiceConnection {
fileManager = newInstance(fileManagerType, KEY_FILE_MANAGER, UWSFileManager.class, new Class<?>[]{Properties.class}, new Object[]{tapConfig});
}
+ protected static final File getFile(final String filePath, final String webAppRootPath, final String propertyName) throws TAPException{
+ if (filePath == null)
+ return null;
+ else if (filePath.startsWith("file:"))
+ try{
+ return new File(new URI(filePath));
+ }catch(URISyntaxException e){
+ throw new TAPException("Incorrect file URI for the property \"" + propertyName + "\": \"" + filePath + "\"! Bad syntax for the given file URI.", e);
+ }
+ else if (filePath.startsWith("/"))
+ return new File(filePath);
+ else if (filePath.matches("[a-zA-Z]+:.*"))
+ throw new TAPException("Incorrect file URI for the property \"" + propertyName + "\": \"" + filePath + "\"! Only URI with the protocol \"file:\" are allowed.");
+ else
+ return new File(webAppRootPath, filePath);
+ }
+
private void initLogger(final Properties tapConfig){
// Create the logger:
logger = new DefaultTAPLog(fileManager);
@@ -245,7 +268,7 @@ public final class ConfigurableServiceConnection implements ServiceConnection {
tapFactory = newInstance(propValue, KEY_TAP_FACTORY, TAPFactory.class, new Class<?>[]{ServiceConnection.class}, new Object[]{this});
}
- private TAPMetadata initMetadata(final Properties tapConfig) throws TAPException{
+ private TAPMetadata initMetadata(final Properties tapConfig, final String webAppRootDir) throws TAPException{
// Get the fetching method to use:
String metaFetchType = getProperty(tapConfig, KEY_METADATA);
if (metaFetchType == null)
@@ -262,7 +285,7 @@ public final class ConfigurableServiceConnection implements ServiceConnection {
// Parse the XML document and build the corresponding metadata:
try{
- metadata = (new TableSetParser()).parse(new File(xmlFilePath));
+ metadata = (new TableSetParser()).parse(getFile(xmlFilePath, webAppRootDir, KEY_METADATA_FILE));
}catch(IOException ioe){
throw new TAPException("A grave error occurred while reading/parsing the TableSet XML document: \"" + xmlFilePath + "\"!", ioe);
}
diff --git a/src/tap/config/ConfigurableTAPServlet.java b/src/tap/config/ConfigurableTAPServlet.java
index 57b1cfa..715a76b 100644
--- a/src/tap/config/ConfigurableTAPServlet.java
+++ b/src/tap/config/ConfigurableTAPServlet.java
@@ -102,7 +102,7 @@ public class ConfigurableTAPServlet extends HttpServlet {
ServiceConnection serviceConn = null;
try{
// Create the service connection:
- serviceConn = new ConfigurableServiceConnection(tapConf);
+ serviceConn = new ConfigurableServiceConnection(tapConf, config.getServletContext().getRealPath(""));
// Create all the TAP resources:
tap = new TAP(serviceConn);
}catch(Exception ex){
diff --git a/test/tap/config/TestConfigurableServiceConnection.java b/test/tap/config/TestConfigurableServiceConnection.java
index 0779702..ccba62d 100644
--- a/test/tap/config/TestConfigurableServiceConnection.java
+++ b/test/tap/config/TestConfigurableServiceConnection.java
@@ -888,6 +888,57 @@ public class TestConfigurableServiceConnection {
}
}
+ @Test
+ public void testGetFile(){
+ final String rootPath = "/ROOT", propertyName = "SuperProperty";
+ String path;
+
+ try{
+ // NULL test => NULL must be returned.
+ assertNull(ConfigurableServiceConnection.getFile(null, rootPath, propertyName));
+
+ // Valid file URI:
+ path = "/custom/user/dir";
+ assertEquals(path, ConfigurableServiceConnection.getFile("file://" + path, rootPath, propertyName).getAbsolutePath());
+
+ // Valid absolute file path:
+ assertEquals(path, ConfigurableServiceConnection.getFile(path, rootPath, propertyName).getAbsolutePath());
+
+ // File name relative to the given rootPath:
+ path = "dir";
+ assertEquals(rootPath + File.separator + path, ConfigurableServiceConnection.getFile(path, rootPath, propertyName).getAbsolutePath());
+
+ // Idem but with a relative file path:
+ path = "gmantele/workspace";
+ assertEquals(rootPath + File.separator + path, ConfigurableServiceConnection.getFile(path, rootPath, propertyName).getAbsolutePath());
+
+ }catch(Exception ex){
+ ex.printStackTrace();
+ fail("None of these tests should have failed!");
+ }
+
+ // Test with a file URI having a bad syntax:
+ path = "file:#toto^foo";
+ try{
+ ConfigurableServiceConnection.getFile(path, rootPath, propertyName);
+ fail("This test should have failed, because the given file URI has a bad syntax!");
+ }catch(Exception ex){
+ assertEquals(TAPException.class, ex.getClass());
+ assertEquals("Incorrect file URI for the property \"" + propertyName + "\": \"" + path + "\"! Bad syntax for the given file URI.", ex.getMessage());
+ }
+
+ // Test with an URL:
+ path = "http://www.google.com";
+ try{
+ ConfigurableServiceConnection.getFile(path, rootPath, propertyName);
+ fail("This test should have failed, because the given URI uses the HTTP protocol (actually, it uses a protocol different from \"file\"!");
+ }catch(Exception ex){
+ assertEquals(TAPException.class, ex.getClass());
+ assertEquals("Incorrect file URI for the property \"" + propertyName + "\": \"" + path + "\"! Only URI with the protocol \"file:\" are allowed.", ex.getMessage());
+ }
+
+ }
+
public static final String getPertinentMessage(final Exception ex){
return (ex.getCause() == null || ex.getMessage().equals(ex.getCause().getMessage())) ? ex.getMessage() : ex.getCause().getMessage();
}
--
GitLab