feat: 將 TwitCasting 直播通知改由 WebHook 接收

Author: konnokai

Discord Stream Notify Bot/Command/TwitCasting/TwitCasting.cs

@@ -0,0 +1,47 @@
+using Discord.Commands;
+using Discord_Stream_Notify_Bot.DataBase;
+using Discord_Stream_Notify_Bot.HttpClients;
+
+namespace Discord_Stream_Notify_Bot.Command.TwitCasting
+{
+    public class TwitCasting : TopLevelModule
+    {
+        private readonly MainDbService _mainDbService;
+        private readonly TwitcastingClient _twitcastingClient;
+
+        public TwitCasting(MainDbService mainDbService, TwitcastingClient twitcastingClient)
+        {
+            _mainDbService = mainDbService;
+            _twitcastingClient = twitcastingClient;
+        }
+
+        [RequireContext(ContextType.DM)]
+        [Command("FixTCDb")]
+        [Alias("ftcdb")]
+        [RequireOwner]
+        public async Task FixTCDbAsync()
+        {
+            await Context.Channel.TriggerTypingAsync().ConfigureAwait(false);
+
+            using var db = _mainDbService.GetDbContext();
+            var needFixList = db.TwitcastingSpider.Where((x) => string.IsNullOrEmpty(x.ChannelId)).ToList();
+
+            foreach (var spider in needFixList)
+            {
+                var userInfo = await _twitcastingClient.GetUserInfoAsync(spider.ScreenId).ConfigureAwait(false);
+                if (userInfo != null)
+                {
+                    spider.ChannelId = userInfo.User.Id;
+                }
+                else
+                {
+                    Log.Error($"Failed to fix TwitCasting Spider for ScreenId: {spider.ScreenId}");
+                }
+            }
+
+            await db.SaveChangesAsync().ConfigureAwait(false);
+
+            await Context.Channel.SendConfirmAsync("Fix TwitCasting Spider Database", $"Fixed {needFixList.Count} entries.").ConfigureAwait(false);
+        }
+    }
+}

Discord Stream Notify Bot/DataBase/Table/NoticeTwitcastingStreamChannel.cs

@@ -4,7 +4,7 @@ public class NoticeTwitcastingStreamChannel : DbEntity
     {
         public ulong GuildId { get; set; }
         public ulong DiscordChannelId { get; set; }
-        public string ChannelId { get; set; }
+        public string ScreenId { get; set; }
         public string StartStreamMessage { get; set; } = "";
     }
 }

Discord Stream Notify Bot/DataBase/Table/TwitcastingSpider.cs

@@ -4,6 +4,7 @@ public class TwitcastingSpider : DbEntity
     {
         public ulong GuildId { get; set; }
         public string ChannelTitle { get; set; }
+        public string ScreenId { get; set; }
         public string ChannelId { get; set; }
         public bool IsWarningUser { get; set; } = false;
         public bool IsRecord { get; set; } = false;

Discord Stream Notify Bot/HttpClients/TwitCasting/TwitcastingClient.cs

@@ -1,4 +1,4 @@
-using Discord_Stream_Notify_Bot.HttpClients.TwitCasting;
+using Discord_Stream_Notify_Bot.HttpClients.Twitcasting.Model;
 using System.Text;
 
 #nullable enable
@@ -11,6 +11,7 @@ public class TwitcastingClient
         private readonly HttpClient? _apiHttpClient;
 
         private readonly string? _twitcastingAccessToken;
+        private static readonly string[] _events = ["livestart"];
 
         public TwitcastingClient(HttpClient httpClient, BotConfig botConfig)
         {
@@ -30,10 +31,10 @@ public TwitcastingClient(HttpClient httpClient, BotConfig botConfig)
         }
 
         /// <summary>
-        /// 取得頻道正在直播的資料
+        /// 取得直播分類資料
         /// </summary>
         /// <param name="channelId"></param>
-        /// <returns>如果正在直播，則回傳 (<see langword="true"/>, <see cref="int">影片 Id</see>)，否則為 (<see langword="false"/>, <see cref="int">0</see>)</returns>
+        /// <returns></returns>
         public async Task<List<Category>?> GetCategoriesAsync()
         {
             if (_apiHttpClient == null)
@@ -47,7 +48,7 @@ public TwitcastingClient(HttpClient httpClient, BotConfig botConfig)
             }
             catch (Exception ex)
             {
-                Log.Error($"TwitCastingClient.GetCategoriesAsync: {ex}");
+                Log.Error(ex.Demystify(), "TwitCastingClient.GetCategoriesAsync");
                 return null;
             }
         }
@@ -70,7 +71,7 @@ public TwitcastingClient(HttpClient httpClient, BotConfig botConfig)
             }
             catch (Exception ex)
             {
-                Log.Error($"TwitCastingClient.GetNewStreamDataAsync: {ex}");
+                Log.Error(ex.Demystify(), "TwitCastingClient.GetNewStreamDataAsync");
                 return null;
             }
         }
@@ -97,9 +98,146 @@ public TwitcastingClient(HttpClient httpClient, BotConfig botConfig)
             }
             catch (Exception ex)
             {
-                Log.Error($"TwitCastingClient.GetMovieInfoAsync: {ex}");
+                Log.Error(ex.Demystify(), "TwitCastingClient.GetMovieInfoAsync");
+                return null;
+            }
+        }
+
+        /// <summary>
+        /// 取得使用者資訊
+        /// </summary>
+        /// <param name="userIdOrScreenId">使用者 id 或 screen_id</param>
+        /// <returns><see cref="GetUserInfoResponse"/></returns>
+        public async Task<GetUserInfoResponse?> GetUserInfoAsync(string userIdOrScreenId)
+        {
+            if (_apiHttpClient == null)
+                throw new NullReferenceException(nameof(_apiHttpClient));
+
+            if (string.IsNullOrEmpty(userIdOrScreenId))
+                throw new ArgumentNullException(nameof(userIdOrScreenId));
+
+            try
+            {
+                var json = await _apiHttpClient.GetStringAsync($"users/{userIdOrScreenId}");
+                var data = JsonConvert.DeserializeObject<GetUserInfoResponse>(json);
+                return data;
+            }
+            catch (HttpRequestException ex) when (ex.StatusCode == System.Net.HttpStatusCode.NotFound)
+            {
+                // Not Found
+                return null;
+            }
+            catch (Exception ex)
+            {
+                Log.Error(ex.Demystify(), "TwitCastingClient.GetUserInfoAsync");
+                return null;
+            }
+        }
+
+        #region WebHook
+        /// <summary>
+        /// 取得所有已註冊的 WebHook
+        /// </summary>
+        /// <returns>返回 WebHook 列表</returns>
+        /// <exception cref="NullReferenceException"></exception>
+        public async Task<List<Webhook>?> GetAllRegistedWebHookAsync()
+        {
+            if (_apiHttpClient == null)
+                throw new NullReferenceException(nameof(_apiHttpClient));
+
+            const int pageSize = 50;
+            int offset = 0;
+            int allCount = int.MaxValue;
+            var result = new List<Webhook>();
+
+            try
+            {
+                while (result.Count < allCount)
+                {
+                    var url = $"webhooks?limit={pageSize}&offset={offset}";
+                    var jsonResponse = await _apiHttpClient.GetStringAsync(url);
+                    var data = JsonConvert.DeserializeObject<GetAllRegistedWebHookJson>(jsonResponse);
+
+                    if (data?.Webhooks == null || data.Webhooks.Count == 0)
+                        break;
+
+                    if (allCount == int.MaxValue)
+                        allCount = data.AllCount;
+
+                    result.AddRange(data.Webhooks);
+                    offset += pageSize;
+                }
+
+                return result;
+            }
+            catch (Exception ex)
+            {
+                Log.Error(ex.Demystify(), "TwitCastingClient.GetAllRegistedWebHookAsync");
+                return null;
+            }
+        }
+
+        /// <summary>
+        /// 註冊 WebHook
+        /// </summary>
+        /// <param name="channelId"></param>
+        /// <returns></returns>
+        /// <exception cref="NullReferenceException"></exception>
+        public async Task<bool?> RegisterWebHookAsync(string channelId)
+        {
+            if (_apiHttpClient == null)
+                throw new NullReferenceException(nameof(_apiHttpClient));
+
+            if (string.IsNullOrEmpty(channelId))
+                throw new NullReferenceException(nameof(channelId));
+
+            try
+            {
+                var responseMessage = await _apiHttpClient.PostAsync("webhooks", new StringContent(JsonConvert.SerializeObject(new
+                {
+                    user_id = channelId,
+                    events = _events
+                })));
+
+                responseMessage.EnsureSuccessStatusCode();
+
+                return true;
+            }
+            catch (Exception ex)
+            {
+                Log.Error(ex.Demystify(), "TwitCastingClient.RegisterWebHookAsync");
+                return null;
+            }
+        }
+
+        /// <summary>
+        /// 取消註冊 WebHook
+        /// </summary>
+        /// <param name="channelId"></param>
+        /// <returns></returns>
+        /// <exception cref="NullReferenceException"></exception>
+        public async Task<bool?> RemoveWebHookAsync(string channelId)
+        {
+            if (_apiHttpClient == null)
+                throw new NullReferenceException(nameof(_apiHttpClient));
+
+            if (string.IsNullOrEmpty(channelId))
+                throw new NullReferenceException(nameof(channelId));
+
+            try
+            {
+                var responseMessage = await _apiHttpClient.DeleteAsync($"webhooks?user_id={channelId}&events[]=livestart");
+
+                responseMessage.EnsureSuccessStatusCode();
+
+                return true;
+            }
+            catch (Exception ex)
+            {
+                Log.Error(ex.Demystify(), "TwitCastingClient.RemoveWebHookAsync");
                 return null;
             }
         }
+        #endregion
     }
 }

…ttpClients/TwitCasting/CategoriesJson.cs …ents/Twitcasting/Model/CategoriesJson.csDiscord Stream Notify Bot/HttpClients/TwitCasting/CategoriesJson.cs renamed to Discord Stream Notify Bot/HttpClients/Twitcasting/Model/CategoriesJson.cs Discord Stream Notify Bot/HttpClients/TwitCasting/CategoriesJson.cs renamed to Discord Stream Notify Bot/HttpClients/Twitcasting/Model/CategoriesJson.cs

@@ -1,4 +1,4 @@
-namespace Discord_Stream_Notify_Bot.HttpClients.TwitCasting
+namespace Discord_Stream_Notify_Bot.HttpClients.Twitcasting.Model
 {
     public class Category
     {

Discord Stream Notify Bot/HttpClients/Twitcasting/Model/GetAllRegistedWebHookJson.cs

@@ -0,0 +1,20 @@
+namespace Discord_Stream_Notify_Bot.HttpClients.Twitcasting.Model
+{
+    public class GetAllRegistedWebHookJson
+    {
+        [JsonProperty("all_count")]
+        public int AllCount { get; set; }
+
+        [JsonProperty("webhooks")]
+        public List<Webhook> Webhooks { get; set; }
+    }
+
+    public class Webhook
+    {
+        [JsonProperty("user_id")]
+        public string UserId { get; set; }
+
+        [JsonProperty("event")]
+        public string Event { get; set; }
+    }
+}

…ents/TwitCasting/GetMovieInfoResponse.cs …witcasting/Model/GetMovieInfoResponse.csDiscord Stream Notify Bot/HttpClients/TwitCasting/GetMovieInfoResponse.cs renamed to Discord Stream Notify Bot/HttpClients/Twitcasting/Model/GetMovieInfoResponse.cs Discord Stream Notify Bot/HttpClients/TwitCasting/GetMovieInfoResponse.cs renamed to Discord Stream Notify Bot/HttpClients/Twitcasting/Model/GetMovieInfoResponse.cs

@@ -1,4 +1,4 @@
-namespace Discord_Stream_Notify_Bot.HttpClients.TwitCasting
+namespace Discord_Stream_Notify_Bot.HttpClients.Twitcasting.Model
 {
     public class Broadcaster
     {

Discord Stream Notify Bot/HttpClients/Twitcasting/Model/GetUserInfoResponse.cs

@@ -0,0 +1,16 @@
+using Newtonsoft.Json;
+
+namespace Discord_Stream_Notify_Bot.HttpClients.Twitcasting.Model
+{
+    public class GetUserInfoResponse
+    {
+        [JsonProperty("user")]
+        public Broadcaster User { get; set; }
+
+        [JsonProperty("supporter_count")]
+        public int SupporterCount { get; set; }
+
+        [JsonProperty("supporting_count")]
+        public int SupportingCount { get; set; }
+    }
+}

…ients/TwitCasting/TcBackendStreamData.cs …Twitcasting/Model/TcBackendStreamData.csDiscord Stream Notify Bot/HttpClients/TwitCasting/TcBackendStreamData.cs renamed to Discord Stream Notify Bot/HttpClients/Twitcasting/Model/TcBackendStreamData.cs Discord Stream Notify Bot/HttpClients/TwitCasting/TcBackendStreamData.cs renamed to Discord Stream Notify Bot/HttpClients/Twitcasting/Model/TcBackendStreamData.cs

@@ -1,4 +1,4 @@
-namespace Discord_Stream_Notify_Bot.HttpClients.TwitCasting
+namespace Discord_Stream_Notify_Bot.HttpClients.Twitcasting.Model
 {
     public class TcBackendStreamData
     {

Discord Stream Notify Bot/Interaction/Extensions.cs

@@ -165,17 +165,17 @@ public static string GetNonApprovedChannelTitleByChannelId(this MainDbContext _,
             return channelId;
         }
 
-        public static string GetTwitCastingChannelTitleByChannelId(this MainDbContext _, string channelId)
+        public static string GetTwitCastingChannelTitleByScreenId(this MainDbContext _, string screenId)
         {
-            channelId = channelId.Trim();
+            screenId = screenId.Trim();
 
             using var db = Bot.DbService.GetDbContext();
 
             TwitcastingSpider twitcastingSpider;
-            if ((twitcastingSpider = db.TwitcastingSpider.AsNoTracking().FirstOrDefault((x) => x.ChannelId == channelId)) != null)
+            if ((twitcastingSpider = db.TwitcastingSpider.AsNoTracking().FirstOrDefault((x) => x.ScreenId == screenId)) != null)
                 return twitcastingSpider.ChannelTitle;
 
-            return channelId;
+            return screenId;
         }
 
         public static string GetTwitchUserNameByUserId(this MainDbContext _, string userId)