Added detection for new 8192 chat size limit

Author: Splamy

TS3ABotUnitTests/TextSplitterTests.cs

@@ -16,7 +16,7 @@ public void Split()
 		{
 			for (int i = 4; i < MaxSplit; i++)
 			{
-				var parts = LongTextTransform.Transform(Str1, LongTextBehaviour.SplitHard, maxMessageSize: i).ToArray();
+				var parts = LongTextTransform.Split(Str1, LongTextBehaviour.SplitHard, maxMessageSize: i).ToArray();
 				foreach (var part in parts)
 				{
 					Assert.LessOrEqual(TsString.TokenLength(part), i);

TS3AudioBot/CommandSystem/Text/LongTextTransform.cs

@@ -19,7 +19,7 @@ public static class LongTextTransform
 	{
 		private static readonly byte[] SeparatorWeight = new byte[] { (byte)'\n', (byte)',', (byte)' ' };
 
-		public static IEnumerable<string> Transform(string text, LongTextBehaviour behaviour, int limit = int.MaxValue, int maxMessageSize = TsConst.MaxSizeTextMessage)
+		public static IEnumerable<string> Split(string text, LongTextBehaviour behaviour, int maxMessageSize, int limit = int.MaxValue)
 		{
 			if (maxMessageSize < 4)
 				throw new ArgumentOutOfRangeException(nameof(maxMessageSize), "The minimum split length must be at least 4 bytes to fit all utf8 characters");

TS3AudioBot/History/SmartHistoryFormatter.cs

@@ -27,7 +27,7 @@ public class SmartHistoryFormatter : IHistoryFormatter
 
 		public string ProcessQuery(AudioLogEntry entry, Func<AudioLogEntry, string> format)
 		{
-			return SubstringToken(format(entry), TsConst.MaxSizeTextMessage);
+			return SubstringToken(format(entry), TsConst.Default.MaxSizeTextMessage);
 		}
 
 		public string ProcessQuery(IEnumerable<AudioLogEntry> entries, Func<AudioLogEntry, string> format)
@@ -46,7 +46,7 @@ public string ProcessQuery(IEnumerable<AudioLogEntry> entries, Func<AudioLogEntr
 			StringBuilder strb;
 
 			// If the entire content fits within the ts3 limitation, we can concat and return it.
-			if (queryTokenLen <= TsConst.MaxSizeTextMessage)
+			if (queryTokenLen <= TsConst.Default.MaxSizeTextMessage)
 			{
 				if (queryTokenLen == 0) return "Nothing found!";
 				strb = new StringBuilder(queryTokenLen, queryTokenLen);
@@ -56,7 +56,7 @@ public string ProcessQuery(IEnumerable<AudioLogEntry> entries, Func<AudioLogEntr
 				return strb.ToString();
 			}
 
-			int spareToken = TsConst.MaxSizeTextMessage;
+			int spareToken = TsConst.Default.MaxSizeTextMessage;
 			int listStart = 0;
 
 			// Otherwise we go iteratively through the list to test how many entries we can add with our token
@@ -115,7 +115,7 @@ public string ProcessQuery(IEnumerable<AudioLogEntry> entries, Func<AudioLogEntr
 			}
 
 			// now we can just build our result and return
-			strb = new StringBuilder(TsConst.MaxSizeTextMessage - spareToken, TsConst.MaxSizeTextMessage);
+			strb = new StringBuilder(TsConst.Default.MaxSizeTextMessage - spareToken, TsConst.Default.MaxSizeTextMessage);
 			for (int i = useList.Count - 1; i >= 0; i--)
 			{
 				var eL = useList[i];

TS3AudioBot/MainCommands.cs

@@ -1794,7 +1794,7 @@ public static async Task Write(this ExecutionInformation info, string message)
 				limit = config.Commands.LongMessageSplitLimit;
 			}
 
-			foreach (var msgPart in LongTextTransform.Transform(message, behaviour, limit))
+			foreach (var msgPart in LongTextTransform.Split(message, behaviour, ts3Client.ServerConstants.MaxSizeTextMessage, limit))
 			{
 				switch (invoker.Visibiliy.Value)
 				{

TS3AudioBot/Ts3Client.cs

@@ -65,6 +65,7 @@ public sealed class Ts3Client
 		private ClientId[] ownChannelClients = Array.Empty<ClientId>();
 
 		public bool Connected => ts3FullClient.Connected;
+		public TsConst ServerConstants => ts3FullClient.ServerConstants;
 
 		public Ts3Client(ConfBot config, TsFullClient ts3FullClient, Id id)
 		{
@@ -142,25 +143,25 @@ private async Task<E<string>> ConnectClient()
 			if (closed)
 				return "Bot disposed";
 
-			VersionSign versionSign;
+			TsVersionSigned? versionSign;
 			if (!string.IsNullOrEmpty(config.Connect.ClientVersion.Build.Value))
 			{
 				var versionConf = config.Connect.ClientVersion;
-				versionSign = new VersionSign(versionConf.Build, versionConf.Platform.Value, versionConf.Sign);
+				versionSign = TsVersionSigned.TryParse(versionConf.Build, versionConf.Platform.Value, versionConf.Sign);
 
-				if (!versionSign.CheckValid())
+				if (versionSign is null)
 				{
 					Log.Warn("Invalid version sign, falling back to unknown :P");
-					versionSign = VersionSign.VER_WIN_3_X_X;
+					versionSign = TsVersionSigned.VER_WIN_3_X_X;
 				}
 			}
 			else if (Tools.IsLinux)
 			{
-				versionSign = VersionSign.VER_LIN_3_X_X;
+				versionSign = TsVersionSigned.VER_LIN_3_X_X;
 			}
 			else
 			{
-				versionSign = VersionSign.VER_WIN_3_X_X;
+				versionSign = TsVersionSigned.VER_WIN_3_X_X;
 			}
 
 			try

TSLib/Commands/TsConst.cs

@@ -9,41 +9,58 @@
 
 namespace TSLib.Commands
 {
-	public static class TsConst
+	public class TsConst
 	{
+		public static TsConst Default { get; } = new TsConst();
+
+		public static TsConst Server_3_8_0 { get; } = new TsConst()
+		{
+			MaxSizeTextMessage = 8192
+		};
+
+		public static TsConst GetByServerBuildNum(ulong buildNum)
+		{
+			if (buildNum >= 1558938729UL) // 3.8.0 [Build: 1558938729]
+				return Server_3_8_0;
+
+			return Default;
+		}
+
 		// Common Definitions
 
 		//limited length, measured in characters
-		public const int MaxSizeChannelName = 40;
-		public const int MaxSizeVirtualserverName = 64;
-		public const int MaxSizeClientNicknameSdk = 64;
-		public const int MinSizeClientNicknameSdk = 3;
-		public const int MaxSizeReasonMessage = 80;
+		public int MaxSizeChannelName { get; private set; } = 40;
+		public int MaxSizeVirtualserverName { get; private set; } = 64;
+		public int MaxSizeClientNicknameSdk { get; private set; } = 64;
+		public int MinSizeClientNicknameSdk { get; private set; } = 3;
+		public int MaxSizeReasonMessage { get; private set; } = 80;
 
 		//limited length, measured in bytes (utf8 encoded)
-		public const int MaxSizeTextMessage = 1024;
-		public const int MaxSizeChannelTopic = 255;
-		public const int MaxSizeChannelDescription = 8192;
-		public const int MaxSizeVirtualserverWelcomeMessage = 1024;
+		public int MaxSizeTextMessage { get; private set; } = 1024;
+		public int MaxSizeChannelTopic { get; private set; } = 255;
+		public int MaxSizeChannelDescription { get; private set; } = 8192;
+		public int MaxSizeVirtualserverWelcomeMessage { get; private set; } = 1024;
 
 		// Rare Definitions
 
 		//limited length, measured in characters
-		public const int MaxSizeClientNickname = 30;
-		public const int MinSizeClientNickname = 3;
-		public const int MaxSizeAwayMessage = 80;
-		public const int MaxSizeGroupName = 30;
-		public const int MaxSizeTalkRequestMessage = 50;
-		public const int MaxSizeComplainMessage = 200;
-		public const int MaxSizeClientDescription = 200;
-		public const int MaxSizeHostMessage = 200;
-		public const int MaxSizeHostbuttonTooltip = 50;
-		public const int MaxSizepokeMessage = 100;
-		public const int MaxSizeOfflineMessage = 4096;
-		public const int MaxSizeOfflineMessageSubject = 200;
+		public int MaxSizeClientNickname { get; private set; } = 30;
+		public int MinSizeClientNickname { get; private set; } = 3;
+		public int MaxSizeAwayMessage { get; private set; } = 80;
+		public int MaxSizeGroupName { get; private set; } = 30;
+		public int MaxSizeTalkRequestMessage { get; private set; } = 50;
+		public int MaxSizeComplainMessage { get; private set; } = 200;
+		public int MaxSizeClientDescription { get; private set; } = 200;
+		public int MaxSizeHostMessage { get; private set; } = 200;
+		public int MaxSizeHostbuttonTooltip { get; private set; } = 50;
+		public int MaxSizepokeMessage { get; private set; } = 100;
+		public int MaxSizeOfflineMessage { get; private set; } = 4096;
+		public int MaxSizeOfflineMessageSubject { get; private set; } = 200;
 
 		//limited length, measured in bytes (utf8 encoded)
-		public const int MaxSizePluginCommand = 1024 * 8;
-		public const int MaxSizeVirtualserverHostbannerGfxUrl = 2000;
+		public int MaxSizePluginCommand { get; private set; } = 1024 * 8;
+		public int MaxSizeVirtualserverHostbannerGfxUrl { get; private set; } = 2000;
+
+		public TsConst() { }
 	}
 }

TSLib/ConnectionData.cs

@@ -37,11 +37,11 @@ public class ConnectionDataFull : ConnectionData
 		public IdentityData Identity { get; }
 		/// <summary>
 		/// Set this to the TeamSpeak 3 Version this client should appear as.
-		/// You can find predefined version data in the <see cref="Full.VersionSign"/>
+		/// You can find predefined version data in the <see cref="TsVersionSigned"/>
 		/// class. Please keep in mind that the version data has to have valid sign
 		/// to be accepted by an official TeamSpeak 3 Server.
 		/// </summary>
-		public VersionSign VersionSign { get; }
+		public TsVersionSigned VersionSign { get; }
 		/// <summary>The display username.</summary>
 		public string Username { get; }
 		/// <summary>The server password. Leave null if none.</summary>
@@ -58,7 +58,7 @@ public class ConnectionDataFull : ConnectionData
 		public ConnectionDataFull(
 			string address,
 			IdentityData identity,
-			VersionSign? versionSign = null,
+			TsVersionSigned? versionSign = null,
 			string? username = null,
 			Password? serverPassword = null,
 			string? defaultChannel = null,
@@ -67,7 +67,7 @@ public ConnectionDataFull(
 				: base(address, logId)
 		{
 			Identity = identity;
-			VersionSign = versionSign ?? (Tools.IsLinux ? VersionSign.VER_LIN_3_X_X : VersionSign.VER_WIN_3_X_X);
+			VersionSign = versionSign ?? (Tools.IsLinux ? TsVersionSigned.VER_LIN_3_X_X : TsVersionSigned.VER_WIN_3_X_X);
 			Username = username ?? "TSLibUser";
 			ServerPassword = serverPassword ?? Password.Empty;
 			DefaultChannel = defaultChannel ?? string.Empty;

TSLib/DedicatedTaskScheduler.cs

@@ -1,3 +1,12 @@
+// TSLib - A free TeamSpeak 3 and 5 client library
+// Copyright (C) 2017  TSLib contributors
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the Open Software License v. 3.0
+//
+// You should have received a copy of the Open Software License along with this
+// program. If not, see <https://opensource.org/licenses/OSL-3.0>.
+
 using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
@@ -40,14 +49,14 @@ private void DoWork()
 			{
 #if DEBUG
 				var sw = new System.Diagnostics.Stopwatch();
-				Log.Debug("Processing Task {0}", task.Id);
+				Log.Trace("Processing Task {0}", task.Id);
 #endif
 				TryExecuteTask(task);
 #if DEBUG
 				var time = sw.Elapsed;
-				Log.Debug("Task {0} took {1}. Resulted {2}", task.Id, time, task.Status);
+				Log.Trace("Task {0} took {1}. Resulted {2}", task.Id, time, task.Status);
 				if (queue.Count == 0)
-					Log.Debug("Eoq");
+					Log.Trace("Eoq");
 #endif
 			}
 			Log.Debug("Finalizing TaskScheduler");

TSLib/Full/Book/Book.cs

@@ -88,6 +88,15 @@ private Server GetServer()
 			return Server;
 		}
 
+		public void Reset()
+		{
+			Channels.Clear();
+			Clients.Clear();
+			Groups.Clear();
+			OwnClient = ClientId.Null;
+			Server = new Server();
+		}
+
 		// Manual post event functions
 
 		partial void PostClientEnterView(ClientEnterView msg) => SetOwnChannelSubscribed(msg.ClientId);

TSLib/Full/TsCrypt.cs

@@ -766,9 +766,9 @@ public static bool VerifySign(ECPoint publicKey, byte[] data, byte[] proof)
 
 		private static readonly byte[] TsVersionSignPublicKey = Convert.FromBase64String("UrN1jX0dBE1vulTNLCoYwrVpfITyo+NBuq/twbf9hLw=");
 
-		public static bool EdCheck(VersionSign sign)
+		public static bool EdCheck(TsVersionSigned sign)
 		{
-			var ver = Encoding.ASCII.GetBytes(sign.PlatformName + sign.Name);
+			var ver = Encoding.ASCII.GetBytes(sign.Platform + sign.Version);
 			var signArr = Base64Decode(sign.Sign);
 			if (signArr is null)
 				return false;
@@ -777,10 +777,10 @@ public static bool EdCheck(VersionSign sign)
 
 		public static void VersionSelfCheck()
 		{
-			var versions = typeof(VersionSign).GetProperties().Where(prop => prop.PropertyType == typeof(VersionSign));
+			var versions = typeof(TsVersionSigned).GetProperties().Where(prop => prop.PropertyType == typeof(TsVersionSigned));
 			foreach (var ver in versions)
 			{
-				var verObj = (VersionSign)ver.GetValue(null)!;
+				var verObj = (TsVersionSigned)ver.GetValue(null)!;
 				if (!EdCheck(verObj))
 					throw new Exception($"Version is invalid: {verObj}");
 			}

TSLib/Full/TsFullClient.cs

@@ -11,7 +11,6 @@
 using System.Buffers.Binary;
 using System.Collections.Generic;
 using System.Linq;
-using System.Threading;
 using System.Threading.Tasks;
 using TSLib.Audio;
 using TSLib.Commands;
@@ -41,16 +40,16 @@ public sealed partial class TsFullClient : TsBaseFunctions, IAudioActiveProducer
 		public ClientId ClientId => packetHandler.ClientId;
 		/// <summary>The disonnect message when leaving.</summary>
 		public string QuitMessage { get; set; } = "Disconnected";
-		/// <summary>The <see cref="Full.VersionSign"/> used to connect.</summary>
-		public VersionSign VersionSign => connectionDataFull.VersionSign;
-		/// <summary>The <see cref="Full.IdentityData"/> used to connect.</summary>
+		/// <summary>The <see cref="TsVersionSigned"/> used to connect.</summary>
+		public TsVersionSigned VersionSign => connectionDataFull.VersionSign;
+		/// <summary>The <see cref="IdentityData"/> used to connect.</summary>
 		public IdentityData Identity => connectionDataFull.Identity;
 		private TsClientStatus status;
 		public override bool Connected { get { lock (statusLock) return status == TsClientStatus.Connected; } }
 		public override bool Connecting { get { lock (statusLock) return status == TsClientStatus.Connecting; } }
 		protected override Deserializer Deserializer => msgProc.Deserializer;
 		private ConnectionDataFull connectionDataFull;
-		public Connection Book { get; set; } = new Connection();
+		public Connection Book { get; } = new Connection();
 
 		public override event EventHandler<DisconnectEventArgs>? OnDisconnected;
 		public event EventHandler<CommandError>? OnErrorEvent;
@@ -80,15 +79,18 @@ public override async Task Connect(ConnectionData conData)
 			if (!(conData is ConnectionDataFull conDataFull)) throw new ArgumentException($"Use the {nameof(ConnectionDataFull)} derivative to connect with the full client.", nameof(conData));
 			if (conDataFull.Identity is null) throw new ArgumentNullException(nameof(conDataFull.Identity));
 			if (conDataFull.VersionSign is null) throw new ArgumentNullException(nameof(conDataFull.VersionSign));
-			connectionDataFull = conDataFull;
-			ConnectionData = conData;
 
 			await Disconnect();
 
 			remoteAddress = await TsDnsResolver.TryResolve(conData.Address);
 			if (remoteAddress is null)
 				throw new TsException("Could not read or resolve address.");
 
+			connectionDataFull = conDataFull;
+			ConnectionData = conData;
+			ServerConstants = TsConst.Default;
+			Book.Reset();
+
 			var ctx = new ConnectionContext { WasExit = false };
 			lock (statusLock)
 			{
@@ -249,6 +251,9 @@ async partial void ProcessEachInitIvExpand2(InitIvExpand2 initIvExpand2)
 		partial void ProcessEachInitServer(InitServer initServer)
 		{
 			packetHandler.ClientId = initServer.ClientId;
+			var serverVersion = TsVersion.TryParse(initServer.ServerVersion, initServer.ServerPlatform);
+			if (serverVersion != null)
+				ServerConstants = TsConst.GetByServerBuildNum(serverVersion.Build);
 
 			lock (statusLock)
 				status = TsClientStatus.Connected;
@@ -474,11 +479,11 @@ public Task ClientEk(string ek, string proof)
 
 		public Task ClientInit(string nickname, bool inputHardware, bool outputHardware,
 				string defaultChannel, string defaultChannelPassword, string serverPassword, string metaData,
-				string nicknamePhonetic, string defaultToken, string hwid, VersionSign versionSign)
+				string nicknamePhonetic, string defaultToken, string hwid, TsVersionSigned versionSign)
 			=> SendNoResponsed(new TsCommand("clientinit") {
 				{ "client_nickname", nickname },
-				{ "client_version", versionSign.Name },
-				{ "client_platform", versionSign.PlatformName },
+				{ "client_version", versionSign.Version },
+				{ "client_platform", versionSign.Platform },
 				{ "client_input_hardware", inputHardware },
 				{ "client_output_hardware", outputHardware },
 				{ "client_default_channel", defaultChannel },