ConfigurationLoader.cs 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using System;
  28. using System.Collections.Generic;
  29. using System.IO;
  30. using System.Reflection;
  31. using System.Threading;
  32. using System.Xml;
  33. using log4net;
  34. using Nini.Config;
  35. using OpenSim.Framework;
  36. namespace OpenSim
  37. {
  38. /// <summary>
  39. /// Loads the Configuration files into nIni
  40. /// </summary>
  41. public class ConfigurationLoader
  42. {
  43. private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
  44. /// <summary>
  45. /// Various Config settings the region needs to start
  46. /// Physics Engine, Mesh Engine, GridMode, PhysicsPrim allowed, Neighbor,
  47. /// StorageDLL, Storage Connection String, Estate connection String, Client Stack
  48. /// Standalone settings.
  49. /// </summary>
  50. protected ConfigSettings m_configSettings;
  51. /// <summary>
  52. /// A source of Configuration data
  53. /// </summary>
  54. protected OpenSimConfigSource m_config;
  55. /// <summary>
  56. /// Grid Service Information. This refers to classes and addresses of the grid service
  57. /// </summary>
  58. protected NetworkServersInfo m_networkServersInfo;
  59. /// <summary>
  60. /// Loads the region configuration
  61. /// </summary>
  62. /// <param name="argvSource">Parameters passed into the process when started</param>
  63. /// <param name="configSettings"></param>
  64. /// <param name="networkInfo"></param>
  65. /// <returns>A configuration that gets passed to modules</returns>
  66. public OpenSimConfigSource LoadConfigSettings(
  67. IConfigSource argvSource, EnvConfigSource envConfigSource, out ConfigSettings configSettings,
  68. out NetworkServersInfo networkInfo)
  69. {
  70. m_configSettings = configSettings = new ConfigSettings();
  71. m_networkServersInfo = networkInfo = new NetworkServersInfo();
  72. bool iniFileExists = false;
  73. IConfig startupConfig = argvSource.Configs["Startup"];
  74. List<string> sources = new List<string>();
  75. string masterFileName =
  76. startupConfig.GetString("inimaster", "OpenSimDefaults.ini");
  77. if (masterFileName == "none")
  78. masterFileName = String.Empty;
  79. if (IsUri(masterFileName))
  80. {
  81. if (!sources.Contains(masterFileName))
  82. sources.Add(masterFileName);
  83. }
  84. else
  85. {
  86. string masterFilePath = Path.GetFullPath(
  87. Path.Combine(Util.configDir(), masterFileName));
  88. if (masterFileName != String.Empty)
  89. {
  90. if (File.Exists(masterFilePath))
  91. {
  92. if (!sources.Contains(masterFilePath))
  93. sources.Add(masterFilePath);
  94. }
  95. else
  96. {
  97. m_log.ErrorFormat("Master ini file {0} not found", Path.GetFullPath(masterFilePath));
  98. Environment.Exit(1);
  99. }
  100. }
  101. }
  102. string iniFileName = startupConfig.GetString("inifile", "OpenSim.ini");
  103. if (IsUri(iniFileName))
  104. {
  105. if (!sources.Contains(iniFileName))
  106. sources.Add(iniFileName);
  107. Application.iniFilePath = iniFileName;
  108. }
  109. else
  110. {
  111. Application.iniFilePath = Path.GetFullPath(
  112. Path.Combine(Util.configDir(), iniFileName));
  113. if (!File.Exists(Application.iniFilePath))
  114. {
  115. iniFileName = "OpenSim.xml";
  116. Application.iniFilePath = Path.GetFullPath(Path.Combine(Util.configDir(), iniFileName));
  117. }
  118. if (File.Exists(Application.iniFilePath))
  119. {
  120. if (!sources.Contains(Application.iniFilePath))
  121. sources.Add(Application.iniFilePath);
  122. }
  123. }
  124. string iniDirName = startupConfig.GetString("inidirectory", "config");
  125. string iniDirPath = Path.Combine(Util.configDir(), iniDirName);
  126. if (Directory.Exists(iniDirPath))
  127. {
  128. m_log.InfoFormat("Searching folder {0} for config ini files", iniDirPath);
  129. string[] fileEntries = Directory.GetFiles(iniDirName);
  130. foreach (string filePath in fileEntries)
  131. {
  132. if (Path.GetExtension(filePath).ToLower() == ".ini")
  133. {
  134. if (!sources.Contains(Path.GetFullPath(filePath)))
  135. sources.Add(Path.GetFullPath(filePath));
  136. }
  137. }
  138. }
  139. m_config = new OpenSimConfigSource();
  140. m_config.Source = new IniConfigSource();
  141. m_config.Source.Merge(DefaultConfig());
  142. m_log.Info("[CONFIG]: Reading configuration settings");
  143. if (sources.Count == 0)
  144. {
  145. m_log.FatalFormat("[CONFIG]: Could not load any configuration");
  146. Environment.Exit(1);
  147. }
  148. for (int i = 0 ; i < sources.Count ; i++)
  149. {
  150. if (ReadConfig(sources[i]))
  151. {
  152. iniFileExists = true;
  153. AddIncludes(sources);
  154. }
  155. }
  156. if (!iniFileExists)
  157. {
  158. m_log.FatalFormat("[CONFIG]: Could not load any configuration");
  159. m_log.FatalFormat("[CONFIG]: Configuration exists, but there was an error loading it!");
  160. Environment.Exit(1);
  161. }
  162. // Make sure command line options take precedence
  163. m_config.Source.Merge(argvSource);
  164. IConfig enVars = m_config.Source.Configs["Environment"];
  165. if( enVars != null )
  166. {
  167. string[] env_keys = enVars.GetKeys();
  168. foreach ( string key in env_keys )
  169. {
  170. envConfigSource.AddEnv(key, string.Empty);
  171. }
  172. envConfigSource.LoadEnv();
  173. m_config.Source.Merge(envConfigSource);
  174. }
  175. m_config.Source.ExpandKeyValues();
  176. ReadConfigSettings();
  177. return m_config;
  178. }
  179. /// <summary>
  180. /// Adds the included files as ini configuration files
  181. /// </summary>
  182. /// <param name="sources">List of URL strings or filename strings</param>
  183. private void AddIncludes(List<string> sources)
  184. {
  185. //loop over config sources
  186. foreach (IConfig config in m_config.Source.Configs)
  187. {
  188. // Look for Include-* in the key name
  189. string[] keys = config.GetKeys();
  190. foreach (string k in keys)
  191. {
  192. if (k.StartsWith("Include-"))
  193. {
  194. // read the config file to be included.
  195. string file = config.GetString(k);
  196. if (IsUri(file))
  197. {
  198. if (!sources.Contains(file))
  199. sources.Add(file);
  200. }
  201. else
  202. {
  203. string basepath = Path.GetFullPath(Util.configDir());
  204. // Resolve relative paths with wildcards
  205. string chunkWithoutWildcards = file;
  206. string chunkWithWildcards = string.Empty;
  207. int wildcardIndex = file.IndexOfAny(new char[] { '*', '?' });
  208. if (wildcardIndex != -1)
  209. {
  210. chunkWithoutWildcards = file.Substring(0, wildcardIndex);
  211. chunkWithWildcards = file.Substring(wildcardIndex);
  212. }
  213. string path = Path.Combine(basepath, chunkWithoutWildcards);
  214. path = Path.GetFullPath(path) + chunkWithWildcards;
  215. string[] paths = Util.Glob(path);
  216. // If the include path contains no wildcards, then warn the user that it wasn't found.
  217. if (wildcardIndex == -1 && paths.Length == 0)
  218. {
  219. m_log.WarnFormat("[CONFIG]: Could not find include file {0}", path);
  220. }
  221. else
  222. {
  223. foreach (string p in paths)
  224. {
  225. if (!sources.Contains(p))
  226. sources.Add(p);
  227. }
  228. }
  229. }
  230. }
  231. }
  232. }
  233. }
  234. /// <summary>
  235. /// Check if we can convert the string to a URI
  236. /// </summary>
  237. /// <param name="file">String uri to the remote resource</param>
  238. /// <returns>true if we can convert the string to a Uri object</returns>
  239. bool IsUri(string file)
  240. {
  241. Uri configUri;
  242. return Uri.TryCreate(file, UriKind.Absolute,
  243. out configUri) && configUri.Scheme == Uri.UriSchemeHttp;
  244. }
  245. /// <summary>
  246. /// Provide same ini loader functionality for standard ini and master ini - file system or XML over http
  247. /// </summary>
  248. /// <param name="iniPath">Full path to the ini</param>
  249. /// <returns></returns>
  250. private bool ReadConfig(string iniPath)
  251. {
  252. bool success = false;
  253. if (!IsUri(iniPath))
  254. {
  255. m_log.InfoFormat("[CONFIG]: Reading configuration file {0}", Path.GetFullPath(iniPath));
  256. m_config.Source.Merge(new IniConfigSource(iniPath));
  257. success = true;
  258. }
  259. else
  260. {
  261. m_log.InfoFormat("[CONFIG]: {0} is a http:// URI, fetching ...", iniPath);
  262. // The ini file path is a http URI
  263. // Try to read it
  264. try
  265. {
  266. XmlReader r = XmlReader.Create(iniPath);
  267. XmlConfigSource cs = new XmlConfigSource(r);
  268. m_config.Source.Merge(cs);
  269. success = true;
  270. }
  271. catch (Exception e)
  272. {
  273. m_log.FatalFormat("[CONFIG]: Exception reading config from URI {0}\n" + e.ToString(), iniPath);
  274. Environment.Exit(1);
  275. }
  276. }
  277. return success;
  278. }
  279. /// <summary>
  280. /// Setup a default config values in case they aren't present in the ini file
  281. /// </summary>
  282. /// <returns>A Configuration source containing the default configuration</returns>
  283. private static IConfigSource DefaultConfig()
  284. {
  285. IConfigSource defaultConfig = new IniConfigSource();
  286. {
  287. IConfig config = defaultConfig.Configs["Startup"];
  288. if (null == config)
  289. config = defaultConfig.AddConfig("Startup");
  290. config.Set("region_info_source", "filesystem");
  291. config.Set("physics", "OpenDynamicsEngine");
  292. config.Set("meshing", "Meshmerizer");
  293. config.Set("physical_prim", true);
  294. config.Set("serverside_object_permissions", true);
  295. config.Set("storage_prim_inventories", true);
  296. config.Set("startup_console_commands_file", String.Empty);
  297. config.Set("shutdown_console_commands_file", String.Empty);
  298. config.Set("DefaultScriptEngine", "XEngine");
  299. config.Set("clientstack_plugin", "OpenSim.Region.ClientStack.LindenUDP.dll");
  300. // life doesn't really work without this
  301. config.Set("EventQueue", true);
  302. }
  303. {
  304. IConfig config = defaultConfig.Configs["Network"];
  305. if (null == config)
  306. config = defaultConfig.AddConfig("Network");
  307. config.Set("http_listener_port", ConfigSettings.DefaultRegionHttpPort);
  308. }
  309. return defaultConfig;
  310. }
  311. /// <summary>
  312. /// Read initial region settings from the ConfigSource
  313. /// </summary>
  314. protected virtual void ReadConfigSettings()
  315. {
  316. IConfig startupConfig = m_config.Source.Configs["Startup"];
  317. if (startupConfig != null)
  318. {
  319. m_configSettings.PhysicsEngine = startupConfig.GetString("physics");
  320. m_configSettings.MeshEngineName = startupConfig.GetString("meshing");
  321. m_configSettings.ClientstackDll
  322. = startupConfig.GetString("clientstack_plugin", "OpenSim.Region.ClientStack.LindenUDP.dll");
  323. }
  324. m_networkServersInfo.loadFromConfiguration(m_config.Source);
  325. }
  326. }
  327. }