Extend MQTTnet.Server application.

2026-10-16 17:23:04 +08:00 · 2019-03-05 21:37:00 +01:00
parent b68247f56d
commit 6f5f507323
32 changed files with 1114 additions and 309 deletions
@@ -0,0 +1,47 @@
+using System;
+using System.Collections.Generic;
+using Microsoft.Extensions.Logging;
+
+namespace MQTTnet.Server.Scripting.DataSharing
+{
+    public class DataSharingService
+    {
+        private readonly Dictionary<string, object> _storage = new Dictionary<string, object>();
+        private readonly PythonScriptHostService _pythonScriptHostService;
+        private readonly ILogger<DataSharingService> _logger;
+
+        public DataSharingService(PythonScriptHostService pythonScriptHostService, ILogger<DataSharingService> logger)
+        {
+            _pythonScriptHostService = pythonScriptHostService ?? throw new ArgumentNullException(nameof(pythonScriptHostService));
+            _logger = logger ?? throw new ArgumentNullException(nameof(logger));
+        }
+
+        public void Configure()
+        {
+            _pythonScriptHostService.RegisterProxyObject("write_shared_data", new Action<string, object>(Write));
+            _pythonScriptHostService.RegisterProxyObject("read_shared_data", new Func<string, object, object>(Read));
+        }
+
+        public void Write(string key, object value)
+        {
+            lock (_storage)
+            {
+                _storage[key] = value;
+                _logger.LogInformation($"Shared data with key '{key}' updated.");
+            }
+        }
+
+        public object Read(string key, object defaultValue)
+        {
+            lock (_storage)
+            {
+                if (!_storage.TryGetValue(key, out var value))
+                {
+                    return defaultValue;
+                }
+
+                return value;
+            }
+        }
+    }
+}
@@ -0,0 +1,88 @@
+using System;
+using System.Collections;
+using System.Text;
+using IronPython.Runtime;
+
+namespace MQTTnet.Server.Scripting
+{
+    public static class PythonConvert
+    {
+        public static object ToPython(object value)
+        {
+            if (value is PythonDictionary)
+            {
+                return value;
+            }
+
+            if (value is string)
+            {
+                return value;
+            }
+
+            if (value is int)
+            {
+                return value;
+            }
+
+            if (value is float)
+            {
+                return value;
+            }
+
+            if (value is bool)
+            {
+                return value;
+            }
+
+            if (value is IDictionary dictionary)
+            {
+                var pythonDictionary = new PythonDictionary();
+                foreach (DictionaryEntry dictionaryEntry in dictionary)
+                {
+                    pythonDictionary.Add(dictionaryEntry.Key, ToPython(dictionaryEntry.Value));
+                }
+
+                return pythonDictionary;
+            }
+
+            if (value is IEnumerable enumerable)
+            {
+                var pythonList = new List();
+                foreach (var item in enumerable)
+                {
+                    pythonList.Add(ToPython(item));
+                }
+
+                return pythonList;
+            }
+
+            return value;
+        }
+
+        public static string Pythonfy(Enum value)
+        {
+            return Pythonfy(value.ToString());
+        }
+
+        public static string Pythonfy(string value)
+        {
+            var result = new StringBuilder();
+            foreach (var @char in value)
+            {
+                if (char.IsUpper(@char) && result.Length > 0)
+                {
+                    result.Append('_');
+                }
+
+                result.Append(char.ToLowerInvariant(@char));
+            }
+
+            return result.ToString();
+        }
+
+        public static TEnum ParseEnum<TEnum>(string value) where TEnum : Enum
+        {
+            return (TEnum)Enum.Parse(typeof(TEnum), value.Replace("_", string.Empty), true);
+        }
+    }
+}
@@ -0,0 +1,66 @@
+using System;
+using System.IO;
+using System.Text;
+using Microsoft.Extensions.Logging;
+
+namespace MQTTnet.Server.Scripting
+{
+    public class PythonIOStream : Stream
+    {
+        private readonly ILogger _logger;
+        private readonly Encoding _encoder = Encoding.UTF8;
+
+        public PythonIOStream(ILogger<PythonIOStream> logger)
+        {
+            _logger = logger ?? throw new ArgumentNullException(nameof(logger));
+        }
+
+        public override void Flush()
+        {
+        }
+
+        public override int Read(byte[] buffer, int offset, int count)
+        {
+            throw new NotSupportedException();
+        }
+
+        public override long Seek(long offset, SeekOrigin origin)
+        {
+            throw new NotSupportedException();
+        }
+
+        public override void SetLength(long value)
+        {
+            throw new NotSupportedException();
+        }
+
+        public override void Write(byte[] buffer, int offset, int count)
+        {
+            if (buffer == null) throw new ArgumentNullException(nameof(buffer));
+
+            if (count == 0)
+            {
+                return;
+            }
+
+            var text = _encoder.GetString(buffer, offset, count);
+            if (text.Equals(Environment.NewLine))
+            {
+                return;
+            }
+
+            _logger.LogDebug(text);
+        }
+
+        public override bool CanRead { get; } = false;
+        public override bool CanSeek { get; } = false;
+        public override bool CanWrite { get; } = true;
+        public override long Length { get; } = 0L;
+
+        public override long Position
+        {
+            get => throw new NotSupportedException();
+            set => throw new NotSupportedException();
+        }
+    }
+}
@@ -0,0 +1,130 @@
+using System;
+using System.Collections.Generic;
+using System.Dynamic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using Microsoft.Extensions.Logging;
+using Microsoft.Scripting;
+using Microsoft.Scripting.Hosting;
+
+namespace MQTTnet.Server.Scripting
+{
+    public class PythonScriptHostService
+    {
+        private readonly IDictionary<string, object> _proxyObjects = new ExpandoObject();
+        private readonly List<PythonScriptInstance> _scriptInstances = new List<PythonScriptInstance>();
+        private readonly ILogger<PythonScriptHostService> _logger;
+        private readonly ScriptEngine _scriptEngine;
+        
+        public PythonScriptHostService(PythonIOStream pythonIOStream, ILogger<PythonScriptHostService> logger)
+        {
+            _logger = logger ?? throw new ArgumentNullException(nameof(logger));
+
+            _scriptEngine = IronPython.Hosting.Python.CreateEngine();
+            _scriptEngine.Runtime.IO.SetOutput(pythonIOStream, Encoding.UTF8);
+        }
+
+        public void Configure()
+        {
+            AddSearchPaths(_scriptEngine);
+
+            var scriptsDirectory = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Scripts");
+            foreach (var filename in Directory.GetFiles(scriptsDirectory, "*.py", SearchOption.AllDirectories).OrderBy(file => file))
+            {
+                TryInitializeScript(filename);
+            }
+        }
+
+        public void RegisterProxyObject(string name, object action)
+        {
+            if (name == null) throw new ArgumentNullException(nameof(name));
+            if (action == null) throw new ArgumentNullException(nameof(action));
+
+            _proxyObjects.Add(name, action);
+        }
+
+        public void InvokeOptionalFunction(string name, object parameters)
+        {
+            if (name == null) throw new ArgumentNullException(nameof(name));
+
+            lock (_scriptInstances)
+            {
+                foreach (var pythonScriptInstance in _scriptInstances)
+                {
+                    try
+                    {
+                        pythonScriptInstance.InvokeOptionalFunction(name, parameters);
+                    }
+                    catch (Exception exception)
+                    {
+                        _logger.LogError(exception, $"Error while invoking function '{name}' at script '{pythonScriptInstance.Name}'.");
+                    }
+                }
+            }
+        }
+
+        private void TryInitializeScript(string filename)
+        {
+            try
+            {
+                var scriptName = new FileInfo(filename).Name;
+
+                _logger.LogTrace($"Initializing Python script '{scriptName}'...");
+                var code = File.ReadAllText(filename);
+
+                var scriptInstance = CreateScriptInstance(scriptName, code);
+                scriptInstance.InvokeOptionalFunction("initialize");
+
+                _scriptInstances.Add(scriptInstance);
+
+                _logger.LogInformation($"Initialized script '{scriptName}'.");
+            }
+            catch (Exception exception)
+            {
+                _logger.LogError(exception, $"Error while initializing script '{new FileInfo(filename).Name}'.");
+            }
+        }
+
+        private PythonScriptInstance CreateScriptInstance(string name, string code)
+        {
+            var scriptScope = _scriptEngine.CreateScope();
+
+            var source = scriptScope.Engine.CreateScriptSourceFromString(code, SourceCodeKind.File);
+            var compiledCode = source.Compile();
+
+            scriptScope.SetVariable("mqtt_net_server", _proxyObjects);
+            compiledCode.Execute(scriptScope);
+            
+            return new PythonScriptInstance(name, scriptScope);
+        }
+
+        private void AddSearchPaths(ScriptEngine scriptEngine)
+        {
+            var paths = new List<string>
+            {
+                Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Lib"),
+                "/usr/lib/python2.7",
+                @"C:\Python27\Lib"
+            };
+            
+            AddSearchPaths(scriptEngine, paths);
+        }
+
+        private void AddSearchPaths(ScriptEngine scriptEngine, IEnumerable<string> paths)
+        {
+            var searchPaths = scriptEngine.GetSearchPaths();
+
+            foreach (var path in paths)
+            {
+                if (Directory.Exists(path))
+                {
+                    searchPaths.Add(path);
+                    _logger.LogInformation($"Added Python lib path: {path}");
+                }
+            }
+
+            scriptEngine.SetSearchPaths(searchPaths);
+        }
+    }
+}
@@ -0,0 +1,57 @@
+using System;
+using IronPython.Runtime;
+using Microsoft.Scripting.Hosting;
+
+namespace MQTTnet.Server.Scripting
+{
+    public class PythonScriptInstance
+    {
+        private readonly ScriptScope _scriptScope;
+
+        public PythonScriptInstance(string name, ScriptScope scriptScope)
+        {
+            _scriptScope = scriptScope;
+
+            Name = name;
+        }
+
+        public string Name { get; }
+
+        public bool InvokeOptionalFunction(string name, params object[] parameters)
+        {
+            return InvokeOptionalFunction(name, parameters, out _);
+        }
+
+        public bool InvokeOptionalFunction(string name, object[] parameters, out object result)
+        {
+            if (name == null) throw new ArgumentNullException(nameof(name));
+
+            lock (_scriptScope)
+            {
+                if (!_scriptScope.Engine.Operations.TryGetMember(_scriptScope, name, out var member))
+                {
+                    result = null;
+                    return false;
+                }
+
+                if (!(member is PythonFunction function))
+                {
+                    throw new Exception($"Member '{name}' is no Python function.");
+                }
+
+                try
+                {
+                    result = _scriptScope.Engine.Operations.Invoke(function, parameters);
+                    return true;
+                }
+                catch (Exception exception)
+                {
+                    var details = _scriptScope.Engine.GetService<ExceptionOperations>().FormatException(exception);
+                    var message = $"Error while invoking function '{name}'. " + Environment.NewLine + details;
+
+                    throw new Exception(message, exception);
+                }
+            }
+        }
+    }
+}