From 9fcf3f1a3f3457debf0f59ba7659492b44172b99 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Thu, 22 Nov 2012 05:48:41 +0000
Subject: Make "config show/set/get/save" console commands available on all
 servers

---
 OpenSim/Framework/Servers/ServerBase.cs           | 140 +++++++++++++++++++++-
 OpenSim/Region/Application/ConfigurationLoader.cs |   1 -
 OpenSim/Region/Application/OpenSim.cs             | 134 +--------------------
 OpenSim/Region/Application/OpenSimBase.cs         |  65 ++++------
 OpenSim/Server/Base/HttpServerBase.cs             |   2 +-
 OpenSim/Server/Base/ServicesServerBase.cs         |  19 +--
 6 files changed, 172 insertions(+), 189 deletions(-)

(limited to 'OpenSim')

diff --git a/OpenSim/Framework/Servers/ServerBase.cs b/OpenSim/Framework/Servers/ServerBase.cs
index 645b43a..27cfc9b 100644
--- a/OpenSim/Framework/Servers/ServerBase.cs
+++ b/OpenSim/Framework/Servers/ServerBase.cs
@@ -44,6 +44,8 @@ namespace OpenSim.Framework.Servers
     {
         private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
+        public IConfigSource Config { get; protected set; }
+
         /// <summary>
         /// Console to be used for any command line output.  Can be null, in which case there should be no output.
         /// </summary>
@@ -175,6 +177,30 @@ namespace OpenSim.Framework.Servers
             m_console.Commands.AddCommand(
                 "General", false, "set log level", "set log level <level>", 
                 "Set the console logging level for this session.", HandleSetLogLevel);
+
+            m_console.Commands.AddCommand(
+                "General", false, "config set",
+                "config set <section> <key> <value>",
+                "Set a config option.  In most cases this is not useful since changed parameters are not dynamically reloaded.  Neither do changed parameters persist - you will have to change a config file manually and restart.", HandleConfig);
+
+            m_console.Commands.AddCommand(
+                "General", false, "config get",
+                "config get [<section>] [<key>]",
+                "Synonym for config show",
+                HandleConfig);
+            
+            m_console.Commands.AddCommand(
+                "General", false, "config show",
+                "config show [<section>] [<key>]",
+                "Show config information", 
+                "If neither section nor field are specified, then the whole current configuration is printed." + Environment.NewLine
+                + "If a section is given but not a field, then all fields in that section are printed.",
+                HandleConfig);            
+
+            m_console.Commands.AddCommand(
+                "General", false, "config save",
+                "config save <path>",
+                "Save current configuration to a file at the given path", HandleConfig);
         }
 
         public virtual void HandleShow(string module, string[] cmd)
@@ -197,6 +223,115 @@ namespace OpenSim.Framework.Servers
             }
         }
 
+        /// <summary>
+        /// Change and load configuration file data.
+        /// </summary>
+        /// <param name="module"></param>
+        /// <param name="cmd"></param>
+        private void HandleConfig(string module, string[] cmd)
+        {
+            List<string> args = new List<string>(cmd);
+            args.RemoveAt(0);
+            string[] cmdparams = args.ToArray();
+
+            if (cmdparams.Length > 0)
+            {
+                string firstParam = cmdparams[0].ToLower();
+                
+                switch (firstParam)
+                {
+                    case "set":
+                        if (cmdparams.Length < 4)
+                        {
+                            Notice("Syntax: config set <section> <key> <value>");
+                            Notice("Example: config set ScriptEngine.DotNetEngine NumberOfScriptThreads 5");
+                        }
+                        else
+                        {
+                            IConfig c;
+                            IConfigSource source = new IniConfigSource();
+                            c = source.AddConfig(cmdparams[1]);
+                            if (c != null)
+                            {
+                                string _value = String.Join(" ", cmdparams, 3, cmdparams.Length - 3);
+                                c.Set(cmdparams[2], _value);
+                                Config.Merge(source);
+
+                                Notice("In section [{0}], set {1} = {2}", c.Name, cmdparams[2], _value);
+                            }
+                        }
+                        break;
+
+                    case "get":
+                    case "show":
+                        if (cmdparams.Length == 1)
+                        {
+                            foreach (IConfig config in Config.Configs)
+                            {
+                                Notice("[{0}]", config.Name);
+                                string[] keys = config.GetKeys();
+                                foreach (string key in keys)
+                                    Notice("  {0} = {1}", key, config.GetString(key));
+                            }
+                        }
+                        else if (cmdparams.Length == 2 || cmdparams.Length == 3)
+                        {
+                            IConfig config = Config.Configs[cmdparams[1]];
+                            if (config == null)
+                            {
+                                Notice("Section \"{0}\" does not exist.",cmdparams[1]);
+                                break;
+                            }
+                            else
+                            {
+                                if (cmdparams.Length == 2)
+                                {
+                                    Notice("[{0}]", config.Name);
+                                    foreach (string key in config.GetKeys())
+                                        Notice("  {0} = {1}", key, config.GetString(key));                                
+                                }
+                                else
+                                {
+                                    Notice(
+                                        "config get {0} {1} : {2}", 
+                                        cmdparams[1], cmdparams[2], config.GetString(cmdparams[2]));
+                                }
+                            }
+                        }
+                        else
+                        {
+                            Notice("Syntax: config {0} [<section>] [<key>]", firstParam);
+                            Notice("Example: config {0} ScriptEngine.DotNetEngine NumberOfScriptThreads", firstParam);
+                        }
+
+                        break;
+
+                    case "save":
+                        if (cmdparams.Length < 2)
+                        {
+                            Notice("Syntax: config save <path>");
+                            return;
+                        }
+
+                        string path = cmdparams[1];
+                        Notice("Saving configuration file: {0}", path);
+
+                        if (Config is IniConfigSource)
+                        {
+                            IniConfigSource iniCon = (IniConfigSource)Config;
+                            iniCon.Save(path);
+                        }
+                        else if (Config is XmlConfigSource)
+                        {
+                            XmlConfigSource xmlCon = (XmlConfigSource)Config;
+                            xmlCon.Save(path);
+                        }
+
+                        break;
+                }
+            }
+        }
+
         private void HandleSetLogLevel(string module, string[] cmd)
         {
             if (cmd.Length != 4)
@@ -220,9 +355,8 @@ namespace OpenSim.Framework.Servers
                 m_consoleAppender.Threshold = consoleLevel;
             else
                 Notice(
-                    String.Format(
-                        "{0} is not a valid logging level.  Valid logging levels are ALL, DEBUG, INFO, WARN, ERROR, FATAL, OFF",
-                        rawLevel));
+                    "{0} is not a valid logging level.  Valid logging levels are ALL, DEBUG, INFO, WARN, ERROR, FATAL, OFF",
+                    rawLevel);
 
             ShowLogLevel();
         }
diff --git a/OpenSim/Region/Application/ConfigurationLoader.cs b/OpenSim/Region/Application/ConfigurationLoader.cs
index 8d95c41..fc3999f 100644
--- a/OpenSim/Region/Application/ConfigurationLoader.cs
+++ b/OpenSim/Region/Application/ConfigurationLoader.cs
@@ -188,7 +188,6 @@ namespace OpenSim
             // Make sure command line options take precedence
             m_config.Source.Merge(argvSource);
 
-
             IConfig enVars = m_config.Source.Configs["Environment"];
 
             if( enVars != null )
diff --git a/OpenSim/Region/Application/OpenSim.cs b/OpenSim/Region/Application/OpenSim.cs
index e5aecbc..e654cf7 100644
--- a/OpenSim/Region/Application/OpenSim.cs
+++ b/OpenSim/Region/Application/OpenSim.cs
@@ -82,8 +82,8 @@ namespace OpenSim
         {
             base.ReadExtraConfigSettings();
 
-            IConfig startupConfig = m_config.Source.Configs["Startup"];
-            IConfig networkConfig = m_config.Source.Configs["Network"];
+            IConfig startupConfig = Config.Configs["Startup"];
+            IConfig networkConfig = Config.Configs["Network"];
 
             int stpMaxThreads = 15;
 
@@ -148,7 +148,7 @@ namespace OpenSim
                     break;
                 case "rest":
                     m_console = new RemoteConsole("Region");
-                    ((RemoteConsole)m_console).ReadConfig(m_config.Source);
+                    ((RemoteConsole)m_console).ReadConfig(Config);
                     break;
                 default:
                     m_console = new LocalConsole("Region");
@@ -158,7 +158,7 @@ namespace OpenSim
 
             MainConsole.Instance = m_console;
 
-            RegisterCommonAppenders(m_config.Source.Configs["Startup"]);
+            RegisterCommonAppenders(Config.Configs["Startup"]);
             RegisterConsoleCommands();
 
             base.StartupSpecific();
@@ -357,26 +357,6 @@ namespace OpenSim
                                           "restart",
                                           "Restart all sims in this instance", RunCommand);
 
-            m_console.Commands.AddCommand("General", false, "config set",
-                                          "config set <section> <key> <value>",
-                                          "Set a config option.  In most cases this is not useful since changed parameters are not dynamically reloaded.  Neither do changed parameters persist - you will have to change a config file manually and restart.", HandleConfig);
-
-            m_console.Commands.AddCommand("General", false, "config get",
-                                          "config get [<section>] [<key>]",
-                                          "Synonym for config show",
-                                          HandleConfig);
-            
-            m_console.Commands.AddCommand("General", false, "config show",
-                                          "config show [<section>] [<key>]",
-                                          "Show config information", 
-                                          "If neither section nor field are specified, then the whole current configuration is printed." + Environment.NewLine
-                                          + "If a section is given but not a field, then all fields in that section are printed.",
-                                          HandleConfig);            
-
-            m_console.Commands.AddCommand("General", false, "config save",
-                                          "config save <path>",
-                                          "Save current configuration to a file at the given path", HandleConfig);
-
             m_console.Commands.AddCommand("General", false, "command-script",
                                           "command-script <script>",
                                           "Run a command script from file", RunCommand);
@@ -619,111 +599,9 @@ namespace OpenSim
             bool changed = PopulateRegionEstateInfo(regInfo);
             IScene scene;
             CreateRegion(regInfo, true, out scene);
-            if (changed)
-	      regInfo.EstateSettings.Save();
-        }
-
-        /// <summary>
-        /// Change and load configuration file data.
-        /// </summary>
-        /// <param name="module"></param>
-        /// <param name="cmd"></param>
-        private void HandleConfig(string module, string[] cmd)
-        {
-            List<string> args = new List<string>(cmd);
-            args.RemoveAt(0);
-            string[] cmdparams = args.ToArray();
 
-            if (cmdparams.Length > 0)
-            {
-                string firstParam = cmdparams[0].ToLower();
-                
-                switch (firstParam)
-                {
-                    case "set":
-                        if (cmdparams.Length < 4)
-                        {
-                            Notice("Syntax: config set <section> <key> <value>");
-                            Notice("Example: config set ScriptEngine.DotNetEngine NumberOfScriptThreads 5");
-                        }
-                        else
-                        {
-                            IConfig c;
-                            IConfigSource source = new IniConfigSource();
-                            c = source.AddConfig(cmdparams[1]);
-                            if (c != null)
-                            {
-                                string _value = String.Join(" ", cmdparams, 3, cmdparams.Length - 3);
-                                c.Set(cmdparams[2], _value);
-                                m_config.Source.Merge(source);
-
-                                Notice("In section [{0}], set {1} = {2}", c.Name, cmdparams[2], _value);
-                            }
-                        }
-                        break;
-
-                    case "get":
-                    case "show":
-                        if (cmdparams.Length == 1)
-                        {
-                            foreach (IConfig config in m_config.Source.Configs)
-                            {
-                                Notice("[{0}]", config.Name);
-                                string[] keys = config.GetKeys();
-                                foreach (string key in keys)
-                                    Notice("  {0} = {1}", key, config.GetString(key));
-                            }
-                        }
-                        else if (cmdparams.Length == 2 || cmdparams.Length == 3)
-                        {
-                            IConfig config = m_config.Source.Configs[cmdparams[1]];
-                            if (config == null)
-                            {
-                                Notice("Section \"{0}\" does not exist.",cmdparams[1]);
-                                break;
-                            }
-                            else
-                            {
-                                if (cmdparams.Length == 2)
-                                {
-                                    Notice("[{0}]", config.Name);
-                                    foreach (string key in config.GetKeys())
-                                        Notice("  {0} = {1}", key, config.GetString(key));                                
-                                }
-                                else
-                                {
-                                    Notice(
-                                        "config get {0} {1} : {2}", 
-                                        cmdparams[1], cmdparams[2], config.GetString(cmdparams[2]));
-                                }
-                            }
-                        }
-                        else
-                        {
-                            Notice("Syntax: config {0} [<section>] [<key>]", firstParam);
-                            Notice("Example: config {0} ScriptEngine.DotNetEngine NumberOfScriptThreads", firstParam);
-                        }
-
-                        break;
-
-                    case "save":
-                        if (cmdparams.Length < 2)
-                        {
-                            Notice("Syntax: config save <path>");
-                            return;
-                        }
-
-                        if (Application.iniFilePath == cmdparams[1])
-                        {
-                            Notice("Path can not be " + Application.iniFilePath);
-                            return;
-                        }
-
-                        Notice("Saving configuration file: " + cmdparams[1]);
-                        m_config.Save(cmdparams[1]);
-                        break;
-                }
-            }
+            if (changed)
+	            regInfo.EstateSettings.Save();
         }
 
         /// <summary>
diff --git a/OpenSim/Region/Application/OpenSimBase.cs b/OpenSim/Region/Application/OpenSimBase.cs
index 618ce0a..b40aa4b 100644
--- a/OpenSim/Region/Application/OpenSimBase.cs
+++ b/OpenSim/Region/Application/OpenSimBase.cs
@@ -100,13 +100,7 @@ namespace OpenSim
         /// <value>
         /// The config information passed into the OpenSimulator region server.
         /// </value>
-        public OpenSimConfigSource ConfigSource
-        {
-            get { return m_config; }
-            set { m_config = value; }
-        }
-
-        protected OpenSimConfigSource m_config;
+        public OpenSimConfigSource ConfigSource { get; private set; }
 
         public List<IClientNetworkServer> ClientServers
         {
@@ -146,13 +140,14 @@ namespace OpenSim
         protected virtual void LoadConfigSettings(IConfigSource configSource)
         {
             m_configLoader = new ConfigurationLoader();
-            m_config = m_configLoader.LoadConfigSettings(configSource, envConfigSource, out m_configSettings, out m_networkServersInfo);
+            ConfigSource = m_configLoader.LoadConfigSettings(configSource, envConfigSource, out m_configSettings, out m_networkServersInfo);
+            Config = ConfigSource.Source;
             ReadExtraConfigSettings();
         }
 
         protected virtual void ReadExtraConfigSettings()
         {
-            IConfig networkConfig = m_config.Source.Configs["Network"];
+            IConfig networkConfig = Config.Configs["Network"];
             if (networkConfig != null)
             {
                 proxyUrl = networkConfig.GetString("proxy_url", "");
@@ -185,7 +180,7 @@ namespace OpenSim
         /// </summary>
         protected override void StartupSpecific()
         {
-            IConfig startupConfig = m_config.Source.Configs["Startup"];
+            IConfig startupConfig = Config.Configs["Startup"];
             if (startupConfig != null)
             {
                 string pidFile = startupConfig.GetString("PIDFile", String.Empty);
@@ -196,7 +191,7 @@ namespace OpenSim
             }
 
             // Load the simulation data service
-            IConfig simDataConfig = m_config.Source.Configs["SimulationDataStore"];
+            IConfig simDataConfig = Config.Configs["SimulationDataStore"];
             if (simDataConfig == null)
                 throw new Exception("Configuration file is missing the [SimulationDataStore] section.  Have you copied OpenSim.ini.example to OpenSim.ini to reference config-include/ files?");
 
@@ -204,7 +199,7 @@ namespace OpenSim
             if (String.IsNullOrEmpty(module))
                 throw new Exception("Configuration file is missing the LocalServiceModule parameter in the [SimulationDataStore] section.");
 
-            m_simulationDataService = ServerUtils.LoadPlugin<ISimulationDataService>(module, new object[] { m_config.Source });
+            m_simulationDataService = ServerUtils.LoadPlugin<ISimulationDataService>(module, new object[] { Config });
             if (m_simulationDataService == null)
                 throw new Exception(
                     string.Format(
@@ -212,7 +207,7 @@ namespace OpenSim
                         module));
 
             // Load the estate data service
-            IConfig estateDataConfig = m_config.Source.Configs["EstateDataStore"];
+            IConfig estateDataConfig = Config.Configs["EstateDataStore"];
             if (estateDataConfig == null)
                 throw new Exception("Configuration file is missing the [EstateDataStore] section.  Have you copied OpenSim.ini.example to OpenSim.ini to reference config-include/ files?");
 
@@ -220,7 +215,7 @@ namespace OpenSim
             if (String.IsNullOrEmpty(module))
                 throw new Exception("Configuration file is missing the LocalServiceModule parameter in the [EstateDataStore] section");
 
-            m_estateDataService = ServerUtils.LoadPlugin<IEstateDataService>(module, new object[] { m_config.Source });
+            m_estateDataService = ServerUtils.LoadPlugin<IEstateDataService>(module, new object[] { Config });
             if (m_estateDataService == null)
                 throw new Exception(
                     string.Format(
@@ -369,7 +364,7 @@ namespace OpenSim
             }
 
             IClientNetworkServer clientServer;
-            Scene scene = SetupScene(regionInfo, proxyOffset, m_config.Source, out clientServer);
+            Scene scene = SetupScene(regionInfo, proxyOffset, Config, out clientServer);
 
             m_log.Info("[MODULES]: Loading Region's modules (old style)");
 
@@ -451,10 +446,10 @@ namespace OpenSim
             string estateOwnerPassword = null;
             string rawEstateOwnerUuid = null;
 
-            if (m_config.Source.Configs[ESTATE_SECTION_NAME] != null)
+            if (Config.Configs[ESTATE_SECTION_NAME] != null)
             {
                 string defaultEstateOwnerName
-                    = m_config.Source.Configs[ESTATE_SECTION_NAME].GetString("DefaultEstateOwnerName", "").Trim();
+                    = Config.Configs[ESTATE_SECTION_NAME].GetString("DefaultEstateOwnerName", "").Trim();
                 string[] ownerNames = defaultEstateOwnerName.Split(' ');
 
                 if (ownerNames.Length >= 2)
@@ -464,9 +459,9 @@ namespace OpenSim
                 }
 
                 // Info to be used only on Standalone Mode
-                rawEstateOwnerUuid = m_config.Source.Configs[ESTATE_SECTION_NAME].GetString("DefaultEstateOwnerUUID", null);
-                estateOwnerEMail = m_config.Source.Configs[ESTATE_SECTION_NAME].GetString("DefaultEstateOwnerEMail", null);
-                estateOwnerPassword = m_config.Source.Configs[ESTATE_SECTION_NAME].GetString("DefaultEstateOwnerPassword", null);
+                rawEstateOwnerUuid = Config.Configs[ESTATE_SECTION_NAME].GetString("DefaultEstateOwnerUUID", null);
+                estateOwnerEMail = Config.Configs[ESTATE_SECTION_NAME].GetString("DefaultEstateOwnerEMail", null);
+                estateOwnerPassword = Config.Configs[ESTATE_SECTION_NAME].GetString("DefaultEstateOwnerPassword", null);
             }
 
             MainConsole.Instance.OutputFormat("Estate {0} has no owner set.", regionInfo.EstateSettings.EstateName);
@@ -713,7 +708,7 @@ namespace OpenSim
             return new Scene(
                 regionInfo, circuitManager, sceneGridService,
                 simDataService, estateDataService, false,
-                m_config.Source, m_version);
+                Config, m_version);
         }
         
         protected void ShutdownClientServer(RegionInfo whichRegion)
@@ -754,7 +749,7 @@ namespace OpenSim
         protected override PhysicsScene GetPhysicsScene(string osSceneIdentifier)
         {
             return GetPhysicsScene(
-                m_configSettings.PhysicsEngine, m_configSettings.MeshEngineName, m_config.Source, osSceneIdentifier);
+                m_configSettings.PhysicsEngine, m_configSettings.MeshEngineName, Config, osSceneIdentifier);
         }
 
         /// <summary>
@@ -991,9 +986,9 @@ namespace OpenSim
 
             string defaultEstateName = null;
 
-            if (m_config.Source.Configs[ESTATE_SECTION_NAME] != null)
+            if (Config.Configs[ESTATE_SECTION_NAME] != null)
             {
-                defaultEstateName = m_config.Source.Configs[ESTATE_SECTION_NAME].GetString("DefaultEstateName", null);
+                defaultEstateName = Config.Configs[ESTATE_SECTION_NAME].GetString("DefaultEstateName", null);
 
                 if (defaultEstateName != null)
                 {
@@ -1076,28 +1071,14 @@ namespace OpenSim
                         MainConsole.Instance.Output("Joining the estate failed. Please try again.");
                     }
                 }
-	    }
+    	    }
 
-	    return true;	// need to update the database
-	}
+    	    return true;	// need to update the database
+    	}
     }
     
     public class OpenSimConfigSource
     {
         public IConfigSource Source;
-
-        public void Save(string path)
-        {
-            if (Source is IniConfigSource)
-            {
-                IniConfigSource iniCon = (IniConfigSource) Source;
-                iniCon.Save(path);
-            }
-            else if (Source is XmlConfigSource)
-            {
-                XmlConfigSource xmlCon = (XmlConfigSource) Source;
-                xmlCon.Save(path);
-            }
-        }
     }
-}
+}
\ No newline at end of file
diff --git a/OpenSim/Server/Base/HttpServerBase.cs b/OpenSim/Server/Base/HttpServerBase.cs
index 29b1c00..954783c 100644
--- a/OpenSim/Server/Base/HttpServerBase.cs
+++ b/OpenSim/Server/Base/HttpServerBase.cs
@@ -52,7 +52,7 @@ namespace OpenSim.Server.Base
 
         protected override void ReadConfig()
         {
-            IConfig networkConfig = m_Config.Configs["Network"];
+            IConfig networkConfig = Config.Configs["Network"];
 
             if (networkConfig == null)
             {
diff --git a/OpenSim/Server/Base/ServicesServerBase.cs b/OpenSim/Server/Base/ServicesServerBase.cs
index ade4bab..2c2b8ed 100644
--- a/OpenSim/Server/Base/ServicesServerBase.cs
+++ b/OpenSim/Server/Base/ServicesServerBase.cs
@@ -56,15 +56,6 @@ namespace OpenSim.Server.Base
         //
         protected string[] m_Arguments;
 
-        // Configuration
-        //
-        protected IConfigSource m_Config = null;
-
-        public IConfigSource Config
-        {
-            get { return m_Config; }
-        }
-
         // Run flag
         //
         private bool m_Running = true;
@@ -118,11 +109,11 @@ namespace OpenSim.Server.Base
                     configUri.Scheme == Uri.UriSchemeHttp)
                 {
                     XmlReader r = XmlReader.Create(iniFile);
-                    m_Config = new XmlConfigSource(r);
+                    Config = new XmlConfigSource(r);
                 }
                 else
                 {
-                    m_Config = new IniConfigSource(iniFile);
+                    Config = new IniConfigSource(iniFile);
                 }
             }
             catch (Exception e)
@@ -134,13 +125,13 @@ namespace OpenSim.Server.Base
             // Merge the configuration from the command line into the
             // loaded file
             //
-            m_Config.Merge(argvConfig);
+            Config.Merge(argvConfig);
 
             // Refresh the startupConfig post merge
             //
-            if (m_Config.Configs["Startup"] != null)
+            if (Config.Configs["Startup"] != null)
             {
-                startupConfig = m_Config.Configs["Startup"];
+                startupConfig = Config.Configs["Startup"];
             }
 
             prompt = startupConfig.GetString("Prompt", prompt);
-- 
cgit v1.1