Rework CLI commands to be composable: pipe channels to export, remove exportguild/exportall/exportdm

Agent-Logs-Url: https://github.com/Tyrrrz/DiscordChatExporter/sessions/5f305835-64af-456e-b0b4-6163ece1e8cf

Co-authored-by: Tyrrrz <1935960+Tyrrrz@users.noreply.github.com>

DiscordChatExporter.Cli/Commands/ExportAllCommand.cs

@@ -1,156 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Threading.Tasks;
-using CliFx.Binding;
-using CliFx.Infrastructure;
-using DiscordChatExporter.Cli.Commands.Base;
-using DiscordChatExporter.Cli.Utils.Extensions;
-using DiscordChatExporter.Core.Discord.Data;
-using DiscordChatExporter.Core.Discord.Dump;
-using DiscordChatExporter.Core.Exceptions;
-using Spectre.Console;
-
-namespace DiscordChatExporter.Cli.Commands;
-
-[Command("exportall", Description = "Exports all accessible channels.")]
-public partial class ExportAllCommand : ExportCommandBase
-{
-    [CommandOption("include-dm", Description = "Include direct message channels.")]
-    public bool IncludeDirectChannels { get; set; } = true;
-
-    [CommandOption("include-guilds", Description = "Include server channels.")]
-    public bool IncludeGuildChannels { get; set; } = true;
-
-    [CommandOption("include-vc", Description = "Include voice channels.")]
-    public bool IncludeVoiceChannels { get; set; } = true;
-
-    [CommandOption(
-        "data-package",
-        Description = "Path to the personal data package (ZIP file) requested from Discord. "
-            + "If provided, only channels referenced in the dump will be exported."
-    )]
-    public string? DataPackageFilePath { get; set; }
-
-    public override async ValueTask ExecuteAsync(IConsole console)
-    {
-        await base.ExecuteAsync(console);
-
-        var cancellationToken = console.RegisterCancellationHandler();
-        var channels = new List<Channel>();
-
-        // Pull from the API
-        if (string.IsNullOrWhiteSpace(DataPackageFilePath))
-        {
-            await foreach (var guild in Discord.GetUserGuildsAsync(cancellationToken))
-            {
-                // Regular channels
-                await console.Output.WriteLineAsync(
-                    $"Fetching channels for server '{guild.Name}'..."
-                );
-
-                var fetchedChannelsCount = 0;
-                await console
-                    .CreateStatusTicker()
-                    .StartAsync(
-                        "...",
-                        async ctx =>
-                        {
-                            await foreach (
-                                var channel in Discord.GetGuildChannelsAsync(
-                                    guild.Id,
-                                    cancellationToken
-                                )
-                            )
-                            {
-                                if (channel.IsCategory)
-                                    continue;
-
-                                if (!IncludeVoiceChannels && channel.IsVoice)
-                                    continue;
-
-                                channels.Add(channel);
-
-                                ctx.Status(
-                                    Markup.Escape($"Fetched '{channel.GetHierarchicalName()}'.")
-                                );
-
-                                fetchedChannelsCount++;
-                            }
-                        }
-                    );
-
-                await console.Output.WriteLineAsync($"Fetched {fetchedChannelsCount} channel(s).");
-            }
-        }
-        // Pull from the data package
-        else
-        {
-            await console.Output.WriteLineAsync("Extracting channels...");
-
-            var dump = await DataDump.LoadAsync(DataPackageFilePath, cancellationToken);
-            var inaccessibleChannels = new List<DataDumpChannel>();
-
-            await console
-                .CreateStatusTicker()
-                .StartAsync(
-                    "...",
-                    async ctx =>
-                    {
-                        foreach (var dumpChannel in dump.Channels)
-                        {
-                            ctx.Status(
-                                Markup.Escape(
-                                    $"Fetching '{dumpChannel.Name}' ({dumpChannel.Id})..."
-                                )
-                            );
-
-                            try
-                            {
-                                var channel = await Discord.GetChannelAsync(
-                                    dumpChannel.Id,
-                                    cancellationToken
-                                );
-
-                                channels.Add(channel);
-                            }
-                            catch (DiscordChatExporterException)
-                            {
-                                inaccessibleChannels.Add(dumpChannel);
-                            }
-                        }
-                    }
-                );
-
-            await console.Output.WriteLineAsync($"Fetched {channels} channel(s).");
-
-            // Print inaccessible channels
-            if (inaccessibleChannels.Any())
-            {
-                await console.Output.WriteLineAsync();
-
-                using (console.WithForegroundColor(ConsoleColor.Red))
-                {
-                    await console.Error.WriteLineAsync(
-                        "Failed to access the following channel(s):"
-                    );
-                }
-
-                foreach (var dumpChannel in inaccessibleChannels)
-                    await console.Error.WriteLineAsync($"{dumpChannel.Name} ({dumpChannel.Id})");
-
-                await console.Error.WriteLineAsync();
-            }
-        }
-
-        // Filter out unwanted channels
-        if (!IncludeDirectChannels)
-            channels.RemoveAll(c => c.IsDirect);
-        if (!IncludeGuildChannels)
-            channels.RemoveAll(c => c.IsGuild);
-        if (!IncludeVoiceChannels)
-            channels.RemoveAll(c => c.IsVoice);
-
-        await ExportAsync(console, channels);
-    }
-}

DiscordChatExporter.Cli/Commands/ExportChannelsCommand.cs

@@ -1,5 +1,6 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
+using CliFx;
 using CliFx.Binding;
 using CliFx.Infrastructure;
 using DiscordChatExporter.Cli.Commands.Base;
@@ -17,9 +18,11 @@ public partial class ExportChannelsCommand : ExportCommandBase
         "channel",
         'c',
         Description = "Channel ID(s). "
-            + "If provided with category ID(s), all channels inside those categories will be exported."
+            + "If provided with category ID(s), all channels inside those categories will be exported. "
+            + "If not provided, channel IDs are read from standard input (one per line), "
+            + "enabling piping from the 'channels' or 'dm' commands."
     )]
-    public required IReadOnlyList<Snowflake> ChannelIds { get; set; }
+    public IReadOnlyList<Snowflake> ChannelIds { get; set; } = [];
 
     public override async ValueTask ExecuteAsync(IConsole console)
     {
@@ -27,12 +30,33 @@ public partial class ExportChannelsCommand : ExportCommandBase
 
         var cancellationToken = console.RegisterCancellationHandler();
 
+        // If no channel IDs were specified, read them from stdin
+        var channelIds = new List<Snowflake>(ChannelIds);
+        if (channelIds.Count == 0 && console.IsInputRedirected)
+        {
+            string? line;
+            while ((line = await console.Input.ReadLineAsync()) is not null)
+            {
+                line = line.Trim();
+                if (!string.IsNullOrEmpty(line))
+                    channelIds.Add(Snowflake.Parse(line));
+            }
+        }
+
+        if (channelIds.Count == 0)
+        {
+            throw new CommandException(
+                "No channel IDs provided. "
+                    + "Specify channel IDs via the '--channel' option or pipe them from the 'channels' or 'dm' commands."
+            );
+        }
+
         await console.Output.WriteLineAsync("Resolving channel(s)...");
 
         var channels = new List<Channel>();
         var channelsByGuild = new Dictionary<Snowflake, IReadOnlyList<Channel>>();
 
-        foreach (var channelId in ChannelIds)
+        foreach (var channelId in channelIds)
         {
             var channel = await Discord.GetChannelAsync(channelId, cancellationToken);
 

DiscordChatExporter.Cli/Commands/ExportDirectMessagesCommand.cs

@@ -1,27 +0,0 @@
-using System.Threading.Tasks;
-using CliFx.Binding;
-using CliFx.Infrastructure;
-using DiscordChatExporter.Cli.Commands.Base;
-using DiscordChatExporter.Core.Discord.Data;
-using DiscordChatExporter.Core.Utils.Extensions;
-
-namespace DiscordChatExporter.Cli.Commands;
-
-[Command("exportdm", Description = "Exports all direct message channels.")]
-public partial class ExportDirectMessagesCommand : ExportCommandBase
-{
-    public override async ValueTask ExecuteAsync(IConsole console)
-    {
-        await base.ExecuteAsync(console);
-
-        var cancellationToken = console.RegisterCancellationHandler();
-
-        await console.Output.WriteLineAsync("Fetching channels...");
-        var channels = await Discord.GetGuildChannelsAsync(
-            Guild.DirectMessages.Id,
-            cancellationToken
-        );
-
-        await ExportAsync(console, channels);
-    }
-}

DiscordChatExporter.Cli/Commands/ExportGuildCommand.cs

@@ -1,61 +0,0 @@
-using System.Collections.Generic;
-using System.Threading.Tasks;
-using CliFx.Binding;
-using CliFx.Infrastructure;
-using DiscordChatExporter.Cli.Commands.Base;
-using DiscordChatExporter.Cli.Utils.Extensions;
-using DiscordChatExporter.Core.Discord;
-using DiscordChatExporter.Core.Discord.Data;
-using Spectre.Console;
-
-namespace DiscordChatExporter.Cli.Commands;
-
-[Command("exportguild", Description = "Exports all channels within the specified server.")]
-public partial class ExportGuildCommand : ExportCommandBase
-{
-    [CommandOption("guild", 'g', Description = "Server ID.")]
-    public required Snowflake GuildId { get; set; }
-
-    [CommandOption("include-vc", Description = "Include voice channels.")]
-    public bool IncludeVoiceChannels { get; set; } = true;
-
-    public override async ValueTask ExecuteAsync(IConsole console)
-    {
-        await base.ExecuteAsync(console);
-
-        var cancellationToken = console.RegisterCancellationHandler();
-        var channels = new List<Channel>();
-
-        await console.Output.WriteLineAsync("Fetching channels...");
-
-        var fetchedChannelsCount = 0;
-        await console
-            .CreateStatusTicker()
-            .StartAsync(
-                "...",
-                async ctx =>
-                {
-                    await foreach (
-                        var channel in Discord.GetGuildChannelsAsync(GuildId, cancellationToken)
-                    )
-                    {
-                        if (channel.IsCategory)
-                            continue;
-
-                        if (!IncludeVoiceChannels && channel.IsVoice)
-                            continue;
-
-                        channels.Add(channel);
-
-                        ctx.Status(Markup.Escape($"Fetched '{channel.GetHierarchicalName()}'."));
-
-                        fetchedChannelsCount++;
-                    }
-                }
-            );
-
-        await console.Output.WriteLineAsync($"Fetched {fetchedChannelsCount} channel(s).");
-
-        await ExportAsync(console, channels);
-    }
-}

DiscordChatExporter.Cli/Commands/GetChannelsCommand.cs

@@ -60,54 +60,68 @@ public partial class GetChannelsCommand : DiscordCommandBase
                     .ToArray()
                 : [];
 
-        foreach (var channel in channels)
+        // If output is redirected, print only channel IDs (one per line) for easy piping
+        if (console.IsOutputRedirected)
         {
-            // Channel ID
-            await console.Output.WriteAsync(
-                channel.Id.ToString().PadRight(channelIdMaxLength, ' ')
-            );
-
-            // Separator
-            using (console.WithForegroundColor(ConsoleColor.DarkGray))
-                await console.Output.WriteAsync(" | ");
-
-            // Channel name
-            using (console.WithForegroundColor(ConsoleColor.White))
-                await console.Output.WriteLineAsync(channel.GetHierarchicalName());
-
-            var channelThreads = threads.Where(t => t.Parent?.Id == channel.Id).ToArray();
-            var channelThreadIdMaxLength = channelThreads
-                .Select(t => t.Id.ToString().Length)
-                .OrderDescending()
-                .FirstOrDefault();
-
-            foreach (var channelThread in channelThreads)
+            foreach (var channel in channels)
             {
-                // Indent
-                await console.Output.WriteAsync(" * ");
+                await console.Output.WriteLineAsync(channel.Id.ToString());
 
-                // Thread ID
+                foreach (var channelThread in threads.Where(t => t.Parent?.Id == channel.Id))
+                    await console.Output.WriteLineAsync(channelThread.Id.ToString());
+            }
+        }
+        else
+        {
+            foreach (var channel in channels)
+            {
+                // Channel ID
                 await console.Output.WriteAsync(
-                    channelThread.Id.ToString().PadRight(channelThreadIdMaxLength, ' ')
+                    channel.Id.ToString().PadRight(channelIdMaxLength, ' ')
                 );
 
                 // Separator
                 using (console.WithForegroundColor(ConsoleColor.DarkGray))
                     await console.Output.WriteAsync(" | ");
 
-                // Thread name
+                // Channel name
                 using (console.WithForegroundColor(ConsoleColor.White))
-                    await console.Output.WriteAsync($"Thread / {channelThread.Name}");
+                    await console.Output.WriteLineAsync(channel.GetHierarchicalName());
 
-                // Separator
-                using (console.WithForegroundColor(ConsoleColor.DarkGray))
-                    await console.Output.WriteAsync(" | ");
+                var channelThreads = threads.Where(t => t.Parent?.Id == channel.Id).ToArray();
+                var channelThreadIdMaxLength = channelThreads
+                    .Select(t => t.Id.ToString().Length)
+                    .OrderDescending()
+                    .FirstOrDefault();
 
-                // Thread status
-                using (console.WithForegroundColor(ConsoleColor.White))
-                    await console.Output.WriteLineAsync(
-                        channelThread.IsArchived ? "Archived" : "Active"
+                foreach (var channelThread in channelThreads)
+                {
+                    // Indent
+                    await console.Output.WriteAsync(" * ");
+
+                    // Thread ID
+                    await console.Output.WriteAsync(
+                        channelThread.Id.ToString().PadRight(channelThreadIdMaxLength, ' ')
                     );
+
+                    // Separator
+                    using (console.WithForegroundColor(ConsoleColor.DarkGray))
+                        await console.Output.WriteAsync(" | ");
+
+                    // Thread name
+                    using (console.WithForegroundColor(ConsoleColor.White))
+                        await console.Output.WriteAsync($"Thread / {channelThread.Name}");
+
+                    // Separator
+                    using (console.WithForegroundColor(ConsoleColor.DarkGray))
+                        await console.Output.WriteAsync(" | ");
+
+                    // Thread status
+                    using (console.WithForegroundColor(ConsoleColor.White))
+                        await console.Output.WriteLineAsync(
+                            channelThread.IsArchived ? "Archived" : "Active"
+                        );
+                }
             }
         }
     }

DiscordChatExporter.Cli/Commands/GetDirectChannelsCommand.cs

@@ -30,20 +30,29 @@ public partial class GetDirectChannelsCommand : DiscordCommandBase
             .OrderDescending()
             .FirstOrDefault();
 
-        foreach (var channel in channels)
+        // If output is redirected, print only channel IDs (one per line) for easy piping
+        if (console.IsOutputRedirected)
         {
-            // Channel ID
-            await console.Output.WriteAsync(
-                channel.Id.ToString().PadRight(channelIdMaxLength, ' ')
-            );
+            foreach (var channel in channels)
+                await console.Output.WriteLineAsync(channel.Id.ToString());
+        }
+        else
+        {
+            foreach (var channel in channels)
+            {
+                // Channel ID
+                await console.Output.WriteAsync(
+                    channel.Id.ToString().PadRight(channelIdMaxLength, ' ')
+                );
 
-            // Separator
-            using (console.WithForegroundColor(ConsoleColor.DarkGray))
-                await console.Output.WriteAsync(" | ");
+                // Separator
+                using (console.WithForegroundColor(ConsoleColor.DarkGray))
+                    await console.Output.WriteAsync(" | ");
 
-            // Channel name
-            using (console.WithForegroundColor(ConsoleColor.White))
-                await console.Output.WriteLineAsync(channel.GetHierarchicalName());
+                // Channel name
+                using (console.WithForegroundColor(ConsoleColor.White))
+                    await console.Output.WriteLineAsync(channel.GetHierarchicalName());
+            }
         }
     }
 }