From 9e8cac673979ba816030d85ebb800437b11ad135 Mon Sep 17 00:00:00 2001
From: Janice Agustin <janice.agustin@ericsson.com>
Date: Wed, 10 Jun 2015 10:25:28 -0400
Subject: [PATCH] Allow modifying project config values on save

Upon saving the changes to a project config, allow modification of the
values that were entered before the result is committed.

This is useful for plugins which need to validate or change the entered
configuration values before they are saved. For example, a plugin may
require the value to be saved as encrypted text in the configuration
file. This feature would allow the user to input their value in plain
text, and the plugin may override this method to take care of the
encryption. Once the changes are saved, the updated value(s) are shown in
the project config field(s).

Change-Id: I54301b132f421665531ff41643b18933fdbb127c
---
 .../gerrit/server/config/ProjectConfigEntry.java    | 13 +++++++++++++
 .../com/google/gerrit/server/project/PutConfig.java |  2 ++
 2 files changed, 15 insertions(+)

diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/config/ProjectConfigEntry.java b/gerrit-server/src/main/java/com/google/gerrit/server/config/ProjectConfigEntry.java
index 5943801dea..3deab1103c 100644
--- a/gerrit-server/src/main/java/com/google/gerrit/server/config/ProjectConfigEntry.java
+++ b/gerrit-server/src/main/java/com/google/gerrit/server/config/ProjectConfigEntry.java
@@ -17,6 +17,7 @@ package com.google.gerrit.server.config;
 import com.google.common.base.Function;
 import com.google.common.collect.Lists;
 import com.google.gerrit.extensions.annotations.ExtensionPoint;
+import com.google.gerrit.extensions.api.projects.ProjectInput.ConfigValue;
 import com.google.gerrit.extensions.events.GitReferenceUpdatedListener;
 import com.google.gerrit.extensions.registration.DynamicMap;
 import com.google.gerrit.extensions.registration.DynamicMap.Entry;
@@ -201,6 +202,18 @@ public class ProjectConfigEntry {
     return null;
   }
 
+  /**
+   * Called before the project config is updated. To modify the value before the
+   * project config is updated, override this method and return the modified
+   * value. Default implementation returns the same value.
+   *
+   * @param configValue the original configValue that was entered.
+   * @return the modified configValue.
+   */
+  public ConfigValue preUpdate(ConfigValue configValue) {
+    return configValue;
+  }
+
   /**
    * Called after a project config is updated.
    *
diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/project/PutConfig.java b/gerrit-server/src/main/java/com/google/gerrit/server/project/PutConfig.java
index 27e7b1b75f..5185d3ae46 100644
--- a/gerrit-server/src/main/java/com/google/gerrit/server/project/PutConfig.java
+++ b/gerrit-server/src/main/java/com/google/gerrit/server/project/PutConfig.java
@@ -240,6 +240,8 @@ public class PutConfig implements RestModifyView<ProjectResource, Input> {
             if (!value.equals(oldValue)) {
               validateProjectConfigEntryIsEditable(projectConfigEntry,
                   projectState, e.getKey(), pluginName);
+              v.setValue(projectConfigEntry.preUpdate(v.getValue()));
+              value = v.getValue().value;
               try {
                 switch (projectConfigEntry.getType()) {
                   case BOOLEAN: