mirror of https://github.com/winsw/winsw
Rework Shared Directory Mapper (#765)
Next Turn
GitHub
parent
5a95c760a5
commit
c49d50381e
|
|
@ -1,17 +1,19 @@
|
|||
using System.Collections.Generic;
|
||||
using System.ComponentModel;
|
||||
using System.IO;
|
||||
using System.Runtime.InteropServices;
|
||||
using System.Xml;
|
||||
using log4net;
|
||||
using WinSW.Configuration;
|
||||
using WinSW.Extensions;
|
||||
using WinSW.Util;
|
||||
using static WinSW.Plugins.SharedDirectoryMapper.Native;
|
||||
|
||||
namespace WinSW.Plugins
|
||||
{
|
||||
public class SharedDirectoryMapper : AbstractWinSWExtension
|
||||
{
|
||||
private readonly SharedDirectoryMappingHelper _mapper = new();
|
||||
private readonly List<SharedDirectoryMapperConfig> _entries = new();
|
||||
private readonly List<SharedDirectoryMapperConfig> entries = new();
|
||||
|
||||
public override string DisplayName => "Shared Directory Mapper";
|
||||
|
||||
|
|
@ -24,28 +26,27 @@ namespace WinSW.Plugins
|
|||
public SharedDirectoryMapper(bool enableMapping, string directoryUNC, string driveLabel)
|
||||
{
|
||||
var config = new SharedDirectoryMapperConfig(enableMapping, driveLabel, directoryUNC);
|
||||
this._entries.Add(config);
|
||||
this.entries.Add(config);
|
||||
}
|
||||
|
||||
public override void Configure(IServiceConfig descriptor, XmlNode node)
|
||||
public override void Configure(IServiceConfig service, XmlNode extension)
|
||||
{
|
||||
var mapNodes = XmlHelper.SingleNode(node, "mapping", false)!.SelectNodes("map");
|
||||
var mapNodes = XmlHelper.SingleNode(extension, "mapping", false)!.SelectNodes("map");
|
||||
if (mapNodes != null)
|
||||
{
|
||||
for (int i = 0; i < mapNodes.Count; i++)
|
||||
{
|
||||
if (mapNodes[i] is XmlElement mapElement)
|
||||
{
|
||||
var config = SharedDirectoryMapperConfig.FromXml(mapElement);
|
||||
this._entries.Add(config);
|
||||
this.entries.Add(SharedDirectoryMapperConfig.FromXml(mapElement));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public override void Configure(IServiceConfig descriptor, YamlExtensionConfig config)
|
||||
public override void Configure(IServiceConfig service, YamlExtensionConfig extension)
|
||||
{
|
||||
var dict = config.GetSettings();
|
||||
var dict = extension.GetSettings();
|
||||
|
||||
object mappingNode = dict["mapping"];
|
||||
|
||||
|
|
@ -56,57 +57,84 @@ namespace WinSW.Plugins
|
|||
|
||||
foreach (object map in mappings)
|
||||
{
|
||||
var mapConfig = SharedDirectoryMapperConfig.FromYaml(map);
|
||||
this._entries.Add(mapConfig);
|
||||
this.entries.Add(SharedDirectoryMapperConfig.FromYaml(map));
|
||||
}
|
||||
}
|
||||
|
||||
public override void OnWrapperStarted()
|
||||
{
|
||||
foreach (var config in this._entries)
|
||||
foreach (var config in this.entries)
|
||||
{
|
||||
string label = config.Label;
|
||||
string uncPath = config.UNCPath;
|
||||
if (config.EnableMapping)
|
||||
{
|
||||
Logger.Info(this.DisplayName + ": Mapping shared directory " + config.UNCPath + " to " + config.Label);
|
||||
try
|
||||
Logger.Info(this.DisplayName + ": Mapping shared directory " + uncPath + " to " + label);
|
||||
|
||||
int error = WNetAddConnection2(new()
|
||||
{
|
||||
this._mapper.MapDirectory(config.Label, config.UNCPath);
|
||||
}
|
||||
catch (MapperException ex)
|
||||
Type = RESOURCETYPE_DISK,
|
||||
LocalName = label,
|
||||
RemoteName = uncPath,
|
||||
});
|
||||
if (error != 0)
|
||||
{
|
||||
this.HandleMappingError(config, ex);
|
||||
this.ThrowExtensionException(error, $"Mapping of {label} failed.");
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
Logger.Warn(this.DisplayName + ": Mapping of " + config.Label + " is disabled");
|
||||
Logger.Warn(this.DisplayName + ": Mapping of " + label + " is disabled");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public override void BeforeWrapperStopped()
|
||||
{
|
||||
foreach (var config in this._entries)
|
||||
foreach (var config in this.entries)
|
||||
{
|
||||
string label = config.Label;
|
||||
if (config.EnableMapping)
|
||||
{
|
||||
try
|
||||
int error = WNetCancelConnection2(label);
|
||||
if (error != 0)
|
||||
{
|
||||
this._mapper.UnmapDirectory(config.Label);
|
||||
}
|
||||
catch (MapperException ex)
|
||||
{
|
||||
this.HandleMappingError(config, ex);
|
||||
this.ThrowExtensionException(error, $"Unmapping of {label} failed.");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void HandleMappingError(SharedDirectoryMapperConfig config, MapperException ex)
|
||||
private void ThrowExtensionException(int error, string message)
|
||||
{
|
||||
Logger.Error("Mapping of " + config.Label + " failed. STDOUT: " + ex.Process.StandardOutput.ReadToEnd()
|
||||
+ " \r\nSTDERR: " + ex.Process.StandardError.ReadToEnd(), ex);
|
||||
throw new ExtensionException(this.Descriptor.Id, this.DisplayName + ": Mapping of " + config.Label + "failed", ex);
|
||||
var inner = new Win32Exception(error);
|
||||
throw new ExtensionException(this.Descriptor.Id, $"{this.DisplayName}: {message} {inner.Message}", inner);
|
||||
}
|
||||
|
||||
internal static class Native
|
||||
{
|
||||
internal const uint RESOURCETYPE_DISK = 0x00000001;
|
||||
|
||||
private const string MprLibraryName = "mpr.dll";
|
||||
|
||||
[DllImport(MprLibraryName, SetLastError = true, CharSet = CharSet.Unicode, EntryPoint = "WNetAddConnection2W")]
|
||||
internal static extern int WNetAddConnection2(in NETRESOURCE netResource, string? password = null, string? userName = null, uint flags = 0);
|
||||
|
||||
[DllImport(MprLibraryName, SetLastError = true, CharSet = CharSet.Unicode, EntryPoint = "WNetCancelConnection2W")]
|
||||
internal static extern int WNetCancelConnection2(string name, uint flags = 0, bool force = false);
|
||||
|
||||
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
|
||||
internal struct NETRESOURCE
|
||||
{
|
||||
public uint Scope;
|
||||
public uint Type;
|
||||
public uint DisplayType;
|
||||
public uint Usage;
|
||||
public string LocalName;
|
||||
public string RemoteName;
|
||||
public string Comment;
|
||||
public string Provider;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
using System.Collections.Generic;
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Xml;
|
||||
using WinSW.Util;
|
||||
using static System.Environment;
|
||||
|
||||
namespace WinSW.Plugins
|
||||
{
|
||||
|
|
@ -38,11 +38,11 @@ namespace WinSW.Plugins
|
|||
throw new InvalidDataException("SharedDirectoryMapperConfig config error");
|
||||
}
|
||||
|
||||
string enableMappingConfig = ExpandEnvironmentVariables((string)dict["enabled"]);
|
||||
string enableMappingConfig = Environment.ExpandEnvironmentVariables((string)dict["enabled"]);
|
||||
bool enableMapping = ConfigHelper.YamlBoolParse(enableMappingConfig);
|
||||
|
||||
string label = ExpandEnvironmentVariables((string)dict["label"]);
|
||||
string uncPath = ExpandEnvironmentVariables((string)dict["uncPath"]);
|
||||
string label = Environment.ExpandEnvironmentVariables((string)dict["label"]);
|
||||
string uncPath = Environment.ExpandEnvironmentVariables((string)dict["uncPath"]);
|
||||
|
||||
return new SharedDirectoryMapperConfig(enableMapping, label, uncPath);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,71 +0,0 @@
|
|||
using System.Diagnostics;
|
||||
|
||||
namespace WinSW.Plugins
|
||||
{
|
||||
class SharedDirectoryMappingHelper
|
||||
{
|
||||
/// <summary>
|
||||
/// Invokes a system command
|
||||
/// </summary>
|
||||
/// <see cref="SharedDirectoryMapper"/>
|
||||
/// <param name="command">Command to be executed</param>
|
||||
/// <param name="args">Command arguments</param>
|
||||
/// <exception cref="MapperException">Operation failure</exception>
|
||||
private void InvokeCommand(string command, string args)
|
||||
{
|
||||
var p = new Process
|
||||
{
|
||||
StartInfo =
|
||||
{
|
||||
UseShellExecute = false,
|
||||
CreateNoWindow = true,
|
||||
RedirectStandardError = true,
|
||||
RedirectStandardOutput = true,
|
||||
FileName = command,
|
||||
Arguments = args
|
||||
}
|
||||
};
|
||||
|
||||
p.Start();
|
||||
p.WaitForExit();
|
||||
if (p.ExitCode != 0)
|
||||
{
|
||||
throw new MapperException(p, command, args);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Maps the remote directory
|
||||
/// </summary>
|
||||
/// <param name="label">Disk label</param>
|
||||
/// <param name="uncPath">UNC path to the directory</param>
|
||||
/// <exception cref="MapperException">Operation failure</exception>
|
||||
public void MapDirectory(string label, string uncPath)
|
||||
{
|
||||
this.InvokeCommand("net.exe", " use " + label + " " + uncPath);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Unmaps the label
|
||||
/// </summary>
|
||||
/// <param name="label">Disk label</param>
|
||||
/// <exception cref="MapperException">Operation failure</exception>
|
||||
public void UnmapDirectory(string label)
|
||||
{
|
||||
this.InvokeCommand("net.exe", " use /DELETE /YES " + label);
|
||||
}
|
||||
}
|
||||
|
||||
class MapperException : WinSWException
|
||||
{
|
||||
public string Call { get; private set; }
|
||||
public Process Process { get; private set; }
|
||||
|
||||
public MapperException(Process process, string command, string args)
|
||||
: base("Command " + command + " " + args + " failed with code " + process.ExitCode)
|
||||
{
|
||||
this.Call = command + " " + args;
|
||||
this.Process = process;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -7,7 +7,7 @@ using WinSW.Plugins;
|
|||
namespace winswTests.Extensions
|
||||
{
|
||||
[TestFixture]
|
||||
class SharedDirectoryMapperTest : ExtensionTestBase
|
||||
class SharedDirectoryMapperConfigTest : ExtensionTestBase
|
||||
{
|
||||
IServiceConfig _testServiceDescriptor;
|
||||
IServiceConfig _testServiceDescriptorYaml;
|
||||
|
|
@ -0,0 +1,148 @@
|
|||
#if NET
|
||||
using System;
|
||||
using System.IO;
|
||||
using System.Runtime.CompilerServices;
|
||||
using System.Runtime.InteropServices;
|
||||
using NUnit.Framework;
|
||||
using WinSW.Plugins;
|
||||
|
||||
namespace winswTests.Extensions
|
||||
{
|
||||
// TODO: Throws.TypeOf<ExtensionException>()
|
||||
[TestFixture]
|
||||
public class SharedDirectoryMapperTests
|
||||
{
|
||||
[Test]
|
||||
public void TestMap()
|
||||
{
|
||||
using var data = TestData.Create();
|
||||
|
||||
const string label = "W:";
|
||||
var mapper = new SharedDirectoryMapper(true, $@"\\{Environment.MachineName}\{data.name}", label);
|
||||
|
||||
mapper.OnWrapperStarted();
|
||||
Assert.That($@"{label}\", Does.Exist);
|
||||
mapper.BeforeWrapperStopped();
|
||||
Assert.That($@"{label}\", Does.Not.Exist);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public void TestDisableMapping()
|
||||
{
|
||||
using var data = TestData.Create();
|
||||
|
||||
const string label = "W:";
|
||||
var mapper = new SharedDirectoryMapper(enableMapping: false, $@"\\{Environment.MachineName}\{data.name}", label);
|
||||
|
||||
mapper.OnWrapperStarted();
|
||||
Assert.That($@"{label}\", Does.Not.Exist);
|
||||
mapper.BeforeWrapperStopped();
|
||||
}
|
||||
|
||||
[Test]
|
||||
public void TestMap_PathEndsWithSlash_Throws()
|
||||
{
|
||||
using var data = TestData.Create();
|
||||
|
||||
const string label = "W:";
|
||||
var mapper = new SharedDirectoryMapper(true, $@"\\{Environment.MachineName}\{data.name}\", label);
|
||||
|
||||
Assert.That(() => mapper.OnWrapperStarted(), Throws.Exception);
|
||||
Assert.That($@"{label}\", Does.Not.Exist);
|
||||
Assert.That(() => mapper.BeforeWrapperStopped(), Throws.Exception);
|
||||
}
|
||||
|
||||
[Test]
|
||||
public void TestMap_LabelDoesNotEndWithColon_Throws()
|
||||
{
|
||||
using var data = TestData.Create();
|
||||
|
||||
const string label = "W";
|
||||
var mapper = new SharedDirectoryMapper(true, $@"\\{Environment.MachineName}\{data.name}", label);
|
||||
|
||||
Assert.That(() => mapper.OnWrapperStarted(), Throws.Exception);
|
||||
Assert.That($@"{label}\", Does.Not.Exist);
|
||||
Assert.That(() => mapper.BeforeWrapperStopped(), Throws.Exception);
|
||||
}
|
||||
|
||||
private readonly ref struct TestData
|
||||
{
|
||||
internal readonly string name;
|
||||
internal readonly string path;
|
||||
|
||||
private TestData(string name, string path)
|
||||
{
|
||||
this.name = name;
|
||||
this.path = path;
|
||||
}
|
||||
|
||||
internal static TestData Create([CallerMemberName] string name = null)
|
||||
{
|
||||
string path = Path.Combine(Path.GetTempPath(), name);
|
||||
_ = Directory.CreateDirectory(path);
|
||||
|
||||
try
|
||||
{
|
||||
var shareInfo = new NativeMethods.SHARE_INFO_2
|
||||
{
|
||||
netname = name,
|
||||
type = NativeMethods.STYPE_DISKTREE | NativeMethods.STYPE_TEMPORARY,
|
||||
max_uses = unchecked((uint)-1),
|
||||
path = path,
|
||||
};
|
||||
|
||||
uint error = NativeMethods.NetShareAdd(null, 2, shareInfo, out _);
|
||||
Assert.That(error, Is.Zero);
|
||||
|
||||
return new TestData(name, path);
|
||||
}
|
||||
catch
|
||||
{
|
||||
Directory.Delete(path);
|
||||
throw;
|
||||
}
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
try
|
||||
{
|
||||
uint error = NativeMethods.NetShareDel(null, this.name);
|
||||
Assert.That(error, Is.Zero);
|
||||
}
|
||||
finally
|
||||
{
|
||||
Directory.Delete(this.path);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private static class NativeMethods
|
||||
{
|
||||
internal const uint STYPE_DISKTREE = 0;
|
||||
internal const uint STYPE_TEMPORARY = 0x40000000;
|
||||
|
||||
private const string Netapi32LibraryName = "netapi32.dll";
|
||||
|
||||
[DllImport(Netapi32LibraryName, CharSet = CharSet.Unicode)]
|
||||
internal static extern uint NetShareAdd(string servername, uint level, in SHARE_INFO_2 buf, out uint parm_err);
|
||||
|
||||
[DllImport(Netapi32LibraryName, CharSet = CharSet.Unicode)]
|
||||
internal static extern uint NetShareDel(string servername, string netname, uint reserved = 0);
|
||||
|
||||
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
|
||||
internal struct SHARE_INFO_2
|
||||
{
|
||||
public string netname;
|
||||
public uint type;
|
||||
public string remark;
|
||||
public uint permissions;
|
||||
public uint max_uses;
|
||||
public uint current_uses;
|
||||
public string path;
|
||||
public string passwd;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
#endif
|
||||
Loading…
Reference in New Issue