/// <summary>
/// Start a run using the information info
/// </summary>
/// <param name="configInfo">configuration info</param>
/// <param name="credentials">SharePoint Online credentials</param>
public static void Run(ConfigFileInfo configInfo, SharePointOnlineCredentials credentials = null)
{
// Instanciate and feed running manager
RunningManager runningManager = GetRunningManagerFromConfigFile(configInfo, credentials);
// Start the process
runningManager?.Run();
}
/// <summary>
/// Get the configuration info parsing the JSON config file
/// </summary>
/// <param name="configFilePath">Path of the JSON configuration file</param>
/// <returns>Configuration informations from the file</returns>
private static ConfigFileInfo GetConfigFileInfoFromJson(string configFilePath)
{
ConfigFileInfo configFileInfo = default;
// TODO Adding JSON validation schema and validate before deserialization
try
{
JsonSerializer serializer = new JsonSerializer();
using (var reader = new StreamReader(configFilePath))
{
configFileInfo = (ConfigFileInfo)serializer.Deserialize(reader, typeof(ConfigFileInfo));
}
}
catch (Exception e)
{
Exception ex = new Exception("Error during JSON configuration file parsing", e);
Logger.Error(ex.Message, ex);
throw ex;
}
return(configFileInfo);
}
/// <summary>
/// Start a run using the information from the configuration file
/// </summary>
/// <param name="configFilePath">Path of the configuration file</param>
/// <param name="credentials">SharePoint Online credentials</param>
public static void Run(string configFilePath, SharePointOnlineCredentials credentials = null)
{
// Check file exists
if (!IO.File.Exists(configFilePath))
{
Exception ex = new Exception("File does not exist");
Logger.Error(ex.Message, ex);
throw ex;
}
// Get the extension of the file
string extension = Path.GetExtension(configFilePath);
ConfigFileInfo configFileInfo = null;
switch (extension.ToLowerInvariant())
{
case ".xml":
// If XML, parse XML
configFileInfo = GetConfigFileInfoFromXml(configFilePath);
break;
case ".json":
// If JSON, parse JSON
configFileInfo = GetConfigFileInfoFromJson(configFilePath);
break;
default:
Exception ex = new Exception("Extension file not valid");
Logger.Error(ex.Message, ex);
throw ex;
}
// Instanciate the running manager and start the process
Run(configFileInfo, credentials);
}
/// <summary>
/// Get the running manager from the configuration file info
/// </summary>
/// <param name="configFileInfo">Configuration information from the file</param>
/// <param name="credentials">SharePoint Online credentials</param>
/// <returns>Running manager</returns>
private static RunningManager GetRunningManagerFromConfigFile(ConfigFileInfo configFileInfo, SharePointOnlineCredentials credentials = null)
{
RunningManager runningManager = new RunningManager();
string executablePath = Directory.GetCurrentDirectory();
// Get DLLs classes from assemblies
foreach (ReceiverAssembly receiverAssembly in configFileInfo.Receivers)
{
// Check if the dll file exists
if (!IO.File.Exists($"{receiverAssembly.AssemblyName}.dll"))
{
Exception ex = new Exception($"The '{receiverAssembly.AssemblyName}.dll' file does not exist");
Logger.Warn(ex.Message, ex);
continue;
}
// Load the assembly
Assembly assembly = Assembly.LoadFile(Path.Combine(executablePath, configFileInfo.PathToDLL, $"{receiverAssembly.AssemblyName}.dll"));
// Check if the assembly is null
if (assembly == null)
{
Exception ex = new Exception($"The '{receiverAssembly.AssemblyName}' assembly is not loaded");
Logger.Warn(ex.Message, ex);
continue;
}
// Get the type of the class
Type receiverClass = assembly.GetType($"{receiverAssembly.AssemblyName}.{receiverAssembly.ClassName}");
// Check if the type exists
if (receiverClass == null)
{
Exception ex = new Exception($"The '{receiverAssembly.ClassName}' type does not exist");
Logger.Warn(ex.Message, ex);
continue;
}
// Instantiate the class
Receiver receiver = (Receiver)Activator.CreateInstance(receiverClass);
// Check if the class is instantiated
if (receiver == null)
{
Exception ex = new Exception($"The '{receiverAssembly.ClassName}' class is not instantiated");
Logger.Warn(ex.Message, ex);
continue;
}
// Set properties
receiver.IncludeSubSites = receiverAssembly.IncludeSubSites;
receiver.IncludeHiddenLists = receiverAssembly.IncludeHiddenLists;
// Pass parameters
List <string> parametersName = receiverAssembly.Parameters.Select(p => p.Name).Distinct().ToList();
foreach (string parameterName in parametersName)
{
PropertyInfo prop = receiverClass.GetProperty(parameterName);
// Check if the property exists
if (prop == null)
{
Exception ex = new Exception($"The '{parameterName}' property does not exist");
Logger.Warn(ex.Message, ex);
continue;
}
if (prop.PropertyType == typeof(string))
{
// Set the string property with the first parameter passed in the configuration file
prop.SetValue(receiver, receiverAssembly.Parameters.FirstOrDefault(p => p.Name == parameterName).Value);
}
else if (prop.PropertyType == typeof(List <string>))
{
// Set the list of strings properties with the paramters passed in the configuration file
prop.SetValue(receiver, receiverAssembly.Parameters.Where(p => p.Name == parameterName).Select(p => p.Value).ToList());
}
else
{
Exception ex = new Exception($"The '{parameterName}' property is not a string or a list of strings");
Logger.Warn(ex.Message, ex);
continue;
}
}
// Add receiver to receivers list of the running manager
runningManager.Receivers.Add(receiver);
}
// Create the SharePoint Online credentials if none is passed to parameters
if (credentials == null)
{
if (!string.IsNullOrWhiteSpace(configFileInfo.Login) && configFileInfo.SecuredPassword != null)
{
credentials = new SharePointOnlineCredentials(configFileInfo.Login, configFileInfo.SecuredPassword);
}
else
{
Exception ex = new Exception("No credentials provided. Please provide SharePoint Online credentials in the configuration file or calling the Run() method");
Logger.Error(ex.Message, ex);
throw ex;
}
}
// Set credentials
runningManager.Credentials = credentials;
// Get the URLs
runningManager.Urls.AddRange(configFileInfo.Urls);
// Get the StartingRunningLevel from its string name
runningManager.StartingRunningLevel = configFileInfo.StartRunningLevel;
// Return the running manager
return(runningManager);
}
