tom/hermes-client
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Generalized the ChatMessageReader to make it work with ChannelResubscrition. Added connections refresh command.

Browse Source
This commit is contained in:
Tom
2024-08-12 19:45:17 +00:00
parent f503f7c6f4
commit 1d43515fb9
18 changed files with 182 additions and 135 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
Chat/Commands/CommandBuilder.cs
View File

@ -37,7 +37,8 @@ namespace TwitchChatTTS.Chat.Commands
_logger = logger;
_stack = new Stack<CommandNode>();
Clear();
_root = new CommandNode(new StaticParameter("root", "root"));
_current = _root;
}
@ -201,7 +202,7 @@ namespace TwitchChatTTS.Chat.Commands
public interface ICommandSelector
{
CommandSelectorResult GetBestMatch(string[] args, ChannelChatMessage message);
CommandSelectorResult GetBestMatch(string[] args, TwitchChatFragment[] fragments);
IDictionary<string, CommandParameter> GetNonStaticArguments(string[] args, string path);
}
@ -214,12 +215,12 @@ namespace TwitchChatTTS.Chat.Commands
_root = root;
}
public CommandSelectorResult GetBestMatch(string[] args, ChannelChatMessage message)
public CommandSelectorResult GetBestMatch(string[] args, TwitchChatFragment[] fragments)
{
return GetBestMatch(_root, message, args, null, string.Empty, null);
return GetBestMatch(_root, fragments, args, null, string.Empty, null);
}
private CommandSelectorResult GetBestMatch(CommandNode node, ChannelChatMessage message, IEnumerable<string> args, IChatPartialCommand? match, string path, string[]? permissions)
private CommandSelectorResult GetBestMatch(CommandNode node, TwitchChatFragment[] fragments, IEnumerable<string> args, IChatPartialCommand? match, string path, string[]? permissions)
{
if (node == null || !args.Any())
return new CommandSelectorResult(match, path, permissions);
@ -234,13 +235,13 @@ namespace TwitchChatTTS.Chat.Commands
if (child.Parameter.GetType() == typeof(StaticParameter))
{
if (child.Parameter.Name.ToLower() == argumentLower)
return GetBestMatch(child, message, args.Skip(1), child.Command ?? match, (path.Length == 0 ? string.Empty : path + ".") + child.Parameter.Name.ToLower(), perms);
return GetBestMatch(child, fragments, args.Skip(1), child.Command ?? match, (path.Length == 0 ? string.Empty : path + ".") + child.Parameter.Name.ToLower(), perms);
continue;
}
if ((!child.Parameter.Optional || child.Parameter.Validate(argument, message)) && child.Command != null)
return GetBestMatch(child, message, args.Skip(1), child.Command, (path.Length == 0 ? string.Empty : path + ".") + "*", perms);
if ((!child.Parameter.Optional || child.Parameter.Validate(argument, fragments)) && child.Command != null)
return GetBestMatch(child, fragments, args.Skip(1), child.Command, (path.Length == 0 ? string.Empty : path + ".") + "*", perms);
if (!child.Parameter.Optional)
return GetBestMatch(child, message, args.Skip(1), match, (path.Length == 0 ? string.Empty : path + ".") + "*", permissions);
return GetBestMatch(child, fragments, args.Skip(1), match, (path.Length == 0 ? string.Empty : path + ".") + "*", permissions);
}
return new CommandSelectorResult(match, path, permissions);

4
Chat/Commands/CommandManager.cs
View File

@ -59,7 +59,7 @@ namespace TwitchChatTTS.Chat.Commands
string[] args = parts.ToArray();
string com = args.First().ToLower();
CommandSelectorResult selectorResult = _commandSelector.GetBestMatch(args, message);
CommandSelectorResult selectorResult = _commandSelector.GetBestMatch(args, message.Message.Fragments);
if (selectorResult.Command == null)
{
_logger.Warning($"Could not match '{arg}' to any command [chatter: {message.ChatterUserLogin}][chatter id: {message.ChatterUserId}]");
@ -86,7 +86,7 @@ namespace TwitchChatTTS.Chat.Commands
var parameter = entry.Value;
var argument = entry.Key;
// Optional parameters were validated while fetching this command.
if (!parameter.Optional && !parameter.Validate(argument, message))
if (!parameter.Optional && !parameter.Validate(argument, message.Message.Fragments))
{
_logger.Warning($"Command failed due to an argument being invalid [argument name: {parameter.Name}][argument value: {argument}][arguments: {arg}][command type: {command.GetType().Name}][chatter: {message.ChatterUserLogin}][chatter id: {message.ChatterUserId}]");
return ChatCommandResult.Syntax;

2
Chat/Commands/Parameters/CommandParameter.cs
View File

@ -13,6 +13,6 @@ namespace TwitchChatTTS.Chat.Commands.Parameters
Optional = optional;
}
public abstract bool Validate(string value, ChannelChatMessage message);
public abstract bool Validate(string value, TwitchChatFragment[] fragments);
}
}

4
Chat/Commands/Parameters/MentionParameter.cs
View File

@ -8,9 +8,9 @@ namespace TwitchChatTTS.Chat.Commands.Parameters
{
}
public override bool Validate(string value, ChannelChatMessage message)
public override bool Validate(string value, TwitchChatFragment[] fragments)
{
return value.StartsWith('@') && message.Message.Fragments.Any(f => f.Text == value && f.Mention != null);
return value.StartsWith('@') && fragments.Any(f => f.Text == value && f.Mention != null);
}
}
}

2
Chat/Commands/Parameters/OBSTransformationParameter.cs
View File

@ -10,7 +10,7 @@ namespace TwitchChatTTS.Chat.Commands.Parameters
{
}
public override bool Validate(string value, ChannelChatMessage message)
public override bool Validate(string value, TwitchChatFragment[] fragments)
{
return _values.Contains(value.ToLower());
}

2
Chat/Commands/Parameters/StateParameter.cs
View File

@ -10,7 +10,7 @@ namespace TwitchChatTTS.Chat.Commands.Parameters
{
}
public override bool Validate(string value, ChannelChatMessage message)
public override bool Validate(string value, TwitchChatFragment[] fragments)
{
return _values.Contains(value.ToLower());
}

2
Chat/Commands/Parameters/StaticParameter.cs
View File

@ -13,7 +13,7 @@ namespace TwitchChatTTS.Chat.Commands.Parameters
_value = value.ToLower();
}
public override bool Validate(string value, ChannelChatMessage message)
public override bool Validate(string value, TwitchChatFragment[] fragments)
{
return _value == value.ToLower();
}

2
Chat/Commands/Parameters/TTSVoiceNameParameter.cs
View File

@ -13,7 +13,7 @@ namespace TwitchChatTTS.Chat.Commands.Parameters
_user = user;
}
public override bool Validate(string value, ChannelChatMessage message)
public override bool Validate(string value, TwitchChatFragment[] fragments)
{
if (_user.VoicesAvailable == null)
return false;

2
Chat/Commands/Parameters/UnvalidatedParameter.cs
View File

@ -8,7 +8,7 @@ namespace TwitchChatTTS.Chat.Commands.Parameters
{
}
public override bool Validate(string value, ChannelChatMessage message)
public override bool Validate(string value, TwitchChatFragment[] fragments)
{
return true;
}

15
Chat/Commands/RefreshCommand.cs
View File

@ -4,7 +4,6 @@ using Microsoft.Extensions.DependencyInjection;
using Serilog;
using TwitchChatTTS.Hermes.Socket;
using TwitchChatTTS.OBS.Socket;
using TwitchChatTTS.Twitch.Socket;
using TwitchChatTTS.Twitch.Socket.Messages;
using static TwitchChatTTS.Chat.Commands.TTSCommands;
@ -37,7 +36,8 @@ namespace TwitchChatTTS.Chat.Commands
.CreateStaticInputParameter("default_voice", b => b.CreateCommand(new RefreshTTSDefaultVoice()))
.CreateStaticInputParameter("redemptions", b => b.CreateCommand(new RefreshRedemptions()))
.CreateStaticInputParameter("obs_cache", b => b.CreateCommand(new RefreshObs(_obs, _logger)))
.CreateStaticInputParameter("permissions", b => b.CreateCommand(new RefreshPermissions()));
.CreateStaticInputParameter("permissions", b => b.CreateCommand(new RefreshPermissions()))
.CreateStaticInputParameter("connections", b => b.CreateCommand(new RefreshConnections()));
});
}
@ -113,7 +113,6 @@ namespace TwitchChatTTS.Chat.Commands
private sealed class RefreshPermissions : IChatPartialCommand
{
public bool AcceptCustomPermission { get => true; }
public async Task Execute(IDictionary<string, string> values, ChannelChatMessage message, HermesSocketClient hermes)
@ -121,5 +120,15 @@ namespace TwitchChatTTS.Chat.Commands
await hermes.FetchPermissions();
}
}
private sealed class RefreshConnections : IChatPartialCommand
{
public bool AcceptCustomPermission { get => true; }
public async Task Execute(IDictionary<string, string> values, ChannelChatMessage message, HermesSocketClient hermes)
{
await hermes.FetchConnections();
}
}
}
}

121
Chat/Messaging/ChatMessageReader.cs
View File

@ -3,10 +3,7 @@ using CommonSocketLibrary.Abstract;
using CommonSocketLibrary.Common;
using Microsoft.Extensions.DependencyInjection;
using Serilog;
using TwitchChatTTS.Chat.Commands;
using TwitchChatTTS.Chat.Emotes;
using TwitchChatTTS.Chat.Groups;
using TwitchChatTTS.Chat.Groups.Permissions;
using TwitchChatTTS.Chat.Speech;
using TwitchChatTTS.Hermes.Socket;
using TwitchChatTTS.OBS.Socket;
@ -17,13 +14,8 @@ namespace TwitchChatTTS.Chat.Messaging
{
public class ChatMessageReader
{
public string Name => "channel.chat.message";
private readonly User _user;
private readonly TTSPlayer _player;
private readonly ICommandManager _commands;
private readonly IGroupPermissionManager _permissionManager;
private readonly IChatterGroupManager _chatterGroupManager;
private readonly IEmoteDatabase _emotes;
private readonly OBSSocketClient _obs;
private readonly HermesSocketClient _hermes;
@ -36,9 +28,6 @@ namespace TwitchChatTTS.Chat.Messaging
public ChatMessageReader(
User user,
TTSPlayer player,
ICommandManager commands,
IGroupPermissionManager permissionManager,
IChatterGroupManager chatterGroupManager,
IEmoteDatabase emotes,
[FromKeyedServices("hermes")] SocketClient<WebSocketMessage> hermes,
[FromKeyedServices("obs")] SocketClient<WebSocketMessage> obs,
@ -48,9 +37,6 @@ namespace TwitchChatTTS.Chat.Messaging
{
_user = user;
_player = player;
_commands = commands;
_permissionManager = permissionManager;
_chatterGroupManager = chatterGroupManager;
_emotes = emotes;
_obs = (obs as OBSSocketClient)!;
_hermes = (hermes as HermesSocketClient)!;
@ -61,62 +47,46 @@ namespace TwitchChatTTS.Chat.Messaging
_logger = logger;
}
public async Task Execute(TwitchWebsocketClient sender, ChannelChatMessage message)
public async Task Read(TwitchWebsocketClient sender, long broadcasterId, long? chatterId, string? chatterLogin, string? messageId, TwitchReplyInfo? reply, TwitchChatFragment[] fragments, int priority)
{
if (_hermes.Connected && !_hermes.Ready)
{
_logger.Debug($"TTS is not yet ready. Ignoring chat messages [message id: {message.MessageId}]");
return; // new MessageResult(MessageStatus.NotReady, -1, -1);
_logger.Debug($"TTS is not yet ready. Ignoring chat messages [message id: {messageId}]");
return;
}
if (_configuration.Twitch?.TtsWhenOffline != true && !_obs.Streaming)
{
_logger.Debug($"OBS is not streaming. Ignoring chat messages [message id: {message.MessageId}]");
return; // new MessageResult(MessageStatus.NotReady, -1, -1);
}
var chatterId = long.Parse(message.ChatterUserId);
var broadcasterId = long.Parse(message.BroadcasterUserId);
var messageId = message.MessageId;
var groups = GetGroups(message, chatterId);
var commandResult = await CheckForChatCommand(message.Message.Text, message, groups);
if (commandResult != ChatCommandResult.Unknown)
return;
var bits = GetTotalBits(message);
if (!HasPermission(message, chatterId, groups, bits))
{
_logger.Debug($"Blocked message by {message.ChatterUserLogin}: {message.Message.Text}");
_logger.Debug($"OBS is not streaming. Ignoring chat messages [message id: {messageId}]");
return;
}
var emoteUsage = GetEmoteUsage(message);
var emoteUsage = GetEmoteUsage(fragments);
var tasks = new List<Task>();
if (_obs.Streaming)
{
if (emoteUsage.NewEmotes.Any())
tasks.Add(_hermes.SendEmoteDetails(emoteUsage.NewEmotes));
if (emoteUsage.EmotesUsed.Any())
tasks.Add(_hermes.SendEmoteUsage(message.MessageId, chatterId, emoteUsage.EmotesUsed));
if (!_user.Chatters.Contains(chatterId))
if (emoteUsage.EmotesUsed.Any() && messageId != null && chatterId != null)
tasks.Add(_hermes.SendEmoteUsage(messageId, chatterId.Value, emoteUsage.EmotesUsed));
if (!string.IsNullOrEmpty(chatterLogin) && chatterId != null && !_user.Chatters.Contains(chatterId.Value))
{
tasks.Add(_hermes.SendChatterDetails(chatterId, message.ChatterUserLogin));
_user.Chatters.Add(chatterId);
tasks.Add(_hermes.SendChatterDetails(chatterId.Value, chatterLogin));
_user.Chatters.Add(chatterId.Value);
}
}
if (_user.Raids.TryGetValue(message.BroadcasterUserId, out var raid) && !raid.Chatters.Contains(chatterId))
if (chatterId != null && _user.Raids.TryGetValue(broadcasterId.ToString(), out var raid) && !raid.Chatters.Contains(chatterId.Value))
{
_logger.Information($"Potential chat message from raider ignored due to potential raid message spam [chatter: {message.ChatterUserLogin}][chatter id: {message.ChatterUserId}]");
_logger.Information($"Potential chat message from raider ignored due to potential raid message spam [chatter: {chatterLogin}][chatter id: {chatterId}]");
return;
}
var msg = FilterMessage(message);
int priority = _chatterGroupManager.GetPriorityFor(groups);
string voiceSelected = GetSelectedVoiceFor(chatterId);
var msg = FilterMessage(fragments, reply);
string voiceSelected = chatterId == null ? _user.DefaultTTSVoice : GetSelectedVoiceFor(chatterId.Value);
var messages = GetPartialTTSMessages(msg, voiceSelected).ToList();
var groupedMessage = new TTSGroupedMessage(broadcasterId, chatterId, messageId, messages, DateTime.UtcNow, priority);
_player.Add(groupedMessage, groupedMessage.Priority);
if (tasks.Any())
await Task.WhenAll(tasks);
}
@ -175,25 +145,11 @@ namespace TwitchChatTTS.Chat.Messaging
return list;
}
private async Task<ChatCommandResult> CheckForChatCommand(string arguments, ChannelChatMessage message, IEnumerable<string> groups)
private string FilterMessage(TwitchChatFragment[] fragments, TwitchReplyInfo? reply)
{
try
{
var commandResult = await _commands.Execute(arguments, message, groups);
return commandResult;
}
catch (Exception ex)
{
_logger.Error(ex, $"Failed executing a chat command [message: {arguments}][chatter: {message.ChatterUserLogin}][chatter id: {message.ChatterUserId}][message id: {message.MessageId}]");
}
return ChatCommandResult.Fail;
}
private string FilterMessage(ChannelChatMessage message)
{
var msg = string.Join(string.Empty, message.Message.Fragments.Where(f => f.Type != "cheermote").Select(f => f.Text)).Trim();
if (message.Reply != null)
msg = msg.Substring(message.Reply.ParentUserLogin.Length + 2);
var msg = string.Join(string.Empty, fragments.Where(f => f.Type != "cheermote").Select(f => f.Text)).Trim();
if (reply != null)
msg = msg.Substring(reply.ParentUserLogin.Length + 2);
// Replace filtered words.
if (_user.RegexFilters != null)
@ -222,11 +178,11 @@ namespace TwitchChatTTS.Chat.Messaging
return msg;
}
private ChatMessageEmoteUsage GetEmoteUsage(ChannelChatMessage message)
private ChatMessageEmoteUsage GetEmoteUsage(TwitchChatFragment[] fragments)
{
var emotesUsed = new HashSet<string>();
var newEmotes = new Dictionary<string, string>();
foreach (var fragment in message.Message.Fragments)
foreach (var fragment in fragments)
{
if (fragment.Emote != null)
{
@ -256,30 +212,6 @@ namespace TwitchChatTTS.Chat.Messaging
return new ChatMessageEmoteUsage(emotesUsed, newEmotes);
}
private int GetTotalBits(ChannelChatMessage message)
{
return message.Message.Fragments.Where(f => f.Type == "cheermote" && f.Cheermote != null)
.Select(f => f.Cheermote!.Bits)
.Sum();
}
private string GetGroupNameByBadgeName(string badgeName)
{
if (badgeName == "subscriber")
return "subscribers";
if (badgeName == "moderator")
return "moderators";
return badgeName.ToLower();
}
private IEnumerable<string> GetGroups(ChannelChatMessage message, long chatterId)
{
var defaultGroups = new string[] { "everyone" };
var badgesGroups = message.Badges.Select(b => b.SetId).Select(GetGroupNameByBadgeName);
var customGroups = _chatterGroupManager.GetGroupNamesFor(chatterId);
return defaultGroups.Union(badgesGroups).Union(customGroups);
}
private IEnumerable<TTSMessage> GetPartialTTSMessages(string message, string defaultVoice)
{
var matches = _user.VoiceNameRegex?.Matches(message).ToArray();
@ -319,17 +251,6 @@ namespace TwitchChatTTS.Chat.Messaging
return voiceSelected ?? "Brian";
}
private bool HasPermission(ChannelChatMessage message, long chatterId, IEnumerable<string> groups, int bits)
{
var permissionPath = "tts.chat.messages.read";
if (!string.IsNullOrWhiteSpace(message.ChannelPointsCustomRewardId))
permissionPath = "tts.chat.redemptions.read";
else if (bits > 0)
permissionPath = "tts.chat.bits.read";
return chatterId == _user.OwnerId ? true : _permissionManager.CheckIfAllowed(groups, permissionPath) == true;
}
private class ChatMessageEmoteUsage
{
public readonly HashSet<string> EmotesUsed = new HashSet<string>();

6
Chat/Speech/TTSPlayer.cs
View File

@ -194,15 +194,15 @@ namespace TwitchChatTTS.Chat.Speech
public class TTSGroupedMessage
{
public long RoomId { get; set; }
public long ChatterId { get; set; }
public string MessageId { get; set; }
public long? ChatterId { get; set; }
public string? MessageId { get; set; }
public DateTime Timestamp { get; set; }
public int Priority { get; set; }
public IList<TTSMessage> Messages { get; set; }
public ISampleProvider? Audio { get; set; }
public TTSGroupedMessage(long broadcasterId, long chatterId, string messageId, IList<TTSMessage> messages, DateTime timestamp, int priority)
public TTSGroupedMessage(long broadcasterId, long? chatterId, string? messageId, IList<TTSMessage> messages, DateTime timestamp, int priority)
{
RoomId = broadcasterId;
ChatterId = chatterId;