protected static ConfigSectionMetadata BuildSection(PluginItemMetadata itemData, PluginRuntime plugin)
{
string location = ConfigBaseMetadata.ConcatLocations(itemData.RegistrationLocation, itemData.Id);
string text = null;
string iconSmallPath = null;
string iconLargePath = null;
foreach (KeyValuePair <string, string> attr in itemData.Attributes)
{
switch (attr.Key)
{
case "Text":
text = attr.Value;
break;
case "IconSmallPath":
iconSmallPath = attr.Value;
break;
case "IconLargePath":
iconLargePath = attr.Value;
break;
default:
throw new ArgumentException("'ConfigSection' builder doesn't define an attribute '" + attr.Key + "'");
}
}
if (text == null)
{
throw new ArgumentException("'ConfigSection' item needs an attribute 'Text'");
}
return(new ConfigSectionMetadata(location, text,
plugin.Metadata.GetAbsolutePath(iconSmallPath),
plugin.Metadata.GetAbsolutePath(iconLargePath)));
}
protected static ConfigGroupMetadata BuildGroup(
PluginItemMetadata itemData, PluginRuntime plugin)
{
string location = ConfigBaseMetadata.ConcatLocations(itemData.RegistrationLocation, itemData.Id);
string text = null;
string sort = null;
string restrictionGroup = null;
foreach (KeyValuePair <string, string> attr in itemData.Attributes)
{
switch (attr.Key)
{
case "Text":
text = attr.Value;
break;
case "Sort":
sort = attr.Value;
break;
case "RestrictionGroup":
SetValueAndRegister(ref restrictionGroup, attr.Value);
break;
default:
throw new ArgumentException("'ConfigGroup' builder doesn't define an attribute '" + attr.Key + "'");
}
}
if (text == null)
{
throw new ArgumentException("'ConfigGroup' item needs an attribute 'Text'");
}
return(new ConfigGroupMetadata(location, text, sort, restrictionGroup));
}
protected static ConfigSettingMetadata BuildCustomSetting(
PluginItemMetadata itemData, PluginRuntime plugin)
{
string location = ConfigBaseMetadata.ConcatLocations(itemData.RegistrationLocation, itemData.Id);
string text = null;
string sort = null;
string className = null;
string helpText = null;
IDictionary <string, string> additionalData = null;
IDictionary <string, Type> additionalTypes = null;
ICollection <string> listenTo = null;
foreach (KeyValuePair <string, string> attr in itemData.Attributes)
{
switch (attr.Key)
{
case "Text":
text = attr.Value;
break;
case "Sort":
sort = attr.Value;
break;
case "ClassName":
className = attr.Value;
break;
case "HelpText":
helpText = attr.Value;
break;
case "ListenTo":
listenTo = ParseListenTo(attr.Value);
break;
case "AdditionalData":
additionalData = ParseAdditionalData(attr.Value);
break;
case "AdditionalTypes":
additionalTypes = ParseAdditionalTypes(attr.Value, plugin);
break;
default:
throw new ArgumentException("'ConfigSetting' builder doesn't define an attribute '" + attr.Key + "'");
}
}
if (text == null)
{
throw new ArgumentException("'ConfigSetting' item needs an attribute 'Text'");
}
ConfigSettingMetadata result = new ConfigSettingMetadata(location, text, sort, className, helpText, listenTo)
{
AdditionalData = additionalData,
AdditionalTypes = additionalTypes
};
return(result);
}
protected ConfigBase Instantiate(ConfigBaseMetadata metadata, PluginRuntime pluginRuntime)
{
ServiceRegistration.Get <ILogger>().Debug("ConfigurationNode: Loading configuration item '{0}'", metadata.Location);
ConfigBase result;
if (metadata.GetType() == typeof(ConfigGroupMetadata))
{
result = new ConfigGroup();
}
else if (metadata.GetType() == typeof(ConfigSectionMetadata))
{
result = new ConfigSection();
}
else if (metadata.GetType() == typeof(ConfigSettingMetadata))
{
ConfigSettingMetadata csm = (ConfigSettingMetadata)metadata;
try
{
ConfigSetting cs = (ConfigSetting)pluginRuntime.InstantiatePluginObject(csm.ClassName);
if (cs == null)
{
throw new ArgumentException(string.Format("Configuration class '{0}' not found", csm.ClassName));
}
cs.Load();
if (csm.ListenTo != null)
{
foreach (string listenToLocation in csm.ListenTo)
{
IConfigurationNode node;
if (FindNode(listenToLocation, out node))
{
if (node.ConfigObj is ConfigSetting)
{
cs.ListenTo((ConfigSetting)node.ConfigObj);
}
else
{
ServiceRegistration.Get <ILogger>().Warn("ConfigurationNode '{0}': Trying to listen to setting, but location '{1}' references a {2}",
Location, listenToLocation, node.ConfigObj.GetType().Name);
}
}
}
}
result = cs;
}
catch (Exception ex)
{
ServiceRegistration.Get <ILogger>().Error("Error loading configuration class '{0}'", ex, csm.ClassName);
return(null);
}
}
else
{
throw new NotImplementedException(string.Format("Unknown child class '{0}' of '{1}'", metadata.GetType().FullName, typeof(ConfigBaseMetadata).FullName));
}
result.SetMetadata(metadata);
return(result);
}
protected void LoadChildren()
{
if (_childrenLoaded)
{
return;
}
ILogger logger = ServiceRegistration.Get <ILogger>();
IPluginManager pluginManager = ServiceRegistration.Get <IPluginManager>();
string itemLocation = Constants.PLUGINTREE_BASELOCATION + Location;
// We'll use a FixedItemStateTracker in the hope that the configuration will be disposed
// after usage. The alternative would be to use a plugin item state tracker which is able to
// remove a config element usage. But this would mean to also expose a listener registration
// to the outside. I think this is not worth the labor.
_childPluginItemStateTracker = new FixedItemStateTracker(string.Format("ConfigurationManager: ConfigurationNode '{0}'", itemLocation));
ICollection <PluginItemMetadata> items = pluginManager.GetAllPluginItemMetadata(itemLocation);
IDictionary <string, object> childSet = new Dictionary <string, object>();
foreach (PluginItemMetadata itemMetadata in items)
{
try
{
ConfigBaseMetadata metadata = pluginManager.RequestPluginItem <ConfigBaseMetadata>(itemMetadata.RegistrationLocation, itemMetadata.Id, _childPluginItemStateTracker);
ConfigBase childObj = Instantiate(metadata, itemMetadata.PluginRuntime);
if (childObj == null)
{
continue;
}
AddChildNode(childObj);
childSet.Add(metadata.Id, null);
}
catch (PluginInvalidStateException e)
{
logger.Warn("Cannot add configuration node for {0}", e, itemMetadata);
}
}
ICollection <string> childLocations = pluginManager.GetAvailableChildLocations(itemLocation);
foreach (string childLocation in childLocations)
{
string childId = RegistryHelper.GetLastPathSegment(childLocation);
if (childSet.ContainsKey(childId))
{
continue;
}
logger.Warn("Configuration: Configuration section '{0}' was found in the tree but not explicitly registered as section (config items in this section are registered by those plugins: {1})",
childLocation, StringUtils.Join(", ", FindPluginRegistrations(childLocation)));
ConfigSectionMetadata dummyMetadata = new ConfigSectionMetadata(childLocation, Constants.INVALID_SECTION_TEXT, null, null);
ConfigSection dummySection = new ConfigSection();
dummySection.SetMetadata(dummyMetadata);
AddChildNode(dummySection);
}
_childrenLoaded = true;
}
protected static ConfigSettingMetadata BuildSetting(
PluginItemMetadata itemData, PluginRuntime plugin)
{
string location = ConfigBaseMetadata.ConcatLocations(itemData.RegistrationLocation, itemData.Id);
string text = null;
string sort = null;
string className = null;
string helpText = null;
ICollection <string> listenTo = null;
string restrictionGroup = null;
foreach (KeyValuePair <string, string> attr in itemData.Attributes)
{
switch (attr.Key)
{
case "Text":
text = attr.Value;
break;
case "Sort":
sort = attr.Value;
break;
case "ClassName":
className = attr.Value;
break;
case "HelpText":
helpText = attr.Value;
break;
case "ListenTo":
listenTo = ParseListenTo(attr.Value);
break;
case "RestrictionGroup":
SetValueAndRegister(ref restrictionGroup, attr.Value);
break;
default:
throw new ArgumentException("'ConfigSetting' builder doesn't define an attribute '" + attr.Key + "'");
}
}
if (text == null)
{
throw new ArgumentException("'ConfigSetting' item needs an attribute 'Text'");
}
return(new ConfigSettingMetadata(location, text, sort, className, helpText, listenTo, restrictionGroup));
}
protected ConfigBase Instantiate(ConfigBaseMetadata metadata, PluginRuntime pluginRuntime)
{
ServiceRegistration.Get <ILogger>().Debug("ConfigurationNode: Loading configuration item '{0}'", metadata.Location);
ConfigBase result;
if (metadata.GetType() == typeof(ConfigGroupMetadata))
{
result = new ConfigGroup();
}
else if (metadata.GetType() == typeof(ConfigSectionMetadata))
{
result = new ConfigSection();
}
else if (metadata.GetType() == typeof(ConfigSettingMetadata))
{
ConfigSettingMetadata csm = (ConfigSettingMetadata)metadata;
try
{
ConfigSetting cs = (ConfigSetting)pluginRuntime.InstantiatePluginObject(csm.ClassName);
if (cs == null)
{
throw new ArgumentException(string.Format("Configuration class '{0}' not found", csm.ClassName));
}
cs.Load();
result = cs;
}
catch (Exception ex)
{
ServiceRegistration.Get <ILogger>().Error("Error loading configuration class '{0}'", ex, csm.ClassName);
return(null);
}
}
else
{
throw new NotImplementedException(string.Format("Unknown child class '{0}' of '{1}'", metadata.GetType().FullName, typeof(ConfigBaseMetadata).FullName));
}
result.SetMetadata(metadata);
return(result);
}
