bindED/bindED.cs

#nullable enable

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text.RegularExpressions;
using System.Threading;
using System.Xml.Linq;

namespace bindEDplugin
{
    public class bindEDPlugin
    {
        private static dynamic? _VA;
        private static string? _pluginPath;
        private static readonly string _bindingsDir = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), @"Frontier Developments\Elite Dangerous\Options\Bindings");
        private static readonly Dictionary<string, int> _fileEventCount = new Dictionary<string, int>();

        private static FileSystemWatcher Watcher
        {
            get
            {
                if (_watcher == null)
                {
                    _watcher = new FileSystemWatcher(_bindingsDir);
                    _watcher.NotifyFilter = NotifyFilters.LastWrite | NotifyFilters.FileName;
                    _watcher.Changed += (source, EventArgs) => { FileChangedHandler(EventArgs.Name); };
                    _watcher.Created += (source, EventArgs) => { FileChangedHandler(EventArgs.Name); };
                    _watcher.Renamed += (source, EventArgs) => { FileChangedHandler(EventArgs.Name); };
                }
                return _watcher!;
            }
        }
        private static FileSystemWatcher? _watcher;

        private static string Layout
        {
            get => _layout ??= _VA?.GetText("bindED.layout#") ?? "en-us";
            set
            {
                _layout = value;
                KeyMap = null;
            }
        }
        private static string? _layout;

        private static Dictionary<string, int>? KeyMap
        {
            get => _keyMap ??= LoadKeyMap(Layout);
            set
            {
                _keyMap = value;
                Binds = null;
            }
        }
        private static Dictionary<string, int>? _keyMap;

        private static string? Preset
        {
            get => _preset ??= DetectPreset();
            set
            {
                _preset = value;
                Binds = null;
            }
        }
        private static string? _preset;

        private static Dictionary<string, string>? Binds
        {
            get => _binds ??= ReadBinds(DetectBindsFile(Preset));
            set => _binds = value;
        }
        private static Dictionary<string, string>? _binds;

        public static string VERSION = "3.0";

        public static string VA_DisplayName() => $"bindED Plugin v{VERSION}-alterNERDtive";

        public static string VA_DisplayInfo() => "bindED Plugin\r\n\r\n2016 VoiceAttack.com\r\n2020 alterNERDtive";

        public static Guid VA_Id() => new Guid("{524B4B9A-3965-4045-A39A-A239BF6E2838}");

        public static void VA_Init1(dynamic vaProxy)
        {
            _VA = vaProxy;
            _VA.TextVariableChanged += new Action<string, string, string, Guid?>(TextVariableChanged);
            _pluginPath = Path.GetDirectoryName(_VA.PluginPath());

            try
            {
                LoadBinds(Binds);
            }
            catch (Exception e)
            {
                LogError(e.Message);
            }
            finally
            {
                Watcher.EnableRaisingEvents = true;
            }
        }

        public static void VA_Invoke1(dynamic vaProxy)
        {
            _VA = vaProxy;
            try
            {
                string context = _VA.Context.ToLower();
                if (context == "listbinds")
                {
                    ListBinds(Binds, _VA.GetText("bindED.separator") ?? "\r\n");
                }
                else if (context == "loadbinds")
                {
                    LoadBinds(Binds);
                }
                else
                {
                    LogWarn("Invoking the plugin with no context / a .binds file as context is deprecated and will be removed in a future version. Please invoke the 'loadbinds' context instead.");
                    LogWarn("Bindings are also read automatically on VoiceAttack start and there should be no need to do it explicitly.");
                    LoadBinds(Binds);
                }
            }
            catch (Exception e)
            {
                LogError(e.Message);
            }
        }

        public static void VA_StopCommand() { }

        public static void VA_Exit1(dynamic vaProxy) { }

        public static void TextVariableChanged(string name, string from, string to, Guid? internalID)
        {
            if (name.Equals("bindED.layout#"))
            {
                LogInfo($"Keyboard layout changed to '{to}', reloading …");
                Layout = to;
                LoadBinds(Binds);
            }
        }

        private static void LogError(string message)
        {
            _VA!.WriteToLog($"ERROR | bindED: {message}", "red");
        }

        private static void LogInfo(string message)
        {
            _VA!.WriteToLog($"INFO | bindED: {message}", "blue");
        }

        private static void LogWarn(string message)
        {
            _VA!.WriteToLog($"WARN | bindED: {message}", "yellow");
        }

        public static void ListBinds(Dictionary<string, string>? binds, string separator)
        {
            _VA!.SetText("~bindED.bindsList", string.Join(separator, binds!.Keys));
            LogInfo("List of Elite binds saved to TXT variable '~bindED.bindsList'.");
        }

        private static void LoadBinds(Dictionary<string, string>? binds)
        {
            foreach (KeyValuePair<string, string> bind in binds!)
            {
                _VA!.SetText(bind.Key, bind.Value);
            }
            LogInfo($"Elite binds '{Preset}' for layout '{Layout}' loaded successfully.");
        }

        private static Dictionary<String, int> LoadKeyMap(string layout)
        {
            string mapFile = Path.Combine(_pluginPath, $"EDMap-{layout.ToLower()}.txt");
            if (!File.Exists(mapFile))
            {
                throw new FileNotFoundException($"No map file for layout '{layout}' found.");
            }
            Dictionary<string, int> map = new Dictionary<string, int>(256);
            foreach (String line in File.ReadAllLines(mapFile, System.Text.Encoding.UTF8))
            {
                String[] arItem = line.Split(";".ToCharArray(), 2, StringSplitOptions.RemoveEmptyEntries);
                if ((arItem.Count() == 2) && (!String.IsNullOrWhiteSpace(arItem[0])) && (!map.ContainsKey(arItem[0])))
                {
                    ushort iKey;
                    if (ushort.TryParse(arItem[1], out iKey))
                    {
                        if (iKey > 0 && iKey < 256)
                            map.Add(arItem[0].Trim(), iKey);
                    }
                }
            }
            if (map.Count == 0)
            {
                throw new Exception($"Map file for {layout} does not contain any elements.");
            }
            return map;
        }

        private static string DetectPreset()
        {
            string startFile = Path.Combine(_bindingsDir, "StartPreset.start");
            if (!File.Exists(startFile))
            {
                throw new FileNotFoundException("No 'StartPreset.start' file found. Please run Elite: Dangerous at least once, then restart VoiceAttack.");
            }
            return File.ReadAllText(startFile);
        }

        private static string DetectBindsFile(string? preset)
        {
            DirectoryInfo dirInfo = new DirectoryInfo(_bindingsDir);
            FileInfo[] bindFiles = dirInfo.GetFiles().Where(i => Regex.Match(i.Name, $@"^{preset}(\.3\.0)?\.binds$").Success).OrderByDescending(p => p.LastWriteTime).ToArray();

            if (bindFiles.Count() == 0)
            {
                throw new FileNotFoundException($"No bindings file found for preset '{preset}'. If this is a default preset, please change anything in Elite’s controls options.");
            }

            return bindFiles[0].FullName;
        }

        private static Dictionary<string, string> ReadBinds(string file)
        {
            XElement rootElement;

            rootElement = XElement.Load(file);

            Dictionary<string, string> binds = new Dictionary<string, string>(512);
            if (rootElement != null)
            {
                foreach (XElement c in rootElement.Elements().Where(i => i.Elements().Count() > 0))
                {
                    foreach (var element in c.Elements().Where(i => i.HasAttributes))
                    {
                        List<int> keys = new List<int>();
                        if (element.Name == "Primary")
                        {
                            if (element.Attribute("Device").Value == "Keyboard" && !String.IsNullOrWhiteSpace(element.Attribute("Key").Value) && element.Attribute("Key").Value.StartsWith("Key_"))
                            {
                                foreach (var modifier in element.Elements().Where(i => i.Name.LocalName == "Modifier"))
                                {
                                    if (KeyMap!.ContainsKey(modifier.Attribute("Key").Value))
                                        keys.Add(KeyMap[modifier.Attribute("Key").Value]);
                                }

                                if (KeyMap!.ContainsKey(element.Attribute("Key").Value))
                                    keys.Add(KeyMap[element.Attribute("Key").Value]);
                            }
                        }
                        if (keys.Count == 0) //nothing found in primary... look in secondary
                        {
                            if (element.Name == "Secondary")
                            {
                                if (element.Attribute("Device").Value == "Keyboard" && !String.IsNullOrWhiteSpace(element.Attribute("Key").Value) && element.Attribute("Key").Value.StartsWith("Key_"))
                                {
                                    foreach (var modifier in element.Elements().Where(i => i.Name.LocalName == "Modifier"))
                                    {
                                        if (KeyMap!.ContainsKey(modifier.Attribute("Key").Value))
                                            keys.Add(KeyMap[modifier.Attribute("Key").Value]);
                                    }

                                    if (KeyMap!.ContainsKey(element.Attribute("Key").Value))
                                        keys.Add(KeyMap[element.Attribute("Key").Value]);
                                }
                            }
                        }

                        if (keys.Count > 0)
                        {
                            String strTextValue = String.Empty;
                            foreach (int key in keys)
                                strTextValue += String.Format("[{0}]", key);

                            binds.Add($"ed{c.Name.LocalName}", strTextValue);
                        }
                    }
                }
            }
            return binds;
        }

        private static void FileChangedHandler(string name)
        {
            // so apparently these events all fire twice … let’s make sure we only handle it once.
            if (_fileEventCount.ContainsKey(name))
            {
                _fileEventCount[name] += 1;
            }
            else
            {
                _fileEventCount.Add(name, 1);
            }
            if (_fileEventCount[name] % 2 == 0)
            {
                try
                {
                    // let’s make semi-sure that the file isn’t locked …
                    // FIXXME: solve this properly
                    Thread.Sleep(500);
                    if (name == "StartPreset.start")
                    {
                        LogInfo("Controls preset changed, reloading …");
                        Preset = null;
                        LoadBinds(Binds);
                    }
                    else if (Regex.Match(name, $@"{_preset}(\.3\.0)?\.binds$").Success)
                    {
                        LogInfo($"Bindings file '{name}' has changed, reloading …");
                        Binds = null;
                        LoadBinds(Binds);
                    }
                }
                catch (Exception e)
                {
                    LogError(e.Message);
                }
            }
        }
    }
}