mirror of
https://github.com/tgstation/tgstation-server.git
synced 2026-08-30 08:33:19 +01:00
Sanely namespaces the project
This commit is contained in:
Cyberboss
@@ -0,0 +1,500 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Diagnostics;
|
||||
using System.Linq;
|
||||
using System.Net;
|
||||
using System.Net.Security;
|
||||
using System.Reflection;
|
||||
using System.Security.Principal;
|
||||
using System.ServiceModel;
|
||||
using TGS.Interface.Components;
|
||||
|
||||
namespace TGS.Interface
|
||||
{
|
||||
/// <summary>
|
||||
/// Main <see langword="interface"/> for communicating the <see cref="ITGSService"/>
|
||||
/// </summary>
|
||||
public interface IServerInterface : IDisposable
|
||||
{
|
||||
/// <summary>
|
||||
/// The name of the current instance in use. Defaults to <see langword="null"/>
|
||||
/// </summary>
|
||||
string InstanceName { get; }
|
||||
|
||||
/// <summary>
|
||||
/// If this is set, we will try and connect to an HTTPS server running at this address
|
||||
/// </summary>
|
||||
string HTTPSURL { get; }
|
||||
|
||||
/// <summary>
|
||||
/// The port used to connect to the <see cref="ITGSService"/>
|
||||
/// </summary>
|
||||
ushort HTTPSPort { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Checks if the <see cref="IServerInterface"/> is setup for a remote connection
|
||||
/// </summary>
|
||||
bool IsRemoteConnection { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Targets <paramref name="instanceName"/> as the instance to use with <see cref="GetComponent{T}"/>. Closes all connections to any previous instance
|
||||
/// </summary>
|
||||
/// <param name="instanceName">The name of the instance to connect to</param>
|
||||
/// <param name="skipChecks">If set to <see langword="true"/>, skips the connectivity and authentication checks, sets <see cref="InstanceName"/>, and returns <see cref="ConnectivityLevel.Connected"/></param>
|
||||
/// <returns>The apporopriate <see cref="ConnectivityLevel"/></returns>
|
||||
ConnectivityLevel ConnectToInstance(string instanceName = null, bool skipChecks = false);
|
||||
|
||||
/// <summary>
|
||||
/// Returns <see langword="true"/> if the <see cref="IServerInterface"/> interface being used to connect to a service does not have the same release version as the service
|
||||
/// </summary>
|
||||
/// <param name="errorMessage">An error message to display to the user should this function return <see langword="true"/></param>
|
||||
/// <returns><see langword="true"/> if the <see cref="IServerInterface"/> interface being used to connect to a service does not have the same release version as the service</returns>
|
||||
bool VersionMismatch(out string errorMessage);
|
||||
|
||||
/// <summary>
|
||||
/// Returns the requested <see cref="IServerInterface"/> component <see langword="interface"/> for the instance <see cref="InstanceName"/>. This does not guarantee a successful connection.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The component <see langword="interface"/> to retrieve</typeparam>
|
||||
/// <returns>The correct component <see langword="interface"/></returns>
|
||||
T GetComponent<T>();
|
||||
|
||||
/// <summary>
|
||||
/// Returns a root service component
|
||||
/// </summary>
|
||||
/// <returns>The <see cref="ITGSService"/> component for the service</returns>
|
||||
T GetServiceComponent<T>();
|
||||
|
||||
/// <summary>
|
||||
/// Used to test if the <see cref="ITGSService"/> is avaiable on the target machine. Note that state can change at any time and any call into the may throw an exception because of communcation errors
|
||||
/// </summary>
|
||||
/// <returns><see langword="null"/> on successful connection, error message <see cref="string"/> on failure</returns>
|
||||
ConnectivityLevel ConnectionStatus();
|
||||
|
||||
/// <summary>
|
||||
/// Used to test if the <see cref="ITGSService"/> is avaiable on the target machine. Note that state can change at any time and any call into the may throw an exception because of communcation errors
|
||||
/// </summary>
|
||||
/// <param name="error">String of the error that prevented an elevated connectivity level</param>
|
||||
/// <returns>The apporopriate <see cref="ConnectivityLevel"/></returns>
|
||||
ConnectivityLevel ConnectionStatus(out string error);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
sealed public class ServerInterface : IServerInterface
|
||||
{
|
||||
/// <summary>
|
||||
/// List of <see langword="interface"/>s that can be used with <see cref="GetServiceComponent{T}"/>
|
||||
/// </summary>
|
||||
public static readonly IList<Type> ValidServiceInterfaces = new List<Type> { typeof(ITGSService), typeof(ITGInstanceManager), typeof(ITGConnectivity), typeof(ITGLanding) };
|
||||
|
||||
/// <summary>
|
||||
/// List of <see langword="interface"/>s that can be used with <see cref="GetComponent{T}"/>
|
||||
/// </summary>
|
||||
public static readonly IList<Type> ValidInstanceInterfaces = CollectComponents();
|
||||
|
||||
/// <summary>
|
||||
/// The maximum message size to and from a local server
|
||||
/// </summary>
|
||||
public const long TransferLimitLocal = Int32.MaxValue; //2GB can't go higher
|
||||
|
||||
/// <summary>
|
||||
/// The maximum message size to and from a remote server
|
||||
/// </summary>
|
||||
public const long TransferLimitRemote = 10485760; //10 MB
|
||||
|
||||
/// <summary>
|
||||
/// Base name of communication URLs
|
||||
/// </summary>
|
||||
public const string MasterInterfaceName = "TGStationServerService";
|
||||
/// <summary>
|
||||
/// Base name of instance URLs
|
||||
/// </summary>
|
||||
public const string InstanceInterfaceName = MasterInterfaceName + "/Instance";
|
||||
|
||||
/// <inheritdoc />
|
||||
public string InstanceName { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// If this is set, we will try and connect to an HTTPS server running at this address
|
||||
/// </summary>
|
||||
readonly string _HTTPSURL;
|
||||
|
||||
/// <inheritdoc />
|
||||
public string HTTPSURL { get { return _HTTPSURL; } }
|
||||
|
||||
/// <summary>
|
||||
/// The port used to connect to the <see cref="ITGSService"/>
|
||||
/// </summary>
|
||||
readonly ushort _HTTPSPort;
|
||||
|
||||
/// <inheritdoc />
|
||||
public ushort HTTPSPort { get { return _HTTPSPort; } }
|
||||
|
||||
/// <summary>
|
||||
/// Username for remote operations
|
||||
/// </summary>
|
||||
readonly string HTTPSUsername;
|
||||
|
||||
/// <summary>
|
||||
/// Password for remote operations
|
||||
/// </summary>
|
||||
readonly string HTTPSPassword;
|
||||
|
||||
/// <summary>
|
||||
/// Associated list of open <see cref="ChannelFactory"/>s keyed by <see langword="interface"/> type name. A <see cref="ChannelFactory"/> in this list may close or fault at any time. Must be locked before being accessed
|
||||
/// </summary>
|
||||
IDictionary<string, ChannelFactory> ChannelFactoryCache = new Dictionary<string, ChannelFactory>();
|
||||
|
||||
/// <summary>
|
||||
/// Returns a <see cref="IList{T}"/> of <see langword="interface"/> <see cref="Type"/>s that can be used with the service
|
||||
/// </summary>
|
||||
/// <returns>A <see cref="IList{T}"/> of <see langword="interface"/> <see cref="Type"/>s that can be used with the service</returns>
|
||||
static IList<Type> CollectComponents()
|
||||
{
|
||||
var ConnectivityComponent = typeof(ITGConnectivity);
|
||||
//find all interfaces in this assembly in this namespace that have the service contract attribute
|
||||
var query = from t in Assembly.GetExecutingAssembly().GetTypes()
|
||||
where t.IsInterface
|
||||
&& t.Namespace == ConnectivityComponent.Namespace
|
||||
&& t.GetCustomAttribute(typeof(ServiceContractAttribute)) != null
|
||||
&& (t == ConnectivityComponent || !ValidServiceInterfaces.Contains(t))
|
||||
select t;
|
||||
return query.ToList();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the function called when a remote login fails due to the server having an invalid SSL cert
|
||||
/// </summary>
|
||||
/// <param name="handler">The <see cref="Func{T, TResult}"/> to be called when a remote login is attempted while the server posesses a bad certificate. Passed a <see cref="string"/> of error information about the and should return <see langword="true"/> if it the connection should be made anyway</param>
|
||||
public static void SetBadCertificateHandler(Func<string, bool> handler)
|
||||
{
|
||||
ServicePointManager.ServerCertificateValidationCallback = (sender, cert, chain, error) =>
|
||||
{
|
||||
string ErrorMessage;
|
||||
switch (error)
|
||||
{
|
||||
case SslPolicyErrors.None:
|
||||
return true;
|
||||
case SslPolicyErrors.RemoteCertificateChainErrors:
|
||||
ErrorMessage = "There are certificate chain errors.";
|
||||
break;
|
||||
case SslPolicyErrors.RemoteCertificateNameMismatch:
|
||||
ErrorMessage = "The certificate name does not match.";
|
||||
break;
|
||||
case SslPolicyErrors.RemoteCertificateNotAvailable:
|
||||
ErrorMessage = "The certificate doesn't exist in the trust store.";
|
||||
break;
|
||||
default:
|
||||
ErrorMessage = "An unknown error occurred.";
|
||||
break;
|
||||
}
|
||||
ErrorMessage = String.Format("The server's certificate failed to verify! Error: {0} Cert: {1}", ErrorMessage, cert.ToString());
|
||||
return handler(ErrorMessage);
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Construct an <see cref="ServerInterface"/> for a local connection
|
||||
/// </summary>
|
||||
public ServerInterface() { }
|
||||
|
||||
/// <summary>
|
||||
/// Construct an <see cref="ServerInterface"/> for a remote connection
|
||||
/// </summary>
|
||||
/// <param name="address">The address of the remote server</param>
|
||||
/// <param name="port">The port the remote server runs on</param>
|
||||
/// <param name="username">Windows account username for the remote server</param>
|
||||
/// <param name="password">Windows account password for the remote server</param>
|
||||
public ServerInterface(string address, ushort port, string username, string password)
|
||||
{
|
||||
_HTTPSURL = address;
|
||||
_HTTPSPort = port;
|
||||
HTTPSUsername = username;
|
||||
HTTPSPassword = password;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Constructs an <see cref="ServerInterface"/> that connects to the same <see cref="ITGSService"/> as some <paramref name="other"/> <see cref="ITGInstance"/>
|
||||
/// </summary>
|
||||
/// <param name="other">Another <see cref="ServerInterface"/> to copy settings from</param>
|
||||
public ServerInterface(ServerInterface other) : this(other.HTTPSURL, other.HTTPSPort, other.HTTPSUsername, other.HTTPSPassword) { }
|
||||
|
||||
/// <inheritdoc />
|
||||
public ConnectivityLevel ConnectToInstance(string instanceName = null, bool skipChecks = false)
|
||||
{
|
||||
if (instanceName == null)
|
||||
instanceName = InstanceName;
|
||||
if (!skipChecks && !ConnectionStatus().HasFlag(ConnectivityLevel.Connected))
|
||||
return ConnectivityLevel.None;
|
||||
var prevInstance = InstanceName;
|
||||
if (prevInstance != instanceName)
|
||||
CloseAllChannels(false);
|
||||
InstanceName = instanceName;
|
||||
if (skipChecks)
|
||||
return ConnectivityLevel.Connected;
|
||||
try
|
||||
{
|
||||
GetComponent<ITGConnectivity>().VerifyConnection();
|
||||
}
|
||||
catch
|
||||
{
|
||||
InstanceName = prevInstance;
|
||||
return ConnectivityLevel.None;
|
||||
}
|
||||
try
|
||||
{
|
||||
GetComponent<ITGInstance>().ServerDirectory();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return ConnectivityLevel.Connected;
|
||||
}
|
||||
try
|
||||
{
|
||||
GetComponent<ITGAdministration>().GetCurrentAuthorizedGroup();
|
||||
return ConnectivityLevel.Administrator;
|
||||
}
|
||||
catch
|
||||
{
|
||||
return ConnectivityLevel.Authenticated;
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public bool IsRemoteConnection { get { return HTTPSURL != null; } }
|
||||
|
||||
/// <summary>
|
||||
/// Closes all <see cref="ChannelFactory"/>s stored in <see cref="ChannelFactoryCache"/> and clears it
|
||||
/// </summary>
|
||||
/// <param name="includingRoot">If set to <see langword="false"/>, doesn't clear the channels that are used by <see cref="ITGSService"/></param>
|
||||
void CloseAllChannels(bool includingRoot)
|
||||
{
|
||||
string[] RootThings = { typeof(ITGSService).Name, 'S' + typeof(ITGConnectivity).Name };
|
||||
lock (ChannelFactoryCache)
|
||||
{
|
||||
var toRemove = new List<string>();
|
||||
foreach (var I in ChannelFactoryCache)
|
||||
{
|
||||
if (RootThings.Contains(I.Key))
|
||||
continue;
|
||||
var cf = I.Value;
|
||||
try
|
||||
{
|
||||
cf.Closed += ChannelFactory_Closed;
|
||||
cf.Close();
|
||||
}
|
||||
catch
|
||||
{
|
||||
cf.Abort();
|
||||
}
|
||||
toRemove.Add(I.Key);
|
||||
}
|
||||
foreach (var I in toRemove)
|
||||
ChannelFactoryCache.Remove(I);
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public bool VersionMismatch(out string errorMessage)
|
||||
{
|
||||
var splits = GetServiceComponent<ITGLanding>().Version().Split(' ');
|
||||
var theirs = new Version(splits[splits.Length - 1].Substring(1));
|
||||
var ours = new Version(FileVersionInfo.GetVersionInfo(System.Reflection.Assembly.GetExecutingAssembly().Location).FileVersion);
|
||||
if(theirs.Major != ours.Major || theirs.Minor != ours.Minor || theirs.Revision != ours.Revision) //don't care about the patch level
|
||||
{
|
||||
errorMessage = String.Format("Version mismatch between interface version ({0}) and service version ({1}). Some functionality may crash this program.", ours, theirs);
|
||||
return true;
|
||||
}
|
||||
errorMessage = null;
|
||||
return false;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Disposes a closed <see cref="ChannelFactory"/>
|
||||
/// </summary>
|
||||
/// <param name="sender">The channel factory that was closed</param>
|
||||
/// <param name="e">The event arguments</param>
|
||||
static void ChannelFactory_Closed(object sender, EventArgs e)
|
||||
{
|
||||
(sender as IDisposable).Dispose();
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public T GetComponent<T>()
|
||||
{
|
||||
var ToT = typeof(T);
|
||||
if (!ValidInstanceInterfaces.Contains(ToT))
|
||||
throw new Exception("Invalid type!");
|
||||
return GetComponentImpl<T>(true);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns the requested <see cref="ServerInterface"/> component <see langword="interface"/> for the instance <see cref="InstanceName"/>. This does not guarantee a successful connection. <see cref="ChannelFactory{TChannel}"/>s created this way are recycled for minimum latency and bandwidth usage
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The component <see langword="interface"/> to retrieve</typeparam>
|
||||
/// <param name="useInstanceName">If <see cref="InstanceName"/> should be used to connect</param>
|
||||
/// <returns>The correct component <see langword="interface"/></returns>
|
||||
T GetComponentImpl<T>(bool useInstanceName)
|
||||
{
|
||||
if (useInstanceName & InstanceName == null)
|
||||
throw new Exception("Instance not selected!");
|
||||
var actualToT = typeof(T);
|
||||
var tot = actualToT.Name;
|
||||
if (actualToT == typeof(ITGConnectivity) && !useInstanceName)
|
||||
tot = 'S' + tot;
|
||||
ChannelFactory<T> cf;
|
||||
|
||||
lock (ChannelFactoryCache)
|
||||
{
|
||||
if (ChannelFactoryCache.ContainsKey(tot))
|
||||
try
|
||||
{
|
||||
cf = ((ChannelFactory<T>)ChannelFactoryCache[tot]);
|
||||
if (cf.State != CommunicationState.Opened)
|
||||
throw new Exception();
|
||||
return cf.CreateChannel();
|
||||
}
|
||||
catch
|
||||
{
|
||||
ChannelFactoryCache[tot].Abort();
|
||||
ChannelFactoryCache.Remove(tot);
|
||||
}
|
||||
cf = CreateChannel<T>(useInstanceName ? InstanceName : null);
|
||||
ChannelFactoryCache[tot] = cf;
|
||||
}
|
||||
return cf.CreateChannel();
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public T GetServiceComponent<T>()
|
||||
{
|
||||
var ToT = typeof(T);
|
||||
if (!ValidServiceInterfaces.Contains(ToT))
|
||||
throw new Exception("Invalid type!");
|
||||
return GetComponentImpl<T>(false);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Directly creates a <see cref="ChannelFactory{TChannel}"/> for <typeparamref name="T"/> without caching. This should be eventually closed by the caller
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The component <see langword="interface"/> of the channel to be created</typeparam>
|
||||
/// <returns>The correct <see cref="ChannelFactory{TChannel}"/></returns>
|
||||
/// <exception cref="Exception">Thrown if <typeparamref name="T"/> isn't a valid component <see langword="interface"/></exception>
|
||||
ChannelFactory<T> CreateChannel<T>(string instanceName)
|
||||
{
|
||||
var accessPath = instanceName == null ? MasterInterfaceName : String.Format("{0}/{1}", InstanceInterfaceName, instanceName);
|
||||
|
||||
var InterfaceName = typeof(T).Name;
|
||||
if (!IsRemoteConnection)
|
||||
{
|
||||
var res2 = new ChannelFactory<T>(
|
||||
new NetNamedPipeBinding { SendTimeout = new TimeSpan(0, 0, 30), MaxReceivedMessageSize = TransferLimitLocal }, new EndpointAddress(String.Format("net.pipe://localhost/{0}/{1}", accessPath, InterfaceName))); //10 megs
|
||||
res2.Credentials.Windows.AllowedImpersonationLevel = TokenImpersonationLevel.Impersonation;
|
||||
return res2;
|
||||
}
|
||||
|
||||
//okay we're going over
|
||||
var binding = new WSHttpBinding()
|
||||
{
|
||||
SendTimeout = new TimeSpan(0, 0, 40),
|
||||
MaxReceivedMessageSize = TransferLimitRemote
|
||||
};
|
||||
var requireAuth = InterfaceName != typeof(ITGConnectivity).Name;
|
||||
binding.Security.Transport.ClientCredentialType = HttpClientCredentialType.None;
|
||||
binding.Security.Mode = requireAuth ? SecurityMode.TransportWithMessageCredential : SecurityMode.Transport; //do not require auth for a connectivity check
|
||||
binding.Security.Message.ClientCredentialType = requireAuth ? MessageCredentialType.UserName : MessageCredentialType.None;
|
||||
var address = new EndpointAddress(String.Format("https://{0}:{1}/{2}/{3}", HTTPSURL, HTTPSPort, accessPath, InterfaceName));
|
||||
var res = new ChannelFactory<T>(binding, address);
|
||||
if (requireAuth)
|
||||
{
|
||||
res.Credentials.UserName.UserName = HTTPSUsername;
|
||||
res.Credentials.UserName.Password = HTTPSPassword;
|
||||
res.Credentials.Windows.AllowedImpersonationLevel = TokenImpersonationLevel.Impersonation;
|
||||
}
|
||||
return res;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public ConnectivityLevel ConnectionStatus()
|
||||
{
|
||||
return ConnectionStatus(out string unused);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public ConnectivityLevel ConnectionStatus(out string error)
|
||||
{
|
||||
try
|
||||
{
|
||||
GetComponentImpl<ITGConnectivity>(false).VerifyConnection();
|
||||
}
|
||||
catch (CommunicationException e)
|
||||
{
|
||||
error = e.ToString();
|
||||
return ConnectivityLevel.None;
|
||||
}
|
||||
try
|
||||
{
|
||||
GetServiceComponent<ITGLanding>().Version();
|
||||
}
|
||||
catch(Exception e)
|
||||
{
|
||||
error = e.ToString();
|
||||
return ConnectivityLevel.Connected;
|
||||
}
|
||||
try
|
||||
{
|
||||
GetServiceComponent<ITGSService>().Version();
|
||||
error = null;
|
||||
return ConnectivityLevel.Administrator;
|
||||
}
|
||||
catch(Exception e)
|
||||
{
|
||||
error = e.ToString();
|
||||
return ConnectivityLevel.Authenticated;
|
||||
}
|
||||
}
|
||||
|
||||
#region IDisposable Support
|
||||
/// <summary>
|
||||
/// To detect redundant <see cref="Dispose(bool)"/> calls
|
||||
/// </summary>
|
||||
private bool disposedValue = false;
|
||||
|
||||
/// <summary>
|
||||
/// Implements the <see cref="IDisposable"/> pattern. Calls <see cref="CloseAllChannels"/>
|
||||
/// </summary>
|
||||
/// <param name="disposing"><see langword="true"/> if <see cref="Dispose()"/> was called manually, <see langword="false"/> if it was from the finalizer</param>
|
||||
void Dispose(bool disposing)
|
||||
{
|
||||
if (!disposedValue)
|
||||
{
|
||||
if (disposing)
|
||||
{
|
||||
CloseAllChannels(true);
|
||||
}
|
||||
|
||||
// TODO: free unmanaged resources (unmanaged objects) and override a finalizer below.
|
||||
// TODO: set large fields to null.
|
||||
|
||||
disposedValue = true;
|
||||
}
|
||||
}
|
||||
|
||||
// TODO: override a finalizer only if Dispose(bool disposing) above has code to free unmanaged resources.
|
||||
// ~Interface() {
|
||||
// // Do not change this code. Put cleanup code in Dispose(bool disposing) above.
|
||||
// Dispose(false);
|
||||
// }
|
||||
|
||||
/// <summary>
|
||||
/// Implements the <see cref="IDisposable"/> pattern
|
||||
/// </summary>
|
||||
public void Dispose()
|
||||
{
|
||||
// Do not change this code. Put cleanup code in Dispose(bool disposing) above.
|
||||
Dispose(true);
|
||||
// TODO: uncomment the following line if the finalizer is overridden above.
|
||||
// GC.SuppressFinalize(this);
|
||||
}
|
||||
#endregion
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user