github/Discord.Net
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added IMessage.Tags

Browse Source
This commit is contained in:
RogueException
2016-10-06 09:06:04 -03:00
parent abd315ed21
commit 090a1bc736
33 changed files with 478 additions and 421 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/Discord.Net.Core/Entities/Channels/IChannel.cs
View File

@@ -5,6 +5,9 @@ namespace Discord
{
public interface IChannel : ISnowflakeEntity
{
/// <summary> Gets the name of this channel. </summary>
string Name { get; }
/// <summary> Gets a collection of all users in this channel. </summary>
IAsyncEnumerable<IReadOnlyCollection<IUser>> GetUsersAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null);

2
src/Discord.Net.Core/Entities/Channels/IGuildChannel.cs
View File

@@ -7,8 +7,6 @@ namespace Discord
{
public interface IGuildChannel : IChannel, IDeletable
{
/// <summary> Gets the name of this channel. </summary>
string Name { get; }
/// <summary> Gets the position of this channel in the guild's channel list, relative to others of the same type. </summary>
int Position { get; }

7
src/Discord.Net.Core/Entities/Messages/EmbedProvider.cs
View File

@@ -1,7 +1,9 @@
using Model = Discord.API.EmbedProvider;
using System.Diagnostics;
using Model = Discord.API.EmbedProvider;
namespace Discord
{
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public struct EmbedProvider
{
public string Name { get; }
@@ -16,5 +18,8 @@ namespace Discord
{
return new EmbedProvider(model.Name, model.Url);
}
private string DebuggerDisplay => $"{Name} ({Url})";
public override string ToString() => Name;
}
}

7
src/Discord.Net.Core/Entities/Messages/EmbedThumbnail.cs
View File

@@ -1,7 +1,9 @@
using Model = Discord.API.EmbedThumbnail;
using System.Diagnostics;
using Model = Discord.API.EmbedThumbnail;
namespace Discord
{
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public struct EmbedThumbnail
{
public string Url { get; }
@@ -22,5 +24,8 @@ namespace Discord
model.Height.IsSpecified ? model.Height.Value : (int?)null,
model.Width.IsSpecified ? model.Width.Value : (int?)null);
}
private string DebuggerDisplay => $"{ToString()} ({Url})";
public override string ToString() => Width != null && Height != null ? $"{Width}x{Height}" : "0x0";
}
}

42
src/Discord.Net.Core/Entities/Messages/Emoji.cs
View File

@@ -1,22 +1,54 @@
using Discord.API;
using System;
using System.Diagnostics;
using System.Globalization;
namespace Discord
{
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public struct Emoji
{
public ulong Id { get; }
public string Name { get; }
public int Index { get; }
public int Length { get; }
public string Url => CDN.GetEmojiUrl(Id);
internal Emoji(ulong id, string name, int index, int length)
internal Emoji(ulong id, string name)
{
Id = id;
Name = name;
Index = index;
Length = length;
}
public static Emoji Parse(string text)
{
Emoji result;
if (TryParse(text, out result))
return result;
throw new ArgumentException("Invalid emoji format", nameof(text));
}
public static bool TryParse(string text, out Emoji result)
{
result = default(Emoji);
if (text.Length >= 4 && text[0] == '<' && text[1] == ':' && text[text.Length - 1] == '>')
{
int splitIndex = text.IndexOf(':', 2);
if (splitIndex == -1)
return false;
ulong id;
if (!ulong.TryParse(text.Substring(splitIndex + 1, text.Length - splitIndex - 2), NumberStyles.None, CultureInfo.InvariantCulture, out id))
return false;
string name = text.Substring(2, splitIndex - 2);
result = new Emoji(id, name);
return true;
}
return false;
}
private string DebuggerDisplay => $"{Name} ({Id})";
public override string ToString() => Name;
}
}

4
src/Discord.Net.Core/Entities/Messages/IMessage.cs
View File

@@ -27,8 +27,8 @@ namespace Discord
IReadOnlyCollection<IAttachment> Attachments { get; }
/// <summary> Returns a collection of all embeds included in this message. </summary>
IReadOnlyCollection<IEmbed> Embeds { get; }
/// <summary> Returns a collection of all custom emoji included in this message. </summary>
IReadOnlyCollection<Emoji> Emojis { get; }
/// <summary> Returns a collection of all tags included in this message's content. </summary>
IReadOnlyCollection<ITag> Tags { get; }
/// <summary> Returns a collection of channel ids mentioned in this message. </summary>
IReadOnlyCollection<ulong> MentionedChannelIds { get; }
/// <summary> Returns a collection of roles mentioned in this message. </summary>

11
src/Discord.Net.Core/Entities/Messages/ITag.cs Normal file
View File

@@ -0,0 +1,11 @@
namespace Discord
{
public interface ITag
{
int Index { get; }
int Length { get; }
TagType Type { get; }
ulong Key { get; }
object Value { get; }
}
}

19
src/Discord.Net.Core/Entities/Messages/IUserMessage.cs
View File

@@ -12,18 +12,13 @@ namespace Discord
Task PinAsync(RequestOptions options = null);
/// <summary> Removes this message from its channel's pinned messages. </summary>
Task UnpinAsync(RequestOptions options = null);
/// <summary> Transforms this message's text into a human readable form, resolving mentions to that object's name. </summary>
string Resolve(int startIndex, int length,
UserMentionHandling userHandling = UserMentionHandling.Name,
ChannelMentionHandling channelHandling = ChannelMentionHandling.Name,
RoleMentionHandling roleHandling = RoleMentionHandling.Name,
EveryoneMentionHandling everyoneHandling = EveryoneMentionHandling.Ignore);
/// <summary> Transforms this message's text into a human readable form, resolving mentions to that object's name. </summary>
/// <summary> Transforms this message's text into a human readable form by resolving its tags. </summary>
string Resolve(
UserMentionHandling userHandling = UserMentionHandling.Name,
ChannelMentionHandling channelHandling = ChannelMentionHandling.Name,
RoleMentionHandling roleHandling = RoleMentionHandling.Name,
EveryoneMentionHandling everyoneHandling = EveryoneMentionHandling.Ignore);
TagHandling userHandling = TagHandling.Name,
TagHandling channelHandling = TagHandling.Name,
TagHandling roleHandling = TagHandling.Name,
TagHandling everyoneHandling = TagHandling.Ignore,
TagHandling emojiHandling = TagHandling.Name);
}
}

9
src/Discord.Net.Core/Entities/Messages/Mentions/EveryoneMentionHandling.cs
View File

@@ -1,9 +0,0 @@
namespace Discord
{
public enum EveryoneMentionHandling
{
Ignore = 0,
Remove,
Sanitize
}
}

10
src/Discord.Net.Core/Entities/Messages/Mentions/RoleMentionHandling.cs
View File

@@ -1,10 +0,0 @@
namespace Discord
{
public enum RoleMentionHandling
{
Ignore = 0,
Remove,
Name,
Sanitize
}
}

11
src/Discord.Net.Core/Entities/Messages/Mentions/UserMentionHandling.cs
View File

@@ -1,11 +0,0 @@
namespace Discord
{
public enum UserMentionHandling
{
Ignore = 0,
Remove,
Name,
NameAndDiscriminator,
Sanitize
}
}

28
src/Discord.Net.Core/Entities/Messages/Tag.cs Normal file
View File

@@ -0,0 +1,28 @@
using System.Diagnostics;
namespace Discord
{
[DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class Tag<T> : ITag
{
public TagType Type { get; }
public int Index { get; }
public int Length { get; }
public ulong Key { get; }
public T Value { get; }
internal Tag(TagType type, int index, int length, ulong key, T value)
{
Type = type;
Index = index;
Length = length;
Key = key;
Value = value;
}
private string DebuggerDisplay => $"{Value?.ToString() ?? "null"} ({Type})";
public override string ToString() => $"{Value?.ToString() ?? "null"} ({Type})";
object ITag.Value => Value;
}
}

3
src/Discord.Net.Core/Entities/Messages/Mentions/ChannelMentionHandling.cs → src/Discord.Net.Core/Entities/Messages/TagHandling.cs
View File

@@ -1,10 +1,11 @@
namespace Discord
{
public enum ChannelMentionHandling
public enum TagHandling
{
Ignore = 0,
Remove,
Name,
FullName,
Sanitize
}
}

12
src/Discord.Net.Core/Entities/Messages/TagType.cs Normal file
View File

@@ -0,0 +1,12 @@
namespace Discord
{
public enum TagType
{
UserMention,
ChannelMention,
RoleMention,
EveryoneMention,
HereMention,
Emoji
}
}

356
src/Discord.Net.Core/Utils/MentionUtils.cs
View File

@@ -1,9 +1,6 @@
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Globalization;
using System.Linq;
using System.Text.RegularExpressions;
using System.Text;
namespace Discord
{
@@ -11,10 +8,6 @@ namespace Discord
{
private const char SanitizeChar = '\x200b';
private static readonly Regex _userRegex = new Regex(@"<@!?([0-9]+)>", RegexOptions.Compiled);
private static readonly Regex _channelRegex = new Regex(@"<#([0-9]+)>", RegexOptions.Compiled);
private static readonly Regex _roleRegex = new Regex(@"<@&([0-9]+)>", RegexOptions.Compiled);
//If the system can't be positive a user doesn't have a nickname, assume useNickname = true (source: Jake)
internal static string MentionUser(string id, bool useNickname = true) => useNickname ? $"<@!{id}>" : $"<@{id}>";
public static string MentionUser(ulong id) => MentionUser(id.ToString(), true);
@@ -24,25 +17,24 @@ namespace Discord
public static string MentionRole(ulong id) => MentionRole(id.ToString());
/// <summary> Parses a provided user mention string. </summary>
public static ulong ParseUser(string mentionText)
public static ulong ParseUser(string text)
{
ulong id;
if (TryParseUser(mentionText, out id))
if (TryParseUser(text, out id))
return id;
throw new ArgumentException("Invalid mention format", nameof(mentionText));
throw new ArgumentException("Invalid mention format", nameof(text));
}
/// <summary> Tries to parse a provided user mention string. </summary>
public static bool TryParseUser(string mentionText, out ulong userId)
public static bool TryParseUser(string text, out ulong userId)
{
mentionText = mentionText.Trim();
if (mentionText.Length >= 3 && mentionText[0] == '<' && mentionText[1] == '@' && mentionText[mentionText.Length - 1] == '>')
if (text.Length >= 3 && text[0] == '<' && text[1] == '@' && text[text.Length - 1] == '>')
{
if (mentionText.Length >= 4 && mentionText[2] == '!')
mentionText = mentionText.Substring(3, mentionText.Length - 4); //<@!123>
if (text.Length >= 4 && text[2] == '!')
text = text.Substring(3, text.Length - 4); //<@!123>
else
mentionText = mentionText.Substring(2, mentionText.Length - 3); //<@123>
text = text.Substring(2, text.Length - 3); //<@123>
if (ulong.TryParse(mentionText, NumberStyles.None, CultureInfo.InvariantCulture, out userId))
if (ulong.TryParse(text, NumberStyles.None, CultureInfo.InvariantCulture, out userId))
return true;
}
userId = 0;
@@ -50,22 +42,21 @@ namespace Discord
}
/// <summary> Parses a provided channel mention string. </summary>
public static ulong ParseChannel(string mentionText)
public static ulong ParseChannel(string text)
{
ulong id;
if (TryParseChannel(mentionText, out id))
if (TryParseChannel(text, out id))
return id;
throw new ArgumentException("Invalid mention format", nameof(mentionText));
throw new ArgumentException("Invalid mention format", nameof(text));
}
/// <summary>Tries to parse a provided channel mention string. </summary>
public static bool TryParseChannel(string mentionText, out ulong channelId)
public static bool TryParseChannel(string text, out ulong channelId)
{
mentionText = mentionText.Trim();
if (mentionText.Length >= 3 && mentionText[0] == '<' && mentionText[1] == '#' && mentionText[mentionText.Length - 1] == '>')
if (text.Length >= 3 && text[0] == '<' && text[1] == '#' && text[text.Length - 1] == '>')
{
mentionText = mentionText.Substring(2, mentionText.Length - 3); //<#123>
text = text.Substring(2, text.Length - 3); //<#123>
if (ulong.TryParse(mentionText, NumberStyles.None, CultureInfo.InvariantCulture, out channelId))
if (ulong.TryParse(text, NumberStyles.None, CultureInfo.InvariantCulture, out channelId))
return true;
}
channelId = 0;
@@ -73,212 +64,175 @@ namespace Discord
}
/// <summary> Parses a provided role mention string. </summary>
public static ulong ParseRole(string mentionText)
public static ulong ParseRole(string text)
{
ulong id;
if (TryParseRole(mentionText, out id))
if (TryParseRole(text, out id))
return id;
throw new ArgumentException("Invalid mention format", nameof(mentionText));
throw new ArgumentException("Invalid mention format", nameof(text));
}
/// <summary>Tries to parse a provided role mention string. </summary>
public static bool TryParseRole(string mentionText, out ulong roleId)
public static bool TryParseRole(string text, out ulong roleId)
{
mentionText = mentionText.Trim();
if (mentionText.Length >= 4 && mentionText[0] == '<' && mentionText[1] == '@' && mentionText[2] == '&' && mentionText[mentionText.Length - 1] == '>')
if (text.Length >= 4 && text[0] == '<' && text[1] == '@' && text[2] == '&' && text[text.Length - 1] == '>')
{
mentionText = mentionText.Substring(3, mentionText.Length - 4); //<@&123>
text = text.Substring(3, text.Length - 4); //<@&123>
if (ulong.TryParse(mentionText, NumberStyles.None, CultureInfo.InvariantCulture, out roleId))
if (ulong.TryParse(text, NumberStyles.None, CultureInfo.InvariantCulture, out roleId))
return true;
}
roleId = 0;
return false;
}
internal static ImmutableArray<TUser> GetUserMentions<TUser>(string text, IMessageChannel channel, IReadOnlyCollection<TUser> mentionedUsers)
where TUser : class, IUser
internal static string Resolve(IMessage msg, TagHandling userHandling, TagHandling channelHandling, TagHandling roleHandling, TagHandling everyoneHandling, TagHandling emojiHandling)
{
var matches = _userRegex.Matches(text);
var builder = ImmutableArray.CreateBuilder<TUser>(matches.Count);
foreach (var match in matches.OfType<Match>())
var text = new StringBuilder(msg.Content);
var tags = msg.Tags;
int indexOffset = 0;
foreach (var tag in tags)
{
ulong id;
if (ulong.TryParse(match.Groups[1].Value, NumberStyles.None, CultureInfo.InvariantCulture, out id))
string newText = "";
switch (tag.Type)
{
TUser user = null;
//Verify this user was actually mentioned
foreach (var userMention in mentionedUsers)
{
if (userMention.Id == id)
{
user = channel?.GetUserAsync(id, CacheMode.CacheOnly).GetAwaiter().GetResult() as TUser;
if (user == null) //User not found, fallback to basic mention info
user = userMention;
break;
}
}
if (user != null)
builder.Add(user);
case TagType.UserMention:
if (userHandling == TagHandling.Ignore) continue;
newText = ResolveUserMention(tag, userHandling);
break;
case TagType.ChannelMention:
if (channelHandling == TagHandling.Ignore) continue;
newText = ResolveChannelMention(tag, channelHandling);
break;
case TagType.RoleMention:
if (roleHandling == TagHandling.Ignore) continue;
newText = ResolveRoleMention(tag, roleHandling);
break;
case TagType.EveryoneMention:
if (everyoneHandling == TagHandling.Ignore) continue;
newText = ResolveEveryoneMention(tag, everyoneHandling);
break;
case TagType.HereMention:
if (everyoneHandling == TagHandling.Ignore) continue;
newText = ResolveHereMention(tag, everyoneHandling);
break;
case TagType.Emoji:
if (emojiHandling == TagHandling.Ignore) continue;
newText = ResolveEmoji(tag, emojiHandling);
break;
}
text.Remove(tag.Index, tag.Length);
text.Insert(tag.Index, newText);
indexOffset += newText.Length - tag.Length;
}
return text.ToString();
}
internal static string ResolveUserMention(ITag tag, TagHandling mode)
{
if (mode != TagHandling.Remove)
{
var user = tag.Value as IUser;
switch (mode)
{
case TagHandling.Name:
if (user != null)
return $"@{(user as IGuildUser)?.Nickname ?? user?.Username}";
else
return $"@unknown-user";
case TagHandling.FullName:
if (user != null)
return $"@{(user as IGuildUser)?.Nickname ?? user?.Username}#{user.Discriminator}";
else
return $"@unknown-user";
case TagHandling.Sanitize:
return MentionUser($"{SanitizeChar}{tag.Key}");
}
}
return builder.ToImmutable();
return "";
}
internal static ImmutableArray<ulong> GetChannelMentions(string text, IGuild guild)
internal static string ResolveChannelMention(ITag tag, TagHandling mode)
{
var matches = _channelRegex.Matches(text);
var builder = ImmutableArray.CreateBuilder<ulong>(matches.Count);
foreach (var match in matches.OfType<Match>())
if (mode != TagHandling.Remove)
{
ulong id;
if (ulong.TryParse(match.Groups[1].Value, NumberStyles.None, CultureInfo.InvariantCulture, out id))
builder.Add(id);
}
return builder.ToImmutable();
}
internal static ImmutableArray<TRole> GetRoleMentions<TRole>(string text, IGuild guild)
where TRole : class, IRole
{
if (guild == null)
return ImmutableArray.Create<TRole>();
var matches = _roleRegex.Matches(text);
var builder = ImmutableArray.CreateBuilder<TRole>(matches.Count);
foreach (var match in matches.OfType<Match>())
{
ulong id;
if (ulong.TryParse(match.Groups[1].Value, NumberStyles.None, CultureInfo.InvariantCulture, out id))
var channel = tag.Value as IChannel;
switch (mode)
{
var role = guild.GetRole(id) as TRole;
if (role != null)
builder.Add(role);
case TagHandling.Name:
case TagHandling.FullName:
if (channel != null)
return $"#{channel.Name}";
else
return $"#deleted-channel";
case TagHandling.Sanitize:
return MentionChannel($"{SanitizeChar}{tag.Key}");
}
}
return builder.ToImmutable();
return "";
}
internal static string ResolveUserMentions(string text, IMessageChannel channel, IReadOnlyCollection<IUser> mentions, UserMentionHandling mode)
internal static string ResolveRoleMention(ITag tag, TagHandling mode)
{
if (mode == UserMentionHandling.Ignore) return text;
return _userRegex.Replace(text, new MatchEvaluator(e =>
if (mode != TagHandling.Remove)
{
ulong id;
if (ulong.TryParse(e.Groups[1].Value, NumberStyles.None, CultureInfo.InvariantCulture, out id))
var role = tag.Value as IRole;
switch (mode)
{
IUser user = null;
foreach (var mention in mentions)
{
if (mention.Id == id)
{
user = mention;
break;
}
}
if (user != null)
{
string name = user.Username;
var guildUser = user as IGuildUser;
if (e.Value[2] == '!')
{
if (guildUser != null && guildUser.Nickname != null)
name = guildUser.Nickname;
}
switch (mode)
{
case UserMentionHandling.Name:
return $"@{name}";
case UserMentionHandling.NameAndDiscriminator:
return $"@{name}#{user.Discriminator}";
case UserMentionHandling.Sanitize:
return MentionUser($"{SanitizeChar}{id}");
case UserMentionHandling.Remove:
default:
return "";
}
}
case TagHandling.Name:
case TagHandling.FullName:
if (role != null)
return $"@{role.Name}";
else
return $"@deleted-role";
case TagHandling.Sanitize:
return MentionRole($"{SanitizeChar}{tag.Key}");
}
return e.Value;
}));
}
internal static string ResolveChannelMentions(string text, IGuild guild, ChannelMentionHandling mode)
{
if (mode == ChannelMentionHandling.Ignore) return text;
return _channelRegex.Replace(text, new MatchEvaluator(e =>
{
ulong id;
if (ulong.TryParse(e.Groups[1].Value, NumberStyles.None, CultureInfo.InvariantCulture, out id))
{
switch (mode)
{
case ChannelMentionHandling.Name:
IGuildChannel channel = null;
channel = guild.GetChannelAsync(id, CacheMode.CacheOnly).GetAwaiter().GetResult();
if (channel != null)
return $"#{channel.Name}";
else
return $"#deleted-channel";
case ChannelMentionHandling.Sanitize:
return MentionChannel($"{SanitizeChar}{id}");
case ChannelMentionHandling.Remove:
default:
return "";
}
}
return e.Value;
}));
}
internal static string ResolveRoleMentions(string text, IReadOnlyCollection<IRole> mentions, RoleMentionHandling mode)
{
if (mode == RoleMentionHandling.Ignore) return text;
return _roleRegex.Replace(text, new MatchEvaluator(e =>
{
ulong id;
if (ulong.TryParse(e.Groups[1].Value, NumberStyles.None, CultureInfo.InvariantCulture, out id))
{
switch (mode)
{
case RoleMentionHandling.Name:
IRole role = null;
foreach (var mention in mentions)
{
if (mention.Id == id)
{
role = mention;
break;
}
}
if (role != null)
return $"{role.Name}";
else
return $"deleted-role";
case RoleMentionHandling.Sanitize:
return MentionRole($"{SanitizeChar}{id}");
case RoleMentionHandling.Remove:
default:
return "";
}
}
return e.Value;
}));
}
internal static string ResolveEveryoneMentions(string text, EveryoneMentionHandling mode)
{
if (mode == EveryoneMentionHandling.Ignore) return text;
switch (mode)
{
case EveryoneMentionHandling.Sanitize:
return text.Replace("@everyone", $"@{SanitizeChar}everyone").Replace("@here", $"@{SanitizeChar}here");
case EveryoneMentionHandling.Remove:
default:
return text.Replace("@everyone", "").Replace("@here", "");
}
return "";
}
internal static string ResolveEveryoneMention(ITag tag, TagHandling mode)
{
if (mode != TagHandling.Remove)
{
switch (mode)
{
case TagHandling.Name:
case TagHandling.FullName:
return "@everyone";
case TagHandling.Sanitize:
return $"@{SanitizeChar}everyone";
}
}
return "";
}
internal static string ResolveHereMention(ITag tag, TagHandling mode)
{
if (mode != TagHandling.Remove)
{
switch (mode)
{
case TagHandling.Name:
case TagHandling.FullName:
return "@everyone";
case TagHandling.Sanitize:
return $"@{SanitizeChar}everyone";
}
}
return "";
}
internal static string ResolveEmoji(ITag tag, TagHandling mode)
{
if (mode != TagHandling.Remove)
{
Emoji emoji = (Emoji)tag.Value;
switch (mode)
{
case TagHandling.Name:
case TagHandling.FullName:
return $":{emoji.Name}:";
case TagHandling.Sanitize:
return $"<@{SanitizeChar}everyone";
}
}
return "";
}
}
}

3
src/Discord.Net.Core/project.json
View File

@@ -35,8 +35,7 @@
"System.Net.WebSockets.Client": {
"version": "4.0.0",
"type": "build"
},
"System.Text.RegularExpressions": "4.1.0"
}
},
"frameworks": {