Hermod's entry point. More...

Static Private Member Functions
static async Task< int >	Main (string[] args)

static void	InitialiseConfigs ()
	Initialises the application's config manager.

static void	InitialiseLogger ()
	Initialises the application's logger.

static int	ParseArgs (string[] args)
	Parses the command-line arguments passed to the application.

static void	PrintHelp ()
	Prints the help text for hermod.

static string	GetApplicationVersion ()
	Gets the application's version string.

static void	PrintVersion ()
	Prints the application's version.

static ? LogEventLevel	GetLogLevelFromArg (string? arg)
	Converts an incoming application argument to its respective log level.

Static Private Attributes
static string	_shortOpts = "c:L:hv%Ui"

static Option[]	_longOpts

static ? FileInfo	_overriddenConfigLocation = null

static ? ILogger	_appLogger = null

static ? LogEventLevel	_logLevel = null

static ConfigManager	_cfgManager = ConfigManager.Instance

static bool	_interactiveMode = false

Detailed Description

Hermod's entry point.

Handles all pre-init steps and starts execution of the main business logic.

Definition at line 20 of file Program.cs.

Member Function Documentation

◆ GetApplicationVersion()

static string Hermod.Program.GetApplicationVersion ( )

inlinestaticprivate

Gets the application's version string.

Returns: A string matching v0.0.0.0

Definition at line 170 of file Program.cs.

                                              {
            var version = Assembly.GetExecutingAssembly().GetName().Version;
 
            return $"v{ version?.Major }.{ version?.MajorRevision }.{ version?.Minor }.{ version?.MinorRevision }";
        }

Referenced by Hermod.Program.PrintHelp().

◆ GetLogLevelFromArg()

static ? LogEventLevel Hermod.Program.GetLogLevelFromArg ( string? arg )

inlinestaticprivate

Converts an incoming application argument to its respective log level.

Parameters

arg	The argument to parse.

Returns: true

if an appropriate log level was found.
false

otherwise.

Definition at line 186 of file Program.cs.

                                                              {
            arg = arg?.ToLowerInvariant() ?? string.Empty;
 
            switch (arg) {
                case "debug":
                    return LogEventLevel.Debug;
                case "trace":
                    return LogEventLevel.Verbose;
                case "warn":
                case "warning":
                    return LogEventLevel.Warning;
                case "error":
                    return LogEventLevel.Error;
                case "info":
                case "information":
                    return LogEventLevel.Information;
                case "fatal":
                    return LogEventLevel.Fatal;
                default:
                    return null;
            }
        }

Referenced by Hermod.Program.InitialiseLogger(), and Hermod.Program.ParseArgs().

◆ InitialiseConfigs()

static void Hermod.Program.InitialiseConfigs ( )

inlinestaticprivate

Initialises the application's config manager.

Definition at line 62 of file Program.cs.

                                        {
            if (_overriddenConfigLocation != null) {
                _cfgManager.ConfigFile = _overriddenConfigLocation;
            } else {
                _cfgManager.LoadConfig();
            }
        }

References Hermod.Program._cfgManager, and Hermod.Program._overriddenConfigLocation.

Referenced by Hermod.Program.Main().

◆ InitialiseLogger()

static void Hermod.Program.InitialiseLogger ( )

inlinestaticprivate

Initialises the application's logger.

Definition at line 73 of file Program.cs.

                                       {
            var consoleSettings = _cfgManager.GetConsoleLoggerConfig();
            var fileSettings = _cfgManager.GetFileLoggerConfig();
            Core.Logger logger = new Core.Logger() {
                ConsoleLogLevel = _logLevel ?? GetLogLevelFromArg(consoleSettings.LogLevel) ?? LogEventLevel.Warning,
                EnableConsoleOutput = consoleSettings.EnableLogging,
 
                FileLogLevel = GetLogLevelFromArg(fileSettings.LogLevel) ?? LogEventLevel.Information,
                EnableFileOutput = fileSettings.EnableLogging
            };
 
            _appLogger = logger.GetLogger();
        }

References Hermod.Program._appLogger, Hermod.Program._cfgManager, Hermod.Program._logLevel, Hermod.Core.Logger.GetLogger(), Hermod.Program.GetLogLevelFromArg(), and Hermod.Core.Logger.Logger().

Referenced by Hermod.Program.Main().

◆ Main()

static async Task< int > Hermod.Program.Main ( string[] args )

inlinestaticprivate

Definition at line 40 of file Program.cs.

                                                   {
            var returnCode = ParseArgs(args);
            if (returnCode != 0) { return returnCode - 1; }
 
            InitialiseConfigs();
 
            InitialiseLogger();
 
            _cfgManager.AppLogger = _appLogger;
 
            var app = new Hermod(_cfgManager, _appLogger ?? Log.Logger) {
                InteractiveMode = _interactiveMode,
                m_keepAlive = true
            };
            app.StartUp();
 
            return await app.Execute();
        }

References Hermod.Program._appLogger, Hermod.Program._cfgManager, Hermod.Program._interactiveMode, Hermod.Program.InitialiseConfigs(), Hermod.Program.InitialiseLogger(), and Hermod.Program.ParseArgs().

◆ ParseArgs()

static int Hermod.Program.ParseArgs ( string[] args )

inlinestaticprivate

Parses the command-line arguments passed to the application.

Parameters

args	The arguments passed.

Returns: 0 if program execution shall continue. Non-zero otherwise.

Definition at line 92 of file Program.cs.

                                            {
 
            var getopt = new GetOpt {
                AppArgs = args,
                DoubleDashStopsParsing = true,
                Options = _longOpts,
                ShortOpts = _shortOpts
            };
 
            int optChar = -1;
            do {
                optChar = getopt.GetNextOpt(out var optArg);
 
                switch (optChar) {
                    case -1:
                    case 0:
                        break;
                    case 'h':
                        PrintHelp();
                        return 1;
                    case 'v':
                        PrintVersion();
                        return 1;
                    case 'c':
                        if (string.IsNullOrEmpty(optArg)) {
                            Console.Error.WriteLine("Missing argument for --config!");
                            return 2;
                        }
                        _overriddenConfigLocation = new FileInfo(optArg);
                        break;
                    case 'L':
                        if (string.IsNullOrEmpty(optArg)) {
                            Console.Error.WriteLine("Missing argument for --log-lvl!");
                            return 2;
                        }
                        _logLevel = GetLogLevelFromArg(optArg);
                        break;
                    case 'i':
                        _interactiveMode = true;
                        break;
                    default:
                        Console.Error.WriteLine($"The argument { optChar } is not yet implemented!");
                        break;
                }
            } while (optChar != -1);
 
            return 0;
        }

References Hermod.Program._interactiveMode, Hermod.Program._logLevel, Hermod.Program._longOpts, Hermod.Program._overriddenConfigLocation, Hermod.Program._shortOpts, Hermod.Program.GetLogLevelFromArg(), Hermod.Program.PrintHelp(), and Hermod.Program.PrintVersion().

Referenced by Hermod.Program.Main().

◆ PrintHelp()

static void Hermod.Program.PrintHelp ( )

inlinestaticprivate

Prints the help text for hermod.

Definition at line 144 of file Program.cs.

                                {
            Console.WriteLine(
"""
hermod {0} - A high-performance, cross-platform email archival and search engine
 
Usage: (hermod has full getopt support)
    hermod # no options = normal execution
    hermod [options]
 
Switches:
    --help,         -h          Display this entry and exit
    --version,      -v          Display the application version and exit
    --reset-cfg,    -%          !!! DANGER !!! Resets the configurations to their default values!
 
Arguments:
    --config,       -c<config>  Override the application config file location
    --log-lvl,      -L<lvl>     Override the log level: debug, trace, error, warning (default), info, critical
""",
                GetApplicationVersion()
            );
        }

References Hermod.Program.GetApplicationVersion().

Referenced by Hermod.Program.ParseArgs().

◆ PrintVersion()

static void Hermod.Program.PrintVersion ( )

staticprivate

Prints the application's version.

Referenced by Hermod.Program.ParseArgs().

Member Data Documentation

◆ _appLogger

? ILogger Hermod.Program._appLogger = null

staticprivate

Definition at line 35 of file Program.cs.

Referenced by Hermod.Program.InitialiseLogger(), and Hermod.Program.Main().

◆ _cfgManager

ConfigManager Hermod.Program._cfgManager = ConfigManager.Instance

staticprivate

Definition at line 37 of file Program.cs.

Referenced by Hermod.Program.InitialiseConfigs(), Hermod.Program.InitialiseLogger(), and Hermod.Program.Main().

◆ _interactiveMode

bool Hermod.Program._interactiveMode = false

staticprivate

Definition at line 38 of file Program.cs.

Referenced by Hermod.Program.Main(), and Hermod.Program.ParseArgs().

◆ _logLevel

? LogEventLevel Hermod.Program._logLevel = null

staticprivate

Definition at line 36 of file Program.cs.

Referenced by Hermod.Program.InitialiseLogger(), and Hermod.Program.ParseArgs().

◆ _longOpts

Option [] Hermod.Program._longOpts

staticprivate

Initial value:

= new[] {
            new Option { Name = "config",           ArgumentType = ArgumentType.Required,  Value = 'c' },
            new Option { Name = "log-lvl",          ArgumentType = ArgumentType.Required,  Value = 'L' },
            new Option { Name = "help",             ArgumentType = ArgumentType.None,      Value = 'h' },
            new Option { Name = "version",          ArgumentType = ArgumentType.None,      Value = 'v' },
            new Option { Name = "check-updates",    ArgumentType = ArgumentType.None,      Value = 'U' },
            new Option { Name = "reset-cfg",        ArgumentType = ArgumentType.Optional,  Value = '%' },
            new Option { Name = "interactive",      ArgumentType = ArgumentType.None,      Value = 'i' }
            
        }

Definition at line 23 of file Program.cs.

Referenced by Hermod.Program.ParseArgs().

◆ _overriddenConfigLocation

? FileInfo Hermod.Program._overriddenConfigLocation = null

staticprivate

Definition at line 34 of file Program.cs.

Referenced by Hermod.Program.InitialiseConfigs(), and Hermod.Program.ParseArgs().

◆ _shortOpts

string Hermod.Program._shortOpts = "c:L:hv%Ui"

staticprivate

Definition at line 22 of file Program.cs.

Referenced by Hermod.Program.ParseArgs().

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

Program.cs

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

◆ GetApplicationVersion()

◆ GetLogLevelFromArg()

◆ InitialiseConfigs()

◆ InitialiseLogger()

◆ Main()

◆ ParseArgs()

◆ PrintHelp()

◆ PrintVersion()

Member Data Documentation

◆ _appLogger

◆ _cfgManager

◆ _interactiveMode

◆ _logLevel

◆ _longOpts

◆ _overriddenConfigLocation

◆ _shortOpts