EmailImporter plugin. More...

Inheritance diagram for Hermod.EmailImport.EmailImporter:

Public Member Functions

EmailImporter ()

override void OnConfigChanged (ConfigChangedEventArgs e)

Method that is called when an application-wide configuration has been modified.

Parameters

e	The ConfigChangedEventArgs that are generated when a config was modified.

override void OnConfigLoaded ()

Method that is called when the application-wide configurations have been loaded.

override void OnLoad (IPluginDelegator pluginDelegator)

Method that is called once the plugin has been loaded. This may be used for pre-init purposes.

Parameters

pluginDelegator The delegator allocated to this plugin.

override void OnStart ()

Method that is called once Hermod has completed its startup procedures and is ready to run.

override void OnStop ()

Method that is called when Hermod is shutting down.

Public Member Functions inherited from Hermod.PluginFramework.Plugin

Plugin (string pluginName, Version pluginVersion, params ICommand[] commands)

Specialised constructor; allows inheriting classes to set their values immediately.

abstract void OnLoad (IPluginDelegator pluginDelegator)

Method that is called once the plugin has been loaded. This may be used for pre-init purposes.

Parameters

pluginDelegator The delegator allocated to this plugin.

abstract void OnStart ()

Method that is called once Hermod has completed its startup procedures and is ready to run.

abstract void OnStop ()

Method that is called when Hermod is shutting down.

abstract void OnConfigChanged (ConfigChangedEventArgs e)

Method that is called when an application-wide configuration has been modified.

Parameters

e	The ConfigChangedEventArgs that are generated when a config was modified.

abstract void OnConfigLoaded ()

Method that is called when the application-wide configurations have been loaded.

void OnLoad (IPluginDelegator pluginDelegator)

Method that is called once the plugin has been loaded. This may be used for pre-init purposes.

void OnStart ()

Method that is called once Hermod has completed its startup procedures and is ready to run.

void OnStop ()

Method that is called when Hermod is shutting down.

void OnConfigChanged (ConfigChangedEventArgs e)

Method that is called when an application-wide configuration has been modified.

void OnConfigLoaded ()

Method that is called when the application-wide configurations have been loaded.

Private Member Functions
void	PluginDelegator_MessageReceived (object? sender, MessageReceivedEventArgs e)
	Event handler which is called when a message is received on a topic this plugin subscribed.

void	HandleAddDomainMessageReceived (string topic, object? message)

void	DoWork ()

ICommandResult	Handle_GetDomains (params string[] args)

ICommandResult	Handle_GetSingleDomain (params string[] args)

ICommandResult	Handle_AddDomain (params string[] args)

ICommandResult	Handle_RemoveDomain (params string[] args)

ICommandResult	Handle_GetUsers (params string[] args)

ICommandResult	Handle_GetUser (params string[] args)

ICommandResult	Handle_AddUser (params string[] args)

ICommandResult	Handle_RemoveUser (params string[] args)

Private Attributes
readonly string[]	m_subscribeTopics
	The topic EmailImport subscribes to when a user is to be removed from a domain.

volatile bool	m_keepThreadAlive = false

DatabaseConnector?	m_dbConnector

IPluginDelegator?	m_pluginDelegator = null

Thread?	m_importThread = null

Static Private Attributes
const string	GetDomainTopicAllSuffix = "all"

const string	AddDomainTopic = "/hermod/domain/add"

const string	GetDomainTopic = "/hermod/domain/get/+"
	The topic EmailImport subscribes to add a new domain.

const string	RemoveDomainTopic = "/hermod/domain/remove/+"
	The topic EmailImport subscribes when another plugin requests a domain.

const string	GetDomainResponseTopic = "/hermod/domain/response"
	The topic EmailImport subscribes to when a domain shall be removed.

const string	GetDomainUserTopic = "/hermod/user/get"
	The topic EmailImport publishes to when a topic was requested.

const string	AddDomainUserTopic = "/hermod/user/add/+"
	The topic EmailImport subscribes to when a user is requested.

const string	RemoveDomainUserTopic = "/hermod/user/remove"
	The topic EmailImport subscribes to when a user is to be added to a domain.

Additional Inherited Members
Properties inherited from Hermod.PluginFramework.Plugin
Version	PluginVersion `[get, protected set]`
	Gets the version of the plugin.

string	PluginName `[get, protected set]`
	Gets the name of the plugin.

List< ICommand >	PluginCommands `[get, protected set]`
	A list of all commands this plugin provides.

Properties inherited from Hermod.PluginFramework.IPlugin
Version	PluginVersion `[get]`
	Gets the version of the plugin.

string	PluginName `[get]`
	Gets the name of the plugin.

List< ICommand >	PluginCommands `[get]`
	A list of all commands this plugin provides.

Detailed Description

EmailImporter plugin.

Definition at line 7 of file EmailImport.MessageHandling.cs.

Constructor & Destructor Documentation

◆ EmailImporter()

Hermod.EmailImport.EmailImporter.EmailImporter ( )

inline

Definition at line 43 of file EmailImporter.cs.

                              : base(nameof(EmailImporter), new Version(0, 0, 1)) {
            PluginCommands = new List<ICommand> {
                new TerminalCommand(
                    "get-domains", "Gets a list of all known domains",
                    "This command retrieves a list of all domains currently\n" +
                    "known to the Hermod EmailImporter.\n" +
                    "Usage: get-domains [tld [tld]] # only with these TLDs",
                    Handle_GetDomains
                ),
                new TerminalCommand(
                    "get-domain", "Gets information about a single domain",
                    "This command retrieves a single domain and information about it.\n" +
                    "Usage: get-domain <domain-name>",
                    Handle_GetSingleDomain
                ),
                new TerminalCommand(
                    "add-domain", "Adds a new domain to the system",
                    "This command allows a new domain to be added to Hermod.\n" +
                    "Usage: add-domain <domain-name [domain-name [...]]> # domain-name is expected as tld.domain[.subdomain]",
                    Handle_AddDomain
                ),
                new TerminalCommand(
                    "remove-domain", "Removes one or more domains from the system",
                    "This command removes one or more domains from Hermod.\n" +
                    "Usage: remove-domain <domain-name [domain-name [...]]> # domain-name is expected as tld.domain[.subdomain]",
                    Handle_RemoveDomain
                ),
                new TerminalCommand(
                    "get-users", "Retrieves a list of all users in a domain",
                    "This command retrieves a list of all users allocated to a domain.\n" +
                    "Usage: get-users [domain-name] # domain-name is expected as tld.domain[.subdomain]",
                    Handle_GetUsers
                ),
                new TerminalCommand(
                    "get-user", "Gets detailled information about a single user",
                    "This command allows retrievel of detailled information,\n" +
                    "such as email address, password hash, salt and account type\n" +
                    "in a single domain.\n" +
                    "Usage: get-user <domain> <user>",
                    Handle_GetUser
                ),
                new TerminalCommand(
                    "add-user", "Adds a single user to a domain",
                    "This command adds a single user to a single domain,\n" +
                    "provided info: user name, password, password salt, and account type.\n" +
                    "Usage: add-user <domain> <user> <password> <account type>\n" +
                    "Note: this is the only time Hermod will know of the user's cleartext password!",
                    Handle_AddUser
                ),
                new TerminalCommand(
                    "remove-user", "Removes a single user from a domain",
                    "This command allows a single user to be removed from a domain.\n" +
                    "!! WARNING !! This process is irreversible!\n" +
                    "Usage: remove-user <domain> <user>",
                    Handle_RemoveUser
                )
            };
        }

References Hermod.EmailImport.EmailImporter.Handle_AddDomain(), Hermod.EmailImport.EmailImporter.Handle_AddUser(), Hermod.EmailImport.EmailImporter.Handle_GetDomains(), Hermod.EmailImport.EmailImporter.Handle_GetSingleDomain(), Hermod.EmailImport.EmailImporter.Handle_GetUser(), Hermod.EmailImport.EmailImporter.Handle_GetUsers(), Hermod.EmailImport.EmailImporter.Handle_RemoveDomain(), Hermod.EmailImport.EmailImporter.Handle_RemoveUser(), and Hermod.PluginFramework.Plugin.PluginCommands.

Member Function Documentation

◆ DoWork()

void Hermod.EmailImport.EmailImporter.DoWork ( )

inlineprivate

Definition at line 7 of file EmailImporter.BusinessLogic.cs.

                              {
            
        }

Referenced by Hermod.EmailImport.EmailImporter.OnStart().

◆ Handle_AddDomain()

ICommandResult Hermod.EmailImport.EmailImporter.Handle_AddDomain ( params string[] args )

inlineprivate

Definition at line 17 of file EmailImporter.CommandHandling.cs.

                                                                      {
            return new CommandErrorResult("This command is not yet implemented. Sorry");
        }

Referenced by Hermod.EmailImport.EmailImporter.EmailImporter().

◆ Handle_AddUser()

ICommandResult Hermod.EmailImport.EmailImporter.Handle_AddUser ( params string[] args )

inlineprivate

Definition at line 33 of file EmailImporter.CommandHandling.cs.

                                                                    {
            return new CommandErrorResult("This command is not yet implemented. Sorry");
        }

Referenced by Hermod.EmailImport.EmailImporter.EmailImporter().

◆ Handle_GetDomains()

ICommandResult Hermod.EmailImport.EmailImporter.Handle_GetDomains ( params string[] args )

inlineprivate

Definition at line 9 of file EmailImporter.CommandHandling.cs.

                                                                       {
            return new CommandErrorResult("This command is not yet implemented. Sorry");
        }

Referenced by Hermod.EmailImport.EmailImporter.EmailImporter().

◆ Handle_GetSingleDomain()

ICommandResult Hermod.EmailImport.EmailImporter.Handle_GetSingleDomain ( params string[] args )

inlineprivate

Definition at line 13 of file EmailImporter.CommandHandling.cs.

                                                                            {
            return new CommandErrorResult("This command is not yet implemented. Sorry");
        }

Referenced by Hermod.EmailImport.EmailImporter.EmailImporter().

◆ Handle_GetUser()

ICommandResult Hermod.EmailImport.EmailImporter.Handle_GetUser ( params string[] args )

inlineprivate

Definition at line 29 of file EmailImporter.CommandHandling.cs.

                                                                    {
            return new CommandErrorResult("This command is not yet implemented. Sorry");
        }

Referenced by Hermod.EmailImport.EmailImporter.EmailImporter().

◆ Handle_GetUsers()

ICommandResult Hermod.EmailImport.EmailImporter.Handle_GetUsers ( params string[] args )

inlineprivate

Definition at line 25 of file EmailImporter.CommandHandling.cs.

                                                                     {
            return new CommandErrorResult("This command is not yet implemented. Sorry");
        }

Referenced by Hermod.EmailImport.EmailImporter.EmailImporter().

◆ Handle_RemoveDomain()

ICommandResult Hermod.EmailImport.EmailImporter.Handle_RemoveDomain ( params string[] args )

inlineprivate

Definition at line 21 of file EmailImporter.CommandHandling.cs.

                                                                         {
            return new CommandErrorResult("This command is not yet implemented. Sorry");
        }

Referenced by Hermod.EmailImport.EmailImporter.EmailImporter().

◆ Handle_RemoveUser()

ICommandResult Hermod.EmailImport.EmailImporter.Handle_RemoveUser ( params string[] args )

inlineprivate

Definition at line 37 of file EmailImporter.CommandHandling.cs.

                                                                       {
            return new CommandErrorResult("This command is not yet implemented. Sorry");
        }

Referenced by Hermod.EmailImport.EmailImporter.EmailImporter().

◆ HandleAddDomainMessageReceived()

void Hermod.EmailImport.EmailImporter.HandleAddDomainMessageReceived	(	string	topic,
		object?	message
	)

inlineprivate

Definition at line 23 of file EmailImport.MessageHandling.cs.

                                                                                   {
 
        }

Referenced by Hermod.EmailImport.EmailImporter.PluginDelegator_MessageReceived().

◆ OnConfigChanged()

override void Hermod.EmailImport.EmailImporter.OnConfigChanged ( ConfigChangedEventArgs e )

inlinevirtual

Method that is called when an application-wide configuration has been modified.

Parameters

e	The ConfigChangedEventArgs that are generated when a config was modified.

Implements Hermod.PluginFramework.Plugin.

Definition at line 102 of file EmailImporter.cs.

102{ }

◆ OnConfigLoaded()

override void Hermod.EmailImport.EmailImporter.OnConfigLoaded ( )

inlinevirtual

Method that is called when the application-wide configurations have been loaded.

Implements Hermod.PluginFramework.Plugin.

Definition at line 104 of file EmailImporter.cs.

104{ }

◆ OnLoad()

override void Hermod.EmailImport.EmailImporter.OnLoad ( IPluginDelegator pluginDelegator )

inlinevirtual

Method that is called once the plugin has been loaded. This may be used for pre-init purposes.

Parameters

pluginDelegator The delegator allocated to this plugin.

Implements Hermod.PluginFramework.Plugin.

Definition at line 106 of file EmailImporter.cs.

                                                                      {
            m_pluginDelegator = pluginDelegator;
 
            if (m_pluginDelegator.GetApplicationConfig<bool>("Accounts.UseDatabase")) {
                // dynamic dbInfo = m_pluginDelegator.GetApplicationConfig<object>("Accounts.DatabaseInfo");
                // m_dbConnector = new MySqlDatabaseConnector(
                //     dbInfo.Host,
                //     dbInfo.DatabaseUser,
                //     dbInfo.DatabasePass,
                //     dbInfo.DatabaseName,
                //     pluginDelegator
                // );
                throw new Exception("MySqlDatabaseConnector is not usable in this version!");
            } else if (m_pluginDelegator.GetApplicationConfig<bool>("Accounts.UseJsonFile")) {
                var filePath = m_pluginDelegator.GetApplicationConfig<string?>("Accounts.JsonFileInfo.FilePath");
                if (filePath is null) {
                    filePath = AppInfo.GetLocalHermodDirectory().GetSubFile(".accounts.json").FullName;
                }
 
                byte[] encKey = null;
                byte[] initVec = null;
 
                void GetEncryptionData(ref byte[] encKey, ref byte[] initVec) {
                    var tmpKey = m_pluginDelegator?.GetApplicationConfig<string?>("Accounts.EncryptionKey");
                    if (string.IsNullOrEmpty(tmpKey)) {
                        m_pluginDelegator?.Information("Found invalid encryption keys! Generating new encryption data...");
                        JsonDatabaseConnector.GenerateNewAesKey(out encKey, out initVec);
                        return;
                    }
                    Base64.DecodeFromUtf8(Encoding.UTF8.GetBytes(tmpKey), encKey, out _, out _);
 
                    tmpKey = m_pluginDelegator?.GetApplicationConfig<string?>("Accounts.EncryptionInitVec");
                    if (string.IsNullOrEmpty(tmpKey)) {
                        m_pluginDelegator?.Information("Found invalid encryption keys! Generating new encryption data...");
                        JsonDatabaseConnector.GenerateNewAesKey(out encKey, out initVec);
                        return;
                    }
 
                    Base64.DecodeFromUtf8(Encoding.UTF8.GetBytes(tmpKey), initVec, out _, out _);
                }
 
                GetEncryptionData(ref encKey, ref initVec);
                m_dbConnector = new JsonDatabaseConnector(
                    new FileInfo(filePath),
                    encKey, initVec
                );
            } else {
                throw new InvalidDataSourceException();
            }
 
            m_pluginDelegator.Debug("Subscribing all topics...");
            pluginDelegator.SubscribeTopics(m_subscribeTopics);
 
            m_pluginDelegator.Information("Email Importer has loaded!");
        }

References Hermod.Core.Delegation.IPluginDelegator.Debug(), Hermod.EmailImport.Data.JsonDatabaseConnector.GenerateNewAesKey(), Hermod.Core.AppInfo.GetLocalHermodDirectory(), Hermod.Core.Delegation.IPluginDelegator.Information(), Hermod.EmailImport.EmailImporter.m_dbConnector, Hermod.EmailImport.EmailImporter.m_pluginDelegator, Hermod.EmailImport.EmailImporter.m_subscribeTopics, and Hermod.Core.Delegation.IPluginDelegator.SubscribeTopics().

◆ OnStart()

override void Hermod.EmailImport.EmailImporter.OnStart ( )

inlinevirtual

Method that is called once Hermod has completed its startup procedures and is ready to run.

Implements Hermod.PluginFramework.Plugin.

Definition at line 162 of file EmailImporter.cs.

                                       {
            m_keepThreadAlive = true;
            m_importThread = new Thread(DoWork);
            m_importThread.Start();
        }

References Hermod.EmailImport.EmailImporter.DoWork(), Hermod.EmailImport.EmailImporter.m_importThread, and Hermod.EmailImport.EmailImporter.m_keepThreadAlive.

◆ OnStop()

override void Hermod.EmailImport.EmailImporter.OnStop ( )

inlinevirtual

Method that is called when Hermod is shutting down.

Implements Hermod.PluginFramework.Plugin.

Definition at line 168 of file EmailImporter.cs.

                                      {
            m_pluginDelegator?.Information("Stopping worker threads...");
            m_keepThreadAlive = false;
        }

References Hermod.Core.Delegation.IPluginDelegator.Information(), Hermod.EmailImport.EmailImporter.m_keepThreadAlive, and Hermod.EmailImport.EmailImporter.m_pluginDelegator.

◆ PluginDelegator_MessageReceived()

void Hermod.EmailImport.EmailImporter.PluginDelegator_MessageReceived	(	object?	sender,
		MessageReceivedEventArgs	e
	)

inlineprivate

Event handler which is called when a message is received on a topic this plugin subscribed.

Parameters

sender	The IPluginDelegator instance which raised the event.
e	The message.

Definition at line 15 of file EmailImport.MessageHandling.cs.

                                                                                                 {
            switch (e.Topic) {
                case AddDomainTopic:
                    HandleAddDomainMessageReceived(e.Topic, e.Message);
                    break;
            }
        }

References Hermod.EmailImport.EmailImporter.AddDomainTopic, Hermod.EmailImport.EmailImporter.HandleAddDomainMessageReceived(), Hermod.Core.Delegation.MessageReceivedEventArgs.Message, and Hermod.Core.Delegation.MessageReceivedEventArgs.Topic.

Member Data Documentation

◆ AddDomainTopic

const string Hermod.EmailImport.EmailImporter.AddDomainTopic = "/hermod/domain/add"

staticprivate

Definition at line 25 of file EmailImporter.cs.

Referenced by Hermod.EmailImport.EmailImporter.PluginDelegator_MessageReceived().

◆ AddDomainUserTopic

const string Hermod.EmailImport.EmailImporter.AddDomainUserTopic = "/hermod/user/add/+"

staticprivate

The topic EmailImport subscribes to when a user is requested.

Definition at line 30 of file EmailImporter.cs.

◆ GetDomainResponseTopic

const string Hermod.EmailImport.EmailImporter.GetDomainResponseTopic = "/hermod/domain/response"

staticprivate

The topic EmailImport subscribes to when a domain shall be removed.

Definition at line 28 of file EmailImporter.cs.

◆ GetDomainTopic

const string Hermod.EmailImport.EmailImporter.GetDomainTopic = "/hermod/domain/get/+"

staticprivate

The topic EmailImport subscribes to add a new domain.

Definition at line 26 of file EmailImporter.cs.

◆ GetDomainTopicAllSuffix

const string Hermod.EmailImport.EmailImporter.GetDomainTopicAllSuffix = "all"

staticprivate

Definition at line 24 of file EmailImporter.cs.

◆ GetDomainUserTopic

const string Hermod.EmailImport.EmailImporter.GetDomainUserTopic = "/hermod/user/get"

staticprivate

The topic EmailImport publishes to when a topic was requested.

Definition at line 29 of file EmailImporter.cs.

◆ m_dbConnector

DatabaseConnector? Hermod.EmailImport.EmailImporter.m_dbConnector

private

Definition at line 39 of file EmailImporter.cs.

Referenced by Hermod.EmailImport.EmailImporter.OnLoad().

◆ m_importThread

Thread? Hermod.EmailImport.EmailImporter.m_importThread = null

private

Definition at line 41 of file EmailImporter.cs.

Referenced by Hermod.EmailImport.EmailImporter.OnStart().

◆ m_keepThreadAlive

volatile bool Hermod.EmailImport.EmailImporter.m_keepThreadAlive = false

private

Definition at line 38 of file EmailImporter.cs.

Referenced by Hermod.EmailImport.EmailImporter.OnStart(), and Hermod.EmailImport.EmailImporter.OnStop().

◆ m_pluginDelegator

IPluginDelegator? Hermod.EmailImport.EmailImporter.m_pluginDelegator = null

private

Definition at line 40 of file EmailImporter.cs.

Referenced by Hermod.EmailImport.EmailImporter.OnLoad(), and Hermod.EmailImport.EmailImporter.OnStop().

◆ m_subscribeTopics

readonly string [] Hermod.EmailImport.EmailImporter.m_subscribeTopics

private

Initial value:

= {
            AddDomainTopic, GetDomainTopic, RemoveDomainTopic, GetDomainUserTopic,
            AddDomainUserTopic, RemoveDomainUserTopic
        }

The topic EmailImport subscribes to when a user is to be removed from a domain.

Definition at line 33 of file EmailImporter.cs.

Referenced by Hermod.EmailImport.EmailImporter.OnLoad().

◆ RemoveDomainTopic

const string Hermod.EmailImport.EmailImporter.RemoveDomainTopic = "/hermod/domain/remove/+"

staticprivate

The topic EmailImport subscribes when another plugin requests a domain.

Definition at line 27 of file EmailImporter.cs.

◆ RemoveDomainUserTopic

const string Hermod.EmailImport.EmailImporter.RemoveDomainUserTopic = "/hermod/user/remove"

staticprivate

The topic EmailImport subscribes to when a user is to be added to a domain.

Definition at line 31 of file EmailImporter.cs.

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EmailImporter()

Member Function Documentation

◆ DoWork()

◆ Handle_AddDomain()

◆ Handle_AddUser()

◆ Handle_GetDomains()

◆ Handle_GetSingleDomain()

◆ Handle_GetUser()

◆ Handle_GetUsers()

◆ Handle_RemoveDomain()

◆ Handle_RemoveUser()

◆ HandleAddDomainMessageReceived()

◆ OnConfigChanged()

◆ OnConfigLoaded()

◆ OnLoad()

◆ OnStart()

◆ OnStop()

◆ PluginDelegator_MessageReceived()

Member Data Documentation

◆ AddDomainTopic

◆ AddDomainUserTopic

◆ GetDomainResponseTopic

◆ GetDomainTopic

◆ GetDomainTopicAllSuffix

◆ GetDomainUserTopic

◆ m_dbConnector

◆ m_importThread

◆ m_keepThreadAlive

◆ m_pluginDelegator

◆ m_subscribeTopics

◆ RemoveDomainTopic

◆ RemoveDomainUserTopic