Add MoryxFileSystem to kernel

Author: Thomas Fuchs

src/Moryx.Runtime.Kernel/FileSystem/HashPath.cs

@@ -0,0 +1,67 @@
+using Microsoft.Extensions.Logging;
+using Moryx.Logging;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Security.Cryptography;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Moryx.Runtime.Kernel.FileSystem
+{
+    internal class HashPath
+    {
+        public string Hash { get; private set; }
+
+        public string DirectoryName { get; private set; }
+
+        public string FileName { get; private set; }
+
+        private HashPath()
+        {
+        }
+
+        public static HashPath FromStream(Stream stream) =>
+            BuildPath(HashFromStream(stream));
+
+        public static HashPath FromHash(string hash) =>
+            BuildPath(hash);
+
+        public string FilePath(string storagePath) =>
+            Path.Combine(storagePath, DirectoryName, FileName);
+
+        public string DirectoryPath(string storagePath) =>
+            Path.Combine(storagePath, DirectoryName);
+
+        private static HashPath BuildPath(string hash)
+        {
+            return new HashPath
+            {
+                Hash = hash,
+                DirectoryName = hash.Substring(0, 2),
+                FileName = hash.Substring(2)
+            };
+        }
+
+        private static string HashFromStream(Stream stream)
+        {
+            string name;
+            using (var hashing = SHA256.Create())
+            {
+                stream.Position = 0;
+
+                var hash = hashing.ComputeHash(stream);
+                var nameBuilder = new StringBuilder(hash.Length * 2);
+                foreach (var hashByte in hash)
+                {
+                    nameBuilder.AppendFormat("{0:X2}", hashByte);
+                }
+                name = nameBuilder.ToString();
+
+                stream.Position = 0;
+            }
+
+            return name;
+        }
+    }
+}

src/Moryx.Runtime.Kernel/FileSystem/MoryxFileSystem.cs

@@ -0,0 +1,87 @@
+using Microsoft.Extensions.Logging;
+using Moryx.FileSystem;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Moryx.Runtime.Kernel.FileSystem
+{
+    internal class MoryxFileSystem : IMoryxFileSystem
+    {
+        private string _fsDirectory;
+        private readonly ILogger _logger;
+
+        public MoryxFileSystem(ILoggerFactory loggerFactory)
+        {
+            _logger = loggerFactory.CreateLogger(nameof(MoryxFileSystem));
+        }
+
+        public void SetBasePath(string basePath = "fs")
+        {
+            _fsDirectory = Path.Combine(Directory.GetCurrentDirectory(), basePath);
+        }
+
+        public Stream ReadFile(string hash)
+        {
+            var path = HashPath.FromHash(hash).FilePath(_fsDirectory);           
+            return File.Exists(path) ? new FileStream(path, FileMode.Open, FileAccess.Read) : null;
+        }
+
+        public async Task<string> WriteFile(Stream stream)
+        {
+            var hashPath = HashPath.FromStream(stream);
+
+            // Create directory if necessary
+            var targetPath = hashPath.DirectoryPath(_fsDirectory);
+            try
+            {
+                if (!Directory.Exists(targetPath))
+                    Directory.CreateDirectory(targetPath);
+            }
+            catch (Exception e)
+            {
+                throw LoggedException(e, _logger, _fsDirectory);
+            }
+
+            var fileName = hashPath.FilePath(_fsDirectory);
+            if (File.Exists(fileName))
+                return hashPath.Hash;
+
+            // Write file
+            try
+            {
+                using var fileStream = new FileStream(fileName, FileMode.Create);
+                await stream.CopyToAsync(fileStream);
+                fileStream.Flush();
+                stream.Position = 0;
+            }
+            catch (Exception e)
+            {
+                throw LoggedException(e, _logger, fileName);
+            }
+
+            return hashPath.Hash;
+        }
+
+        private Exception LoggedException(Exception e, ILogger logger, string cause)
+        {
+            switch (e)
+            {
+                case UnauthorizedAccessException unauthorizedAccessException:
+                    logger.LogError("Error: {0}. You do not have the required permission to manipulate the file {1}.", e.Message, cause); // ToDo
+                    return unauthorizedAccessException;
+                case ArgumentException argumentException:
+                    logger.LogError("Error: {0}. The path {1} contains invalid characters such as \", <, >, or |.", e.Message, cause);
+                    return argumentException;
+                case IOException iOException:
+                    logger.LogError("Error: {0}. An I/O error occurred while opening the file {1}.", e.Message, cause);
+                    return iOException;
+                default:
+                    logger.LogError("Unspecified error on file system access: {0}", e.Message);
+                    return e;
+            }
+        }
+    }
+}

src/Moryx.Runtime.Kernel/KernelServiceCollectionExtensions.cs

@@ -4,6 +4,8 @@
 using Microsoft.Extensions.DependencyInjection;
 using Moryx.Configuration;
 using Moryx.Container;
+using Moryx.FileSystem;
+using Moryx.Runtime.Kernel.FileSystem;
 using Moryx.Runtime.Modules;
 using Moryx.Threading;
 using System;
@@ -30,6 +32,10 @@ public static void AddMoryxKernel(this IServiceCollection serviceCollection)
             serviceCollection.AddSingleton<ModuleManager>();
             serviceCollection.AddSingleton<IModuleManager>(x => x.GetRequiredService<ModuleManager>());
 
+            // Register module manager
+            serviceCollection.AddSingleton<MoryxFileSystem>();
+            serviceCollection.AddSingleton<IMoryxFileSystem>(x => x.GetRequiredService<MoryxFileSystem>());
+
             // Register parallel operations
             serviceCollection.AddTransient<IParallelOperations, ParallelOperations>();
 
@@ -87,6 +93,19 @@ public static IConfigManager UseMoryxConfigurations(this IServiceProvider servic
             return configManager;
         }
 
+        /// <summary>
+        /// Use moryx file system and configure base directory
+        /// </summary>
+        /// <returns></returns>
+        public static IMoryxFileSystem UseMoryxFileSystem(this IServiceProvider serviceProvider, string path)
+        {
+            var fileSystem = serviceProvider.GetRequiredService<MoryxFileSystem>();
+            if (!Directory.Exists(path))
+                Directory.CreateDirectory(path);
+            fileSystem.SetBasePath(path);
+            return fileSystem;
+        }
+
         private static IModuleManager _moduleManager;
         /// <summary>
         /// Boot system and start all modules

src/Moryx/FileSystem/IMoryxFileSystem.cs

@@ -0,0 +1,26 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Moryx.FileSystem
+{
+    /// <summary>
+    /// Common file system interface across MORYX modules and components. 
+    /// </summary>
+    public interface IMoryxFileSystem
+    {
+        /// <summary>
+        /// Write a file to the file system and receive the hash to access it later
+        /// </summary>
+        Task<string> WriteFile(Stream fileStream);
+
+        /// <summary>
+        /// Read the file by passing the file system hash
+        /// </summary>
+        /// <param name="hash"></param>
+        /// <returns></returns>
+        Stream ReadFile(string hash);
+    }
+}

src/Moryx/Moryx.csproj

@@ -15,7 +15,7 @@
 
   <ItemGroup>
     <PackageReference Include="Newtonsoft.Json" />
-    <PackageReference Include="Microsoft.Extensions.Logging"/>
+    <PackageReference Include="Microsoft.Extensions.Logging" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFramework)'=='netstandard2.0'">