Merged #110 "Support multiple/chained config files"

2 files changed, 69 insertions, 7 deletions

diff --git a/src/main/java/com/gitblit/FileSettings.java b/src/main/java/com/gitblit/FileSettings.java
index 21a20435..3caf966b 100644
--- a/src/main/java/com/gitblit/FileSettings.java
+++ b/src/main/java/com/gitblit/FileSettings.java
@@ -18,10 +18,13 @@ package com.gitblit;
 import java.io.File;

 import java.io.FileInputStream;

 import java.io.FileNotFoundException;

+import java.io.IOException;

+import java.util.List;

 import java.util.Map;

 import java.util.Properties;

 

 import com.gitblit.utils.FileUtils;

+import com.gitblit.utils.StringUtils;

 

 /**

  * Dynamically loads and reloads a properties file by keeping track of the last

@@ -77,10 +80,14 @@ public class FileSettings extends IStoredSettings {
 		if (propertiesFile != null && propertiesFile.exists() && (forceReload || (propertiesFile.lastModified() > lastModified))) {

 			FileInputStream is = null;

 			try {

+				logger.debug("loading {}", propertiesFile);

 				Properties props = new Properties();

 				is = new FileInputStream(propertiesFile);

 				props.load(is);

 

+				// ticket-110

+				props = readIncludes(props);

+

 				// load properties after we have successfully read file

 				properties.clear();

 				properties.putAll(props);

@@ -103,12 +110,68 @@ public class FileSettings extends IStoredSettings {
 		return properties;

 	}

 

+	/**

+	 * Recursively read "include" properties files.

+	 *

+	 * @param properties

+	 * @return

+	 * @throws IOException

+	 */

+	private Properties readIncludes(Properties properties) throws IOException {

+

+		Properties baseProperties = new Properties();

+

+		String include = (String) properties.remove("include");

+		if (!StringUtils.isEmpty(include)) {

+

+			// allow for multiples

+			List<String> names = StringUtils.getStringsFromValue(include, ",");

+			for (String name : names) {

+

+				if (StringUtils.isEmpty(name)) {

+					continue;

+				}

+

+				// try co-located

+				File file = new File(propertiesFile.getParentFile(), name.trim());

+				if (!file.exists()) {

+					// try absolute path

+					file = new File(name.trim());

+				}

+

+				if (!file.exists()) {

+					logger.warn("failed to locate {}", file);

+					continue;

+				}

+

+				// load properties

+				logger.debug("loading {}", file);

+				try (FileInputStream iis = new FileInputStream(file)) {

+					baseProperties.load(iis);

+				}

+

+				// read nested includes

+				baseProperties = readIncludes(baseProperties);

+

+			}

+

+		}

+

+		// includes are "default" properties, they must be set first and the

+		// props which specified the "includes" must override

+		Properties merged = new Properties();

+		merged.putAll(baseProperties);

+		merged.putAll(properties);

+

+		return merged;

+	}

+

 	@Override

 	public boolean saveSettings() {

 		String content = FileUtils.readContent(propertiesFile, "\n");

 		for (String key : removals) {

 			String regex = "(?m)^(" + regExEscape(key) + "\\s*+=\\s*+)"

-				    + "(?:[^\r\n\\\\]++|\\\\(?:\r?\n|\r|.))*+$";

+					+ "(?:[^\r\n\\\\]++|\\\\(?:\r?\n|\r|.))*+$";

 			content = content.replaceAll(regex, "");

 		}

 		removals.clear();

@@ -128,7 +191,7 @@ public class FileSettings extends IStoredSettings {
 		String content = FileUtils.readContent(propertiesFile, "\n");

 		for (Map.Entry<String, String> setting:settings.entrySet()) {

 			String regex = "(?m)^(" + regExEscape(setting.getKey()) + "\\s*+=\\s*+)"

-				    + "(?:[^\r\n\\\\]++|\\\\(?:\r?\n|\r|.))*+$";

+					+ "(?:[^\r\n\\\\]++|\\\\(?:\r?\n|\r|.))*+$";

 			String oldContent = content;

 			content = content.replaceAll(regex, setting.getKey() + " = " + setting.getValue());

 			if (content.equals(oldContent)) {

diff --git a/src/main/java/com/gitblit/manager/GitblitManager.java b/src/main/java/com/gitblit/manager/GitblitManager.java
index 09e261fa..9692e654 100644
--- a/src/main/java/com/gitblit/manager/GitblitManager.java
+++ b/src/main/java/com/gitblit/manager/GitblitManager.java
@@ -77,7 +77,6 @@ import com.gitblit.tickets.ITicketService;
 import com.gitblit.transport.ssh.IPublicKeyManager;
 import com.gitblit.transport.ssh.SshKey;
 import com.gitblit.utils.ArrayUtils;
-import com.gitblit.utils.HttpUtils;
 import com.gitblit.utils.JsonUtils;
 import com.gitblit.utils.ObjectCache;
 import com.gitblit.utils.StringUtils;
@@ -88,8 +87,8 @@ import com.google.gson.JsonSyntaxException;
 import com.google.gson.reflect.TypeToken;
 import com.google.inject.Inject;
 import com.google.inject.Injector;
-import com.google.inject.Singleton;
 import com.google.inject.Provider;
+import com.google.inject.Singleton;
 
 /**
  * GitblitManager is an aggregate interface delegate.  It implements all the manager
@@ -441,7 +440,7 @@ public class GitblitManager implements IGitblit {
 			// Read bundled Gitblit properties to extract setting descriptions.
 			// This copy is pristine and only used for populating the setting
 			// models map.
-			InputStream is = GitblitManager.class.getResourceAsStream("/reference.properties");
+			InputStream is = GitblitManager.class.getResourceAsStream("/defaults.properties");
 			BufferedReader propertiesReader = new BufferedReader(new InputStreamReader(is));
 			StringBuilder description = new StringBuilder();
 			SettingModel setting = new SettingModel();
@@ -486,9 +485,9 @@ public class GitblitManager implements IGitblit {
 			}
 			propertiesReader.close();
 		} catch (NullPointerException e) {
-			logger.error("Failed to find resource copy of gitblit.properties");
+			logger.error("Failed to find classpath resource 'defaults.properties'");
 		} catch (IOException e) {
-			logger.error("Failed to load resource copy of gitblit.properties");
+			logger.error("Failed to load classpath resource 'defaults.properties'");
 		}
 	}