cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-24 13:36:50 +01:00
Code Issues Packages Projects Releases Wiki Activity

Refactor IrcProvider just a little

Browse Source
This commit is contained in:
craftxbox
2024-10-03 21:38:24 -02:30
parent 726de9891e
commit 5c4f55850c
4 changed files with 135 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Tgstation.Server.Api/Models/IrcConnectionStringBuilder.cs
+1
View File
@@ -88,6 +88,7 @@ namespace Tgstation.Server.Api.Models
case IrcPasswordType.NickServ:
case IrcPasswordType.Sasl:
case IrcPasswordType.Server:
case IrcPasswordType.Oper:
PasswordType = passwordType;
break;
default:
src/Tgstation.Server.Api/Models/IrcPasswordType.cs
+5
View File
@@ -19,5 +19,10 @@
/// Use NickServ authentication.
/// </summary>
NickServ,
/// <summary>
/// Use OPER authentication.
/// </summary>
Oper,
}
}
src/Tgstation.Server.Host/Components/Chat/Providers/IrcProvider.cs
+118 -80
View File
@@ -42,11 +42,6 @@ namespace Tgstation.Server.Host.Components.Chat.Providers
/// <inheritdoc />
public override string BotMention => client.Nickname;
/// <summary>
/// The <see cref="IrcFeatures"/> client.
/// </summary>
readonly IrcFeatures client;
/// <summary>
/// Address of the server to connect to.
/// </summary>
@@ -57,6 +52,11 @@ namespace Tgstation.Server.Host.Components.Chat.Providers
/// </summary>
readonly ushort port;
/// <summary>
/// Wether or not this IRC client is to use ssl.
/// </summary>
readonly bool ssl;
/// <summary>
/// IRC nickname.
/// </summary>
@@ -82,6 +82,16 @@ namespace Tgstation.Server.Host.Components.Chat.Providers
/// </summary>
readonly Dictionary<ulong, string> queryChannelIdMap;
/// <summary>
/// The version string obtained from <see cref="IAssemblyInformationProvider.VersionString"/>.
/// </summary>
readonly string versionString;
/// <summary>
/// The <see cref="IrcFeatures"/> client.
/// </summary>
IrcFeatures client;
/// <summary>
/// The <see cref="ValueTask"/> used for <see cref="IrcConnection.Listen(bool)"/>.
/// </summary>
@@ -92,11 +102,6 @@ namespace Tgstation.Server.Host.Components.Chat.Providers
/// </summary>
ulong channelIdCounter;
/// <summary>
/// If we are disconnecting.
/// </summary>
bool disconnecting;
/// <summary>
/// Initializes a new instance of the <see cref="IrcProvider"/> class.
/// </summary>
@@ -121,33 +126,15 @@ namespace Tgstation.Server.Host.Components.Chat.Providers
address = ircBuilder.Address!;
port = ircBuilder.Port!.Value;
ssl = ircBuilder.UseSsl!.Value;
nickname = ircBuilder.Nickname!;
password = ircBuilder.Password!;
passwordType = ircBuilder.PasswordType;
client = new IrcFeatures
{
SupportNonRfc = true,
CtcpUserInfo = "You are going to play. And I am going to watch. And everything will be just fine...",
AutoRejoin = true,
AutoRejoinOnKick = true,
AutoRelogin = true,
AutoRetry = false,
AutoReconnect = false,
ActiveChannelSyncing = true,
AutoNickHandling = true,
CtcpVersion = assemblyInformationProvider.VersionString,
UseSsl = ircBuilder.UseSsl!.Value,
};
if (ircBuilder.UseSsl.Value)
client.ValidateServerCertificate = true; // dunno if it defaults to that or what
versionString = assemblyInformationProvider.VersionString;
client.OnChannelMessage += Client_OnChannelMessage;
client.OnQueryMessage += Client_OnQueryMessage;
/*client.OnReadLine += (sender, e) => Logger.LogTrace("READ: {line}", e.Line);
client.OnWriteLine += (sender, e) => Logger.LogTrace("WRITE: {line}", e.Line);*/
client = InstantiateClient();
channelIdMap = new Dictionary<ulong, string?>();
queryChannelIdMap = new Dictionary<ulong, string>();
@@ -369,12 +356,15 @@ namespace Tgstation.Server.Host.Components.Chat.Providers
/// <inheritdoc />
protected override async ValueTask Connect(CancellationToken cancellationToken)
{
disconnecting = false;
cancellationToken.ThrowIfCancellationRequested();
try
{
await Task.Factory.StartNew(
() => client.Connect(address, port),
() =>
{
client = InstantiateClient();
client.Connect(address, port);
},
cancellationToken,
DefaultIOManager.BlockingTaskCreationOptions,
TaskScheduler.Current)
@@ -382,70 +372,50 @@ namespace Tgstation.Server.Host.Components.Chat.Providers
cancellationToken.ThrowIfCancellationRequested();
listenTask = Task.Factory.StartNew(
() =>
{
Logger.LogTrace("Starting blocking listen...");
try
{
client.Listen();
}
catch (Exception ex)
{
Logger.LogWarning(ex, "IRC Main Listen Exception!");
}
Logger.LogTrace("Exiting listening task...");
}, cancellationToken, DefaultIOManager.BlockingTaskCreationOptions, TaskScheduler.Current);
Logger.LogTrace("Authenticating ({passwordType})...", passwordType);
switch (passwordType)
{
case IrcPasswordType.Server:
client.Login(nickname, nickname, 0, nickname, password);
client.RfcPass(password);
await Login(client, nickname);
break;
case IrcPasswordType.NickServ:
client.Login(nickname, nickname, 0, nickname);
await Login(client, nickname);
cancellationToken.ThrowIfCancellationRequested();
client.SendMessage(SendType.Message, "NickServ", String.Format(CultureInfo.InvariantCulture, "IDENTIFY {0}", password));
break;
case IrcPasswordType.Sasl:
await SaslAuthenticate(cancellationToken);
break;
case IrcPasswordType.Oper:
await Login(client, nickname);
cancellationToken.ThrowIfCancellationRequested();
client.RfcOper(nickname, password, Priority.Critical);
break;
case null:
client.Login(nickname, nickname, 0, nickname);
await Login(client, nickname);
break;
default:
throw new InvalidOperationException($"Invalid IrcPasswordType: {passwordType.Value}");
}
cancellationToken.ThrowIfCancellationRequested();
Logger.LogTrace("Processing initial messages...");
await NonBlockingListen(cancellationToken);
var nickCheckCompleteTcs = new TaskCompletionSource();
using (cancellationToken.Register(() => nickCheckCompleteTcs.TrySetCanceled(cancellationToken)))
{
listenTask = Task.Factory.StartNew(
async () =>
{
Logger.LogTrace("Entering nick check loop");
while (!disconnecting && client.IsConnected && client.Nickname != nickname)
{
client.ListenOnce(true);
if (disconnecting || !client.IsConnected)
break;
await NonBlockingListen(cancellationToken);
// ensure we have the correct nick
if (client.GetIrcUser(nickname) == null)
client.RfcNick(nickname);
}
nickCheckCompleteTcs.TrySetResult();
Logger.LogTrace("Starting blocking listen...");
try
{
client.Listen();
}
catch (Exception ex)
{
Logger.LogWarning(ex, "IRC Main Listen Exception!");
}
Logger.LogTrace("Exiting listening task...");
},
cancellationToken,
DefaultIOManager.BlockingTaskCreationOptions,
TaskScheduler.Current);
await nickCheckCompleteTcs.Task;
}
Logger.LogTrace("Connection established!");
}
@@ -487,6 +457,37 @@ namespace Tgstation.Server.Host.Components.Chat.Providers
}
}
/// <summary>
/// Register the client on the network.
/// </summary>
/// <param name="client">IRC client.</param>
/// <param name="nickname">Nickname.</param>
/// <returns><see cref="Task"/> that resolves when registration has been completed. </returns>
/// <exception cref="TimeoutException">If the IRC server fails to respond.</exception>
private async Task Login(IrcFeatures client, string nickname)
{
var promise = new TaskCompletionSource<object>();
void Callback(object? sender, EventArgs e)
{
Logger.LogTrace("IRC Registered.");
promise.TrySetResult(e);
}
client.OnRegistered += Callback;
client.Login(nickname, nickname, 0, nickname);
var completed = await Task.WhenAny(promise.Task, Task.Delay(30 * 1000));
if (completed == promise.Task)
{
client.OnRegistered -= Callback;
return;
}
throw new TimeoutException("Timed out waiting for IRC registration.");
}
/// <summary>
/// Handle an IRC message.
/// </summary>
@@ -667,8 +668,6 @@ namespace Tgstation.Server.Host.Components.Chat.Providers
Logger.LogTrace("Hard disconnect");
disconnecting = true;
// This call blocks permanently randomly sometimes
// Frankly I don't give a shit
var disconnectTask = Task.Factory.StartNew(
@@ -693,5 +692,44 @@ namespace Tgstation.Server.Host.Components.Chat.Providers
listenTask ?? Task.CompletedTask),
AsyncDelayer.Delay(TimeSpan.FromSeconds(5), cancellationToken));
}
/// <summary>
/// Creates a new instance of the IRC client.
/// Reusing the same client after a disconnection seems to cause issues.
/// </summary>
/// <returns>The <see cref="IrcFeatures"/> client to use.</returns>
private IrcFeatures InstantiateClient()
{
IrcFeatures newClient = new IrcFeatures
{
SupportNonRfc = true,
CtcpUserInfo = "You are going to play. And I am going to watch. And everything will be just fine...",
AutoRejoin = true,
AutoRejoinOnKick = true,
AutoRelogin = false,
AutoRetry = false,
AutoReconnect = false,
ActiveChannelSyncing = true,
AutoNickHandling = true,
CtcpVersion = versionString,
UseSsl = ssl,
EnableUTF8Recode = true,
};
if (ssl)
newClient.ValidateServerCertificate = true; // dunno if it defaults to that or what
newClient.OnChannelMessage += Client_OnChannelMessage;
newClient.OnQueryMessage += Client_OnQueryMessage;
newClient.OnReadLine += (sender, e) => Logger.LogTrace("READ: {line}", e.Line);
newClient.OnWriteLine += (sender, e) => Logger.LogTrace("WRITE: {line}", e.Line);
newClient.OnError += (sender, e) =>
{
Logger.LogError("IRC ERROR: {error}", e.ErrorMessage);
newClient.Disconnect();
};
return newClient;
}
}
}
tests/Tgstation.Server.Host.Tests/Components/Chat/Providers/TestIrcProvider.cs
+11
View File
@@ -88,6 +88,17 @@ namespace Tgstation.Server.Host.Components.Chat.Providers.Tests
await InvokeConnect(provider);
Assert.IsTrue(provider.Connected);
await Task.Delay(2000); // IRC servers do not like it when you connect and disconnect in rapid succession
await provider.Disconnect(default);
Assert.IsFalse(provider.Connected);
await Task.Delay(2000); // same as above
await InvokeConnect(provider);
await Task.Delay(2000); // make sure it stays connected after a reconnect attempt
Assert.IsTrue(provider.Connected);
await provider.Disconnect(default);
Assert.IsFalse(provider.Connected);
}