|
- using System;
- using System.Collections.Generic;
- using System.Globalization;
- using System.IO;
- using System.Text.RegularExpressions;
- using System.Threading.Tasks;
- using Discord.Logging;
- using Discord.Rest;
-
- namespace Discord.Webhook
- {
- /// <summary> A client responsible for connecting as a Webhook. </summary>
- public class DiscordWebhookClient : IDisposable
- {
- public event Func<LogMessage, Task> Log { add { _logEvent.Add(value); } remove { _logEvent.Remove(value); } }
- internal readonly AsyncEvent<Func<LogMessage, Task>> _logEvent = new AsyncEvent<Func<LogMessage, Task>>();
-
- private readonly ulong _webhookId;
- internal IWebhook Webhook;
- internal readonly Logger _restLogger;
-
- internal API.DiscordRestApiClient ApiClient { get; }
- internal LogManager LogManager { get; }
-
- /// <summary> Creates a new Webhook Discord client. </summary>
- public DiscordWebhookClient(IWebhook webhook)
- : this(webhook.Id, webhook.Token, new DiscordRestConfig()) { }
- /// <summary> Creates a new Webhook Discord client. </summary>
- public DiscordWebhookClient(ulong webhookId, string webhookToken)
- : this(webhookId, webhookToken, new DiscordRestConfig()) { }
- /// <summary> Creates a new Webhook Discord client. </summary>
- public DiscordWebhookClient(string webhookUrl)
- : this(webhookUrl, new DiscordRestConfig()) { }
-
- // regex pattern to match webhook urls
- private static Regex WebhookUrlRegex = new Regex(@"^.*(discord|discordapp)\.com\/api\/webhooks\/([\d]+)\/([a-z0-9_-]+)$", RegexOptions.Compiled | RegexOptions.IgnoreCase | RegexOptions.CultureInvariant);
-
- /// <summary> Creates a new Webhook Discord client. </summary>
- public DiscordWebhookClient(ulong webhookId, string webhookToken, DiscordRestConfig config)
- : this(config)
- {
- _webhookId = webhookId;
- ApiClient.LoginAsync(TokenType.Webhook, webhookToken).GetAwaiter().GetResult();
- Webhook = WebhookClientHelper.GetWebhookAsync(this, webhookId).GetAwaiter().GetResult();
- }
- /// <summary> Creates a new Webhook Discord client. </summary>
- public DiscordWebhookClient(IWebhook webhook, DiscordRestConfig config)
- : this(config)
- {
- Webhook = webhook;
- _webhookId = Webhook.Id;
- }
-
- /// <summary>
- /// Creates a new Webhook Discord client.
- /// </summary>
- /// <param name="webhookUrl">The url of the webhook.</param>
- /// <param name="config">The configuration options to use for this client.</param>
- /// <exception cref="ArgumentException">Thrown if the <paramref name="webhookUrl"/> is an invalid format.</exception>
- /// <exception cref="ArgumentNullException">Thrown if the <paramref name="webhookUrl"/> is null or whitespace.</exception>
- public DiscordWebhookClient(string webhookUrl, DiscordRestConfig config) : this(config)
- {
- ParseWebhookUrl(webhookUrl, out _webhookId, out string token);
- ApiClient.LoginAsync(TokenType.Webhook, token).GetAwaiter().GetResult();
- Webhook = WebhookClientHelper.GetWebhookAsync(this, _webhookId).GetAwaiter().GetResult();
- }
-
- private DiscordWebhookClient(DiscordRestConfig config)
- {
- ApiClient = CreateApiClient(config);
- LogManager = new LogManager(config.LogLevel);
- LogManager.Message += async msg => await _logEvent.InvokeAsync(msg).ConfigureAwait(false);
-
- _restLogger = LogManager.CreateLogger("Rest");
-
- ApiClient.RequestQueue.RateLimitTriggered += async (id, info, endpoint) =>
- {
- if (info == null)
- await _restLogger.VerboseAsync($"Preemptive Rate limit triggered: {endpoint} {(id.IsHashBucket ? $"(Bucket: {id.BucketHash})" : "")}").ConfigureAwait(false);
- else
- await _restLogger.WarningAsync($"Rate limit triggered: {endpoint} {(id.IsHashBucket ? $"(Bucket: {id.BucketHash})" : "")}").ConfigureAwait(false);
- };
- ApiClient.SentRequest += async (method, endpoint, millis) => await _restLogger.VerboseAsync($"{method} {endpoint}: {millis} ms").ConfigureAwait(false);
- }
- private static API.DiscordRestApiClient CreateApiClient(DiscordRestConfig config)
- => new API.DiscordRestApiClient(config.RestClientProvider, DiscordRestConfig.UserAgent);
- /// <summary> Sends a message to the channel for this webhook. </summary>
- /// <returns> Returns the ID of the created message. </returns>
- public Task<ulong> SendMessageAsync(string text = null, bool isTTS = false, IEnumerable<Embed> embeds = null,
- string username = null, string avatarUrl = null, RequestOptions options = null, AllowedMentions allowedMentions = null, MessageComponent component = null)
- => WebhookClientHelper.SendMessageAsync(this, text, isTTS, embeds, username, avatarUrl, allowedMentions, options, component);
-
- /// <summary>
- /// Modifies a message posted using this webhook.
- /// </summary>
- /// <remarks>
- /// This method can only modify messages that were sent using the same webhook.
- /// </remarks>
- /// <param name="messageId">ID of the modified message.</param>
- /// <param name="func">A delegate containing the properties to modify the message with.</param>
- /// <param name="options">The options to be used when sending the request.</param>
- /// <returns>
- /// A task that represents the asynchronous modification operation.
- /// </returns>
- public Task ModifyMessageAsync(ulong messageId, Action<WebhookMessageProperties> func, RequestOptions options = null)
- => WebhookClientHelper.ModifyMessageAsync(this, messageId, func, options);
-
- /// <summary>
- /// Deletes a message posted using this webhook.
- /// </summary>
- /// <remarks>
- /// This method can only delete messages that were sent using the same webhook.
- /// </remarks>
- /// <param name="messageId">ID of the deleted message.</param>
- /// <param name="options">The options to be used when sending the request.</param>
- /// <returns>
- /// A task that represents the asynchronous deletion operation.
- /// </returns>
- public Task DeleteMessageAsync(ulong messageId, RequestOptions options = null)
- => WebhookClientHelper.DeleteMessageAsync(this, messageId, options);
-
- /// <summary> Sends a message to the channel for this webhook with an attachment. </summary>
- /// <returns> Returns the ID of the created message. </returns>
- public Task<ulong> SendFileAsync(string filePath, string text, bool isTTS = false,
- IEnumerable<Embed> embeds = null, string username = null, string avatarUrl = null,
- RequestOptions options = null, bool isSpoiler = false, AllowedMentions allowedMentions = null,
- MessageComponent components = null)
- => WebhookClientHelper.SendFileAsync(this, filePath, text, isTTS, embeds, username, avatarUrl,
- allowedMentions, options, isSpoiler, components);
- /// <summary> Sends a message to the channel for this webhook with an attachment. </summary>
- /// <returns> Returns the ID of the created message. </returns>
- public Task<ulong> SendFileAsync(Stream stream, string filename, string text, bool isTTS = false,
- IEnumerable<Embed> embeds = null, string username = null, string avatarUrl = null,
- RequestOptions options = null, bool isSpoiler = false, AllowedMentions allowedMentions = null,
- MessageComponent components = null)
- => WebhookClientHelper.SendFileAsync(this, stream, filename, text, isTTS, embeds, username,
- avatarUrl, allowedMentions, options, isSpoiler, components);
-
- /// <summary> Sends a message to the channel for this webhook with an attachment. </summary>
- /// <returns> Returns the ID of the created message. </returns>
- public Task<ulong> SendFileAsync(FileAttachment attachment, string text, bool isTTS = false,
- IEnumerable<Embed> embeds = null, string username = null, string avatarUrl = null,
- RequestOptions options = null, AllowedMentions allowedMentions = null, MessageComponent components = null)
- => WebhookClientHelper.SendFileAsync(this, attachment, text, isTTS, embeds, username,
- avatarUrl, allowedMentions, components, options);
-
- /// <summary> Sends a message to the channel for this webhook with an attachment. </summary>
- /// <returns> Returns the ID of the created message. </returns>
- public Task<ulong> SendFilesAsync(IEnumerable<FileAttachment> attachments, string text, bool isTTS = false,
- IEnumerable<Embed> embeds = null, string username = null, string avatarUrl = null,
- RequestOptions options = null, AllowedMentions allowedMentions = null, MessageComponent components = null)
- => WebhookClientHelper.SendFilesAsync(this, attachments, text, isTTS, embeds, username, avatarUrl,
- allowedMentions, components, options);
-
-
- /// <summary> Modifies the properties of this webhook. </summary>
- public Task ModifyWebhookAsync(Action<WebhookProperties> func, RequestOptions options = null)
- => Webhook.ModifyAsync(func, options);
-
- /// <summary> Deletes this webhook from Discord and disposes the client. </summary>
- public async Task DeleteWebhookAsync(RequestOptions options = null)
- {
- await Webhook.DeleteAsync(options).ConfigureAwait(false);
- Dispose();
- }
-
- public void Dispose()
- {
- ApiClient?.Dispose();
- }
-
- internal static void ParseWebhookUrl(string webhookUrl, out ulong webhookId, out string webhookToken)
- {
- if (string.IsNullOrWhiteSpace(webhookUrl))
- throw new ArgumentNullException(paramName: nameof(webhookUrl), message:
- "The given webhook Url cannot be null or whitespace.");
-
- // thrown when groups are not populated/valid, or when there is no match
- ArgumentException ex(string reason = null)
- => new ArgumentException(paramName: nameof(webhookUrl), message:
- $"The given webhook Url was not in a valid format. {reason}");
- var match = WebhookUrlRegex.Match(webhookUrl);
- if (match != null)
- {
- // ensure that the first group is a ulong, set the _webhookId
- // 0th group is always the entire match, and 1 is the domain; so start at index 2
- if (!(match.Groups[2].Success && ulong.TryParse(match.Groups[2].Value, NumberStyles.None, CultureInfo.InvariantCulture, out webhookId)))
- throw ex("The webhook Id could not be parsed.");
-
- if (!match.Groups[3].Success)
- throw ex("The webhook token could not be parsed.");
- webhookToken = match.Groups[3].Value;
- }
- else
- throw ex();
- }
- }
- }
|