*Handler Functions can now refuse an object as invalid by returning false, thus forcing the user to re-enter the data

*Added TYPE_STRING_NOT_EMPTY that requires some sort of text to be entered
*Added another parameter to addConfigurationOption called use_default_no_prompt that will not ask via the console a configuration option; it will use whatever is in the config file. If nothing is in the config file for that option, it will force itself to use default

4 files changed, 64 insertions, 28 deletions

diff --git a/OpenSim/Framework/General/Configuration/ConfigurationMember.cs b/OpenSim/Framework/General/Configuration/ConfigurationMember.cs
index 8106d5a..e93a576 100644
--- a/OpenSim/Framework/General/Configuration/ConfigurationMember.cs
+++ b/OpenSim/Framework/General/Configuration/ConfigurationMember.cs
@@ -12,7 +12,7 @@ namespace OpenSim.Framework.Configuration
 {

     public class ConfigurationMember

     {

-        public delegate void ConfigurationOptionResult(string configuration_key, object configuration_result);

+        public delegate bool ConfigurationOptionResult(string configuration_key, object configuration_result);

         public delegate void ConfigurationOptionsLoad();

 

         private List<ConfigurationOption> configurationOptions = new List<ConfigurationOption>();

@@ -44,13 +44,14 @@ namespace OpenSim.Framework.Configuration
             resultFunction = result;

         }

         

-        public void addConfigurationOption(string configuration_key, ConfigurationOption.ConfigurationTypes configuration_type, string configuration_question, string configuration_default)

+        public void addConfigurationOption(string configuration_key, ConfigurationOption.ConfigurationTypes configuration_type, string configuration_question, string configuration_default, bool use_default_no_prompt)

         {

             ConfigurationOption configOption = new ConfigurationOption();

             configOption.configurationKey = configuration_key;

             configOption.configurationQuestion = configuration_question;

             configOption.configurationDefault = configuration_default;

             configOption.configurationType = configuration_type;

+            configOption.configurationUseDefaultNoPrompt = use_default_no_prompt;

 

             if (configuration_key != "" && configuration_question != "")

             {

@@ -116,7 +117,8 @@ namespace OpenSim.Framework.Configuration
                 bool ignoreNextFromConfig = false;

                 while (convertSuccess == false)

                 {

-

+                    

+                    string console_result = "";

                     string attribute = null;

                     if (useFile)

                     {

@@ -130,17 +132,24 @@ namespace OpenSim.Framework.Configuration
                         }

                     }

 

-                    string console_result = "";

                     if (attribute == null)

                     {

-                        if (configurationDescription.Trim() != "")

+                        if (configOption.configurationUseDefaultNoPrompt)

                         {

-                            console_result = MainLog.Instance.CmdPrompt(configurationDescription + ": " + configOption.configurationQuestion, configOption.configurationDefault);

+                            console_result = configOption.configurationDefault;

                         }

                         else

                         {

-                            console_result = MainLog.Instance.CmdPrompt(configOption.configurationQuestion, configOption.configurationDefault);

-                        }

+                        

+                            if (configurationDescription.Trim() != "")

+                            {

+                                console_result = MainLog.Instance.CmdPrompt(configurationDescription + ": " + configOption.configurationQuestion, configOption.configurationDefault);

+                            }

+                            else

+                            {

+                                console_result = MainLog.Instance.CmdPrompt(configOption.configurationQuestion, configOption.configurationDefault);

+                            }

+                        }                        

                     }

                     else

                     {

@@ -153,6 +162,14 @@ namespace OpenSim.Framework.Configuration
                             return_result = console_result;

                             convertSuccess = true;

                             break;

+                        case ConfigurationOption.ConfigurationTypes.TYPE_STRING_NOT_EMPTY:

+                            if (console_result.Length > 0)

+                            {

+                                return_result = console_result;

+                                convertSuccess = true;

+                            }

+                            errorMessage = "a string that is not empty";

+                            break;

                         case ConfigurationOption.ConfigurationTypes.TYPE_BOOLEAN:

                             bool boolResult;

                             if (Boolean.TryParse(console_result, out boolResult))

@@ -290,13 +307,26 @@ namespace OpenSim.Framework.Configuration
                             xmlConfig.SetAttribute(configOption.configurationKey, console_result);

                         }

 

-                        

-                        this.resultFunction(configOption.configurationKey, return_result);

+

+                        if (!this.resultFunction(configOption.configurationKey, return_result))

+                        {

+                            Console.MainLog.Instance.Notice("The handler for the last configuration option denied that input, please try again.");

+                            convertSuccess = false;

+                            ignoreNextFromConfig = true;

+                        }

                     }

                     else

                     {

-                        MainLog.Instance.Warn("Incorrect result given, the configuration option must be " + errorMessage + ". Prompting for same option...");

-                        ignoreNextFromConfig = true;

+                        if (configOption.configurationUseDefaultNoPrompt)

+                        {

+                            MainLog.Instance.Error("Default given for '" + configOption.configurationKey + "' is not valid; the configuration result must be " + errorMessage + ". Will skip this option...");

+                            convertSuccess = true;

+                        }

+                        else

+                        {

+                            MainLog.Instance.Warn("Incorrect result given, the configuration option must be " + errorMessage + ". Prompting for same option...");

+                            ignoreNextFromConfig = true;

+                        }

                     }

                 }

             }

diff --git a/OpenSim/Framework/General/Configuration/ConfigurationOption.cs b/OpenSim/Framework/General/Configuration/ConfigurationOption.cs
index 15da1aa..38f60a0 100644
--- a/OpenSim/Framework/General/Configuration/ConfigurationOption.cs
+++ b/OpenSim/Framework/General/Configuration/ConfigurationOption.cs
@@ -9,6 +9,7 @@ namespace OpenSim.Framework.Configuration
         public enum ConfigurationTypes

         {

             TYPE_STRING,

+            TYPE_STRING_NOT_EMPTY,

             TYPE_UINT16,

             TYPE_UINT32,

             TYPE_UINT64, 

@@ -30,5 +31,6 @@ namespace OpenSim.Framework.Configuration
         public string configurationDefault = "";

 

         public ConfigurationTypes configurationType = ConfigurationTypes.TYPE_STRING;

+        public bool configurationUseDefaultNoPrompt = false;

     }

 }

diff --git a/OpenSim/Framework/General/Configuration/GridConfig.cs b/OpenSim/Framework/General/Configuration/GridConfig.cs
index 97dd699..0a7f65c 100644
--- a/OpenSim/Framework/General/Configuration/GridConfig.cs
+++ b/OpenSim/Framework/General/Configuration/GridConfig.cs
@@ -27,21 +27,21 @@ namespace OpenSim.Framework.Configuration
 

         public void loadConfigurationOptions()

         {

-            configMember.addConfigurationOption("grid_owner",ConfigurationOption.ConfigurationTypes.TYPE_STRING,"OGS Grid Owner","OGS development team");

-            configMember.addConfigurationOption("default_asset_server",ConfigurationOption.ConfigurationTypes.TYPE_STRING,"Default Asset Server URI","http://127.0.0.1:8003/");

-            configMember.addConfigurationOption("asset_send_key",ConfigurationOption.ConfigurationTypes.TYPE_STRING,"Key to send to asset server","null");

-            configMember.addConfigurationOption("asset_recv_key",ConfigurationOption.ConfigurationTypes.TYPE_STRING,"Key to expect from asset server","null");

+            configMember.addConfigurationOption("grid_owner", ConfigurationOption.ConfigurationTypes.TYPE_STRING_NOT_EMPTY, "OGS Grid Owner", "OGS development team", false);

+            configMember.addConfigurationOption("default_asset_server", ConfigurationOption.ConfigurationTypes.TYPE_STRING_NOT_EMPTY, "Default Asset Server URI", "http://127.0.0.1:8003/", false);

+            configMember.addConfigurationOption("asset_send_key", ConfigurationOption.ConfigurationTypes.TYPE_STRING, "Key to send to asset server", "null", false);

+            configMember.addConfigurationOption("asset_recv_key", ConfigurationOption.ConfigurationTypes.TYPE_STRING, "Key to expect from asset server", "null", false);

 

-            configMember.addConfigurationOption("default_user_server",ConfigurationOption.ConfigurationTypes.TYPE_STRING,"Default User Server URI","http://127.0.0.1:8002/");

-            configMember.addConfigurationOption("user_send_key",ConfigurationOption.ConfigurationTypes.TYPE_STRING,"Key to send to user server","null");

-            configMember.addConfigurationOption("user_recv_key",ConfigurationOption.ConfigurationTypes.TYPE_STRING,"Key to expect from user server","null");

+            configMember.addConfigurationOption("default_user_server", ConfigurationOption.ConfigurationTypes.TYPE_STRING_NOT_EMPTY, "Default User Server URI", "http://127.0.0.1:8002/", false);

+            configMember.addConfigurationOption("user_send_key", ConfigurationOption.ConfigurationTypes.TYPE_STRING, "Key to send to user server", "null", false);

+            configMember.addConfigurationOption("user_recv_key", ConfigurationOption.ConfigurationTypes.TYPE_STRING, "Key to expect from user server", "null", false);

 

-            configMember.addConfigurationOption("sim_send_key",ConfigurationOption.ConfigurationTypes.TYPE_STRING,"Key to send to a simulator","null");

-            configMember.addConfigurationOption("sim_recv_key",ConfigurationOption.ConfigurationTypes.TYPE_STRING,"Key to expect from a simulator","null");

+            configMember.addConfigurationOption("sim_send_key", ConfigurationOption.ConfigurationTypes.TYPE_STRING, "Key to send to a simulator", "null", false);

+            configMember.addConfigurationOption("sim_recv_key", ConfigurationOption.ConfigurationTypes.TYPE_STRING, "Key to expect from a simulator", "null", false);

 

         }

 

-        public void handleIncomingConfiguration(string configuration_key, object configuration_result)

+        public bool handleIncomingConfiguration(string configuration_key, object configuration_result)

         {

             switch (configuration_key)

             {

@@ -73,6 +73,8 @@ namespace OpenSim.Framework.Configuration
                     this.SimRecvKey = (string)configuration_result;

                     break;

             }

+

+            return true;

         }

     }

 }

diff --git a/OpenSim/Framework/General/Configuration/UserConfig.cs b/OpenSim/Framework/General/Configuration/UserConfig.cs
index 9d607b3..a027ffc 100644
--- a/OpenSim/Framework/General/Configuration/UserConfig.cs
+++ b/OpenSim/Framework/General/Configuration/UserConfig.cs
@@ -24,16 +24,16 @@ namespace OpenSim.Framework.Configuration
 

         public void loadConfigurationOptions()

         {

-            configMember.addConfigurationOption("default_startup_message",ConfigurationOption.ConfigurationTypes.TYPE_STRING,"Default Startup Message","Welcome to OGS");

-            

-            configMember.addConfigurationOption("default_grid_server",ConfigurationOption.ConfigurationTypes.TYPE_STRING,"Default Grid Server URI","http://127.0.0.1:8001/");

-            configMember.addConfigurationOption("grid_send_key",ConfigurationOption.ConfigurationTypes.TYPE_STRING,"Key to send to grid server","null");

-            configMember.addConfigurationOption("grid_recv_key",ConfigurationOption.ConfigurationTypes.TYPE_STRING,"Key to expect from grid server","null");

+            configMember.addConfigurationOption("default_startup_message", ConfigurationOption.ConfigurationTypes.TYPE_STRING_NOT_EMPTY, "Default Startup Message", "Welcome to OGS",false);

+

+            configMember.addConfigurationOption("default_grid_server", ConfigurationOption.ConfigurationTypes.TYPE_STRING_NOT_EMPTY, "Default Grid Server URI", "http://127.0.0.1:8001/", false);

+            configMember.addConfigurationOption("grid_send_key", ConfigurationOption.ConfigurationTypes.TYPE_STRING, "Key to send to grid server", "null", false);

+            configMember.addConfigurationOption("grid_recv_key", ConfigurationOption.ConfigurationTypes.TYPE_STRING, "Key to expect from grid server", "null", false);

 

 

         }

 

-        public void handleIncomingConfiguration(string configuration_key, object configuration_result)

+        public bool handleIncomingConfiguration(string configuration_key, object configuration_result)

         {

             switch (configuration_key)

             {

@@ -50,6 +50,8 @@ namespace OpenSim.Framework.Configuration
                     this.GridRecvKey = (string)configuration_result;

                     break;

             }

+

+            return true;

         }

     }

 }