Working edit settings RPC. Web.xml is not directly modified.

diff --git a/.gitignore b/.gitignore
index 86347ca9b18123844b5112b7a6a1891ab2abbac5..3c0210d0881f90c31ca0440953d75ab2cd763bd6 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -17,6 +17,6 @@
 /federation.properties\r
 /mailtest.properties\r
 /.settings/*.prefs\r
-/src/WEB-INF/gitblit.properties\r
+/src/WEB-INF/reference.properties\r
 /bin/\r
 /.settings/\r

diff --git a/build.xml b/build.xml
index 107fac373cf25d813e0fea6d2194394c5b409742..4a5c88674e2e677d497979c412b3c4a12e1082da 100644 (file)
--- a/build.xml
+++ b/build.xml
@@ -106,7 +106,7 @@
 \r
                <!-- copy gitblit.properties to the WEB-INF folder.\r
                     this file is only used for parsing setting descriptions. -->\r
-               <copy todir="${basedir}/src/WEB-INF" overwrite="true"\r
+               <copy tofile="${basedir}/src/WEB-INF/reference.properties" overwrite="true"\r
                        file="${basedir}/distrib/gitblit.properties" />\r
 \r
                <!-- Compile the build tool and execute it.\r
@@ -311,11 +311,10 @@
                \r
                <delete dir="${project.war.dir}" />             \r
 \r
-               <!-- Copy web.xml, users.properties, and gitblit.properties to WEB-INF -->\r
+               <!-- Copy web.xml and users.properties to WEB-INF -->\r
                <copy todir="${project.war.dir}/WEB-INF">\r
                        <fileset dir="${basedir}/distrib">\r
                                <include name="users.properties" />\r
-                               <include name="gitblit.properties" />\r
                        </fileset>\r
                        <fileset dir="${basedir}/src/WEB-INF">\r
                                <include name="web.xml" />\r
@@ -326,6 +325,10 @@
                        </fileset>\r
                </copy>\r
                \r
+               <!-- Copy gitblit.properties as reference.properties -->\r
+               <copy tofile="${project.war.dir}/WEB-INF/reference.properties" \r
+                       file="${basedir}/distrib/gitblit.properties"/>\r
+               \r
                <!-- Build the docs for the WAR build -->\r
                <antcall target="buildDocs" inheritall="true" inheritrefs="true">\r
                        <param name="docs.output.dir" value="${project.war.dir}/WEB-INF/docs" />\r

diff --git a/docs/02_rpc.mkd b/docs/02_rpc.mkd
index 0150d16877119ba74b853ce86e85c8db39fd3b07..82655085dd2962670272f4ed3e653d611354fb47 100644 (file)
--- a/docs/02_rpc.mkd
+++ b/docs/02_rpc.mkd
@@ -31,6 +31,7 @@ The Gitblit RPC mechanism, like the Gitblit JGit servlet, syndication/feed servl
 <tr><td>LIST_FEDERATION_PROPOSALS</td><td>-</td><td><em>admin</em></td><td>-</td><td>List&lt;FederationProposal&gt;</td></tr>\r
 <tr><td>LIST_FEDERATION_SETS</td><td>-</td><td><em>admin</em></td><td>-</td><td>List&lt;FederationSet&gt;</td></tr>\r
 <tr><td>LIST_SETTINGS</td><td>-</td><td><em>admin</em></td><td>-</td><td>ServerSettings (see example below)</td></tr>\r
+<tr><td>EDIT_SETTINGS</td><td>-</td><td><em>admin</em></td><td>Map&lt;String, String&gt;</td><td>-</td></tr>\r
 <tr><td>LIST_STATUS</td><td>-</td><td><em>admin</em></td><td>-</td><td>ServerStatus (see example below)</td></tr>\r
 </table>\r
 \r

diff --git a/src/com/gitblit/FileSettings.java b/src/com/gitblit/FileSettings.java
index 56aac8b740bb429e152c66f5e9f1996107666276..61100587ad53189397a06aa5fdcce651452bb20f 100644 (file)
--- a/src/com/gitblit/FileSettings.java
+++ b/src/com/gitblit/FileSettings.java
@@ -18,7 +18,11 @@ package com.gitblit;
 import java.io.File;\r
 import java.io.FileInputStream;\r
 import java.io.FileNotFoundException;\r
+import java.util.Map;\r
 import java.util.Properties;\r
+import java.util.regex.Pattern;\r
+\r
+import com.gitblit.utils.FileUtils;\r
 \r
 /**\r
  * Dynamically loads and reloads a properties file by keeping track of the last\r
@@ -74,6 +78,24 @@ public class FileSettings extends IStoredSettings {
                return properties;\r
        }\r
 \r
+       /**\r
+        * Updates the specified settings in the settings file.\r
+        */\r
+       public synchronized boolean saveSettings(Map<String, String> settings) {\r
+               String content = FileUtils.readContent(propertiesFile, "\n");\r
+               for (Map.Entry<String, String> setting:settings.entrySet()) {\r
+                       String regex = "(?m)^(" + regExEscape(setting.getKey()) + "\\s*+=\\s*+)"\r
+                                   + "(?:[^\r\n\\\\]++|\\\\(?:\r?\n|\r|.))*+$";                        \r
+                       content = content.replaceAll(regex, setting.getKey() + " = " + setting.getValue());\r
+               }\r
+               FileUtils.writeContent(propertiesFile, content);\r
+               return true;\r
+       }\r
+       \r
+       private String regExEscape(String input) {\r
+               return input.replace(".", "\\.");\r
+       }\r
+\r
        /**\r
         * @return the last modification date of the properties file\r
         */\r

diff --git a/src/com/gitblit/GitBlit.java b/src/com/gitblit/GitBlit.java
index ffef94a7d4a8706b3f431f29b3a75855b4c1bcb4..8386d2d4fafc260b414bc1d44a9d322bbb3f6c65 100644 (file)
--- a/src/com/gitblit/GitBlit.java
+++ b/src/com/gitblit/GitBlit.java
@@ -25,7 +25,6 @@ import java.lang.reflect.Field;
 import java.text.MessageFormat;\r
 import java.util.ArrayList;\r
 import java.util.Arrays;\r
-import java.util.Collection;\r
 import java.util.Collections;\r
 import java.util.HashMap;\r
 import java.util.List;\r
@@ -253,9 +252,8 @@ public class GitBlit implements ServletContextListener {
         * @param settings\r
         * @return true if the update succeeded\r
         */\r
-       public boolean updateSettings(Collection<SettingModel> settings) {\r
-               // TODO update the settings\r
-               return false;\r
+       public boolean updateSettings(Map<String, String> updatedSettings) {\r
+               return settings.saveSettings(updatedSettings);          \r
        }\r
 \r
        public ServerStatus getStatus() {\r
@@ -1326,7 +1324,7 @@ public class GitBlit implements ServletContextListener {
                        // Read bundled Gitblit properties to extract setting descriptions.\r
                        // This copy is pristine and only used for populating the setting\r
                        // models map.\r
-                       InputStream is = servletContext.getResourceAsStream("/WEB-INF/gitblit.properties");\r
+                       InputStream is = servletContext.getResourceAsStream("/WEB-INF/reference.properties");\r
                        BufferedReader propertiesReader = new BufferedReader(new InputStreamReader(is));\r
                        StringBuilder description = new StringBuilder();\r
                        SettingModel setting = new SettingModel();\r

diff --git a/src/com/gitblit/IStoredSettings.java b/src/com/gitblit/IStoredSettings.java
index a376c81a09e6eeda60f256a0c8538867fa36bffc..2d8b605548a9560f4bd94fbac170df1816755163 100644 (file)
--- a/src/com/gitblit/IStoredSettings.java
+++ b/src/com/gitblit/IStoredSettings.java
@@ -17,6 +17,7 @@ package com.gitblit;
 \r
 import java.util.ArrayList;\r
 import java.util.List;\r
+import java.util.Map;\r
 import java.util.Properties;\r
 \r
 import org.slf4j.Logger;\r
@@ -194,4 +195,14 @@ public abstract class IStoredSettings {
        public void overrideSetting(String key, String value) {\r
                overrides.put(key, value);\r
        }\r
+\r
+       /**\r
+        * Updates the values for the specified keys and persists the entire\r
+        * configuration file.\r
+        * \r
+        * @param map\r
+        *            of key, value pairs\r
+        * @return true if successful\r
+        */\r
+       public abstract boolean saveSettings(Map<String, String> updatedSettings);\r
 }
\ No newline at end of file

diff --git a/src/com/gitblit/RpcServlet.java b/src/com/gitblit/RpcServlet.java
index 7cf3a598ae8c63683e4b9180982f89f0764e45c0..1136692afae583e65ed3ce2b0ca36cc3e8cb49dc 100644 (file)
--- a/src/com/gitblit/RpcServlet.java
+++ b/src/com/gitblit/RpcServlet.java
@@ -191,7 +191,7 @@ public class RpcServlet extends JsonServlet {
                } else if (RpcRequest.EDIT_SETTINGS.equals(reqType)) {\r
                        // update settings on the server\r
                        if (GitBlit.getBoolean(Keys.web.enableRpcAdministration, false)) {\r
-                               Collection<SettingModel> settings = deserialize(request, response,\r
+                               Map<String, String> settings = deserialize(request, response,\r
                                                RpcUtils.SETTINGS_TYPE);\r
                                GitBlit.self().updateSettings(settings);\r
                        } else {\r

diff --git a/src/com/gitblit/WebXmlSettings.java b/src/com/gitblit/WebXmlSettings.java
index 4b0358d289c965d2dbce12270e2c574737909545..055c7d35762f36538d94eb4b9fdd74b9f88b5307 100644 (file)
--- a/src/com/gitblit/WebXmlSettings.java
+++ b/src/com/gitblit/WebXmlSettings.java
@@ -15,7 +15,13 @@
  */\r
 package com.gitblit;\r
 \r
+import java.io.File;\r
+import java.io.FileInputStream;\r
+import java.io.FileOutputStream;\r
+import java.io.InputStream;\r
+import java.io.OutputStream;\r
 import java.util.Enumeration;\r
+import java.util.Map;\r
 import java.util.Properties;\r
 \r
 import javax.servlet.ServletContext;\r
@@ -32,8 +38,11 @@ public class WebXmlSettings extends IStoredSettings {
 \r
        private final Properties properties = new Properties();\r
 \r
+       private final ServletContext context;\r
+\r
        public WebXmlSettings(ServletContext context) {\r
                super(WebXmlSettings.class);\r
+               this.context = context;\r
                Enumeration<?> keys = context.getInitParameterNames();\r
                while (keys.hasMoreElements()) {\r
                        String key = keys.nextElement().toString();\r
@@ -41,6 +50,17 @@ public class WebXmlSettings extends IStoredSettings {
                        properties.put(key, decodeValue(value));\r
                        logger.debug(key + "=" + properties.getProperty(key));\r
                }\r
+               // apply any web-configured overrides\r
+               File file = new File(context.getRealPath("/WEB-INF/web.properties"));\r
+               if (file.exists()) {\r
+                       try {\r
+                               InputStream is = new FileInputStream(file);\r
+                               properties.load(is);\r
+                               is.close();\r
+                       } catch (Throwable t) {\r
+                               logger.error("Failed to load web.properties setting overrides", t);\r
+                       }\r
+               }\r
        }\r
 \r
        private String decodeValue(String value) {\r
@@ -53,6 +73,33 @@ public class WebXmlSettings extends IStoredSettings {
                return properties;\r
        }\r
 \r
+       @Override\r
+       public synchronized boolean saveSettings(Map<String, String> settings) {\r
+               try {\r
+                       Properties props = new Properties();\r
+                       // load pre-existing web-configuration\r
+                       File file = new File(context.getRealPath("/WEB-INF/web.properties"));\r
+                       if (file.exists()) {\r
+                               InputStream is = new FileInputStream(file);\r
+                               props.load(is);\r
+                               is.close();\r
+                       }\r
+                       \r
+                       // put all new settings and persist\r
+                       props.putAll(settings);\r
+                       OutputStream os = new FileOutputStream(file);\r
+                       props.store(os, null);\r
+                       os.close();\r
+                       \r
+                       // override current runtime settings\r
+                       properties.putAll(settings);\r
+                       return true;\r
+               } catch (Throwable t) {\r
+                       logger.error("Failed to save settings!", t);\r
+               }\r
+               return false;\r
+       }\r
+\r
        @Override\r
        public String toString() {\r
                return "WEB.XML";\r

diff --git a/src/com/gitblit/utils/RpcUtils.java b/src/com/gitblit/utils/RpcUtils.java
index 6572cd9d64bd9e6ebeb6affd87276dc86bad09a7..e584151847ca9fae20ab8b49023833b0e6cb2b2e 100644 (file)
--- a/src/com/gitblit/utils/RpcUtils.java
+++ b/src/com/gitblit/utils/RpcUtils.java
@@ -30,7 +30,6 @@ import com.gitblit.models.FederationSet;
 import com.gitblit.models.RepositoryModel;\r
 import com.gitblit.models.ServerSettings;\r
 import com.gitblit.models.ServerStatus;\r
-import com.gitblit.models.SettingModel;\r
 import com.gitblit.models.UserModel;\r
 import com.google.gson.reflect.TypeToken;\r
 \r
@@ -45,7 +44,7 @@ public class RpcUtils {
        public static final Type NAMES_TYPE = new TypeToken<Collection<String>>() {\r
        }.getType();\r
 \r
-       public static final Type SETTINGS_TYPE = new TypeToken<Collection<SettingModel>>() {\r
+       public static final Type SETTINGS_TYPE = new TypeToken<Map<String, String>>() {\r
        }.getType();\r
 \r
        private static final Type REPOSITORIES_TYPE = new TypeToken<Map<String, RepositoryModel>>() {\r

diff --git a/tests/com/gitblit/tests/RpcTests.java b/tests/com/gitblit/tests/RpcTests.java
index 11a340a94d8ae29244882acf558e657bbdc43bee..2860f32ba9f18edef0c83ac94b2ae5c49e85447f 100644 (file)
--- a/tests/com/gitblit/tests/RpcTests.java
+++ b/tests/com/gitblit/tests/RpcTests.java
@@ -16,6 +16,7 @@
 package com.gitblit.tests;\r
 \r
 import java.io.IOException;\r
+import java.util.HashMap;\r
 import java.util.List;\r
 import java.util.Map;\r
 \r
@@ -23,6 +24,7 @@ import junit.framework.TestCase;
 \r
 import com.gitblit.Constants.AccessRestrictionType;\r
 import com.gitblit.GitBlitException.UnauthorizedException;\r
+import com.gitblit.Keys;\r
 import com.gitblit.models.FederationModel;\r
 import com.gitblit.models.FederationProposal;\r
 import com.gitblit.models.FederationSet;\r
@@ -210,9 +212,33 @@ public class RpcTests extends TestCase {
                ServerSettings settings = RpcUtils.getSettings(url, account, password.toCharArray());\r
                assertTrue("No settings were retrieved!", settings != null);\r
        }\r
-       \r
+\r
        public void testServerStatus() throws Exception {\r
                ServerStatus status = RpcUtils.getStatus(url, account, password.toCharArray());\r
                assertTrue("No status was retrieved!", status != null);\r
        }\r
+\r
+       public void testUpdateSettings() throws Exception {\r
+               Map<String, String> updated = new HashMap<String, String>();\r
+               \r
+               // grab current setting\r
+               ServerSettings settings = RpcUtils.getSettings(url, account, password.toCharArray());\r
+               boolean showSizes = settings.get(Keys.web.showRepositorySizes).getBoolean(true);\r
+               showSizes = !showSizes;\r
+               \r
+               // update setting\r
+               updated.put(Keys.web.showRepositorySizes, String.valueOf(showSizes));\r
+               boolean success = RpcUtils.updateSettings(updated, "http://localhost:8080/gb", account,\r
+                               password.toCharArray());\r
+               assertTrue("Failed to update server settings", success);\r
+               \r
+               // confirm setting change\r
+               settings = RpcUtils.getSettings(url, account, password.toCharArray());\r
+               boolean newValue = settings.get(Keys.web.showRepositorySizes).getBoolean(false);\r
+               assertEquals(newValue, showSizes);\r
+               \r
+               // restore setting\r
+               newValue = !newValue;\r
+               updated.put(Keys.web.showRepositorySizes, String.valueOf(newValue));\r
+       }\r
 }\r