Update version

.gitignore

@@ -4,6 +4,7 @@
 *.userosscache
 *.sln.docstates
 .idea/
+.vs/
 
 # Build results
 [Dd]ebug/

Changelog.md

@@ -1,3 +1,8 @@
+### v2.26.1 (06-Feb-2021)
+
+- [CLI] Added support for file name templates, which allow you to dynamically generate output file names based on channel and guild metadata. (Thanks [@Lucas LaBuff](https://github.com/96-LB))
+- Fixed an issue where the application sometimes crashed with `Invalid snowflake` message when exporting chat logs that contained invalid or outdated mentions. (Thanks [@Lucas LaBuff](https://github.com/96-LB))
+
 ### v2.26 (29-Dec-2020)
 
 - [HTML] Added support for replies. (Thanks [@Sanqui](https://github.com/Sanqui))

Directory.Build.props

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netcoreapp3.1</TargetFramework>
-    <Version>2.26</Version>
+    <Version>2.26.1</Version>
     <Company>Tyrrrz</Company>
     <Copyright>Copyright (c) Alexey Golub</Copyright>
     <LangVersion>preview</LangVersion>

DiscordChatExporter.Cli/Commands/GetChannelsCommand.cs

@@ -4,6 +4,7 @@ using CliFx;
 using CliFx.Attributes;
 using DiscordChatExporter.Cli.Commands.Base;
 using DiscordChatExporter.Domain.Discord;
+using DiscordChatExporter.Domain.Discord.Models.Common;
 using DiscordChatExporter.Domain.Utilities;
 
 namespace DiscordChatExporter.Cli.Commands
@@ -18,7 +19,7 @@ namespace DiscordChatExporter.Cli.Commands
         {
             var channels = await GetDiscordClient().GetGuildChannelsAsync(GuildId);
 
-            foreach (var channel in channels.OrderBy(c => c.Category).ThenBy(c => c.Name))
+            foreach (var channel in channels.OrderBy(c => c.Category, PositionBasedComparer.Instance).ThenBy(c => c.Name))
                 console.Output.WriteLine($"{channel.Id} | {channel.Category} / {channel.Name}");
         }
     }

DiscordChatExporter.Cli/Commands/GetDirectMessageChannelsCommand.cs

@@ -4,6 +4,7 @@ using CliFx;
 using CliFx.Attributes;
 using DiscordChatExporter.Cli.Commands.Base;
 using DiscordChatExporter.Domain.Discord.Models;
+using DiscordChatExporter.Domain.Discord.Models.Common;
 using DiscordChatExporter.Domain.Utilities;
 
 namespace DiscordChatExporter.Cli.Commands
@@ -15,7 +16,7 @@ namespace DiscordChatExporter.Cli.Commands
         {
             var channels = await GetDiscordClient().GetGuildChannelsAsync(Guild.DirectMessages.Id);
 
-            foreach (var channel in channels.OrderBy(c => c.Category).ThenBy(c => c.Name))
+            foreach (var channel in channels.OrderBy(c => c.Name))
                 console.Output.WriteLine($"{channel.Id} | {channel.Category} / {channel.Name}");
         }
     }

DiscordChatExporter.Domain/Discord/DiscordClient.cs

@@ -117,26 +117,33 @@ namespace DiscordChatExporter.Domain.Discord
             {
                 var response = await GetJsonResponseAsync($"guilds/{guildId}/channels");
 
-                var categories = response
+                var orderedResponse = response
                     .EnumerateArray()
-                    .ToDictionary(
-                        j => j.GetProperty("id").GetString(),
-                        j => j.GetProperty("name").GetString()
-                    );
+                    .OrderBy(j => j.GetProperty("position").GetInt32())
+                    .ThenBy(j => ulong.Parse(j.GetProperty("id").GetString()));
 
-                foreach (var channelJson in response.EnumerateArray())
+                var categories = orderedResponse
+                    .Where(j => j.GetProperty("type").GetInt32() == (int)ChannelType.GuildCategory)
+                    .Select((j, index) => ChannelCategory.Parse(j, index + 1))
+                    .ToDictionary(j => j.Id.ToString());
+
+                var position = 0;
+
+                foreach (var channelJson in orderedResponse)
                 {
                     var parentId = channelJson.GetPropertyOrNull("parent_id")?.GetString();
                     var category = !string.IsNullOrWhiteSpace(parentId)
                         ? categories.GetValueOrDefault(parentId)
                         : null;
-
-                    var channel = Channel.Parse(channelJson, category);
+                    
+                    var channel = Channel.Parse(channelJson, category, position);
 
                     // Skip non-text channels
                     if (!channel.IsTextChannel)
                         continue;
 
+                    position++;
+
                     yield return channel;
                 }
             }
@@ -162,10 +169,22 @@ namespace DiscordChatExporter.Domain.Discord
             return response?.Pipe(Member.Parse);
         }
 
-        private async ValueTask<string> GetChannelCategoryAsync(Snowflake channelParentId)
+        public async ValueTask<ChannelCategory> GetChannelCategoryAsync(Snowflake channelId)
         {
-            var response = await GetJsonResponseAsync($"channels/{channelParentId}");
-            return response.GetProperty("name").GetString();
+            try
+            {
+                var response = await GetJsonResponseAsync($"channels/{channelId}");
+                return ChannelCategory.Parse(response);
+            }
+            /***
+             * In some cases, the Discord API returns an empty body when requesting some channel category info.
+             * Instead, we use an empty channel category as a fallback.
+             */
+            catch (DiscordChatExporterException)
+            {
+                return ChannelCategory.Empty;
+            }
+
         }
 
         public async ValueTask<Channel> GetChannelAsync(Snowflake channelId)

DiscordChatExporter.Domain/Discord/Models/Channel.cs

@@ -1,4 +1,5 @@
-using System.Linq;
+using System;
+using System.Linq;
 using System.Text.Json;
 using DiscordChatExporter.Domain.Discord.Models.Common;
 using DiscordChatExporter.Domain.Utilities;
@@ -21,7 +22,7 @@ namespace DiscordChatExporter.Domain.Discord.Models
     }
 
     // https://discord.com/developers/docs/resources/channel#channel-object
-    public partial class Channel : IHasId
+    public partial class Channel : IHasIdAndPosition
     {
         public Snowflake Id { get; }
 
@@ -36,56 +37,67 @@ namespace DiscordChatExporter.Domain.Discord.Models
 
         public Snowflake GuildId { get; }
 
-        public string Category { get; }
+        public ChannelCategory Category { get; }
 
         public string Name { get; }
 
+        public int? Position { get; }
+
         public string? Topic { get; }
 
-        public Channel(Snowflake id, ChannelType type, Snowflake guildId, string category, string name, string? topic)
+        public Channel(Snowflake id, ChannelType type, Snowflake guildId, ChannelCategory? category, string name, int? position, string? topic)
         {
             Id = id;
             Type = type;
             GuildId = guildId;
-            Category = category;
+            Category = category ?? GetDefaultCategory(type);
             Name = name;
+            Position = position;
             Topic = topic;
         }
 
         public override string ToString() => Name;
+
     }
 
     public partial class Channel
     {
-        private static string GetDefaultCategory(ChannelType channelType) => channelType switch
-        {
-            ChannelType.GuildTextChat => "Text",
-            ChannelType.DirectTextChat => "Private",
-            ChannelType.DirectGroupTextChat => "Group",
-            ChannelType.GuildNews => "News",
-            ChannelType.GuildStore => "Store",
-            _ => "Default"
-        };
+        private static ChannelCategory GetDefaultCategory(ChannelType channelType) => new(
+                Snowflake.Zero,
+                channelType switch
+                {
+                    ChannelType.GuildTextChat => "Text",
+                    ChannelType.DirectTextChat => "Private",
+                    ChannelType.DirectGroupTextChat => "Group",
+                    ChannelType.GuildNews => "News",
+                    ChannelType.GuildStore => "Store",
+                    _ => "Default"
+                },
+                0
+            );
 
-        public static Channel Parse(JsonElement json, string? category = null)
+        public static Channel Parse(JsonElement json, ChannelCategory? category = null, int? position = null)
         {
             var id = json.GetProperty("id").GetString().Pipe(Snowflake.Parse);
             var guildId = json.GetPropertyOrNull("guild_id")?.GetString().Pipe(Snowflake.Parse);
             var topic = json.GetPropertyOrNull("topic")?.GetString();
 
-            var type = (ChannelType) json.GetProperty("type").GetInt32();
+            var type = (ChannelType)json.GetProperty("type").GetInt32();
 
             var name =
                 json.GetPropertyOrNull("name")?.GetString() ??
                 json.GetPropertyOrNull("recipients")?.EnumerateArray().Select(User.Parse).Select(u => u.Name).JoinToString(", ") ??
                 id.ToString();
 
+            position ??= json.GetPropertyOrNull("position")?.GetInt32();
+
             return new Channel(
                 id,
                 type,
                 guildId ?? Guild.DirectMessages.Id,
                 category ?? GetDefaultCategory(type),
                 name,
+                position,
                 topic
             );
         }

DiscordChatExporter.Domain/Discord/Models/ChannelCategory.cs

@@ -0,0 +1,50 @@
+using System;
+using System.Linq;
+using System.Text.Json;
+using DiscordChatExporter.Domain.Discord.Models.Common;
+using DiscordChatExporter.Domain.Utilities;
+using JsonExtensions.Reading;
+using Tyrrrz.Extensions;
+
+namespace DiscordChatExporter.Domain.Discord.Models
+{
+    public partial class ChannelCategory : IHasIdAndPosition
+    {
+        public Snowflake Id { get; }
+
+        public string Name { get; }
+
+        public int? Position { get; }
+
+        public ChannelCategory(Snowflake id, string name, int? position)
+        {
+            Id = id;
+            Name = name;
+            Position = position;
+        }
+
+        public override string ToString() => Name;
+
+    }
+
+    public partial class ChannelCategory
+    {
+        public static ChannelCategory Parse(JsonElement json, int? position = null)
+        {
+            var id = json.GetProperty("id").GetString().Pipe(Snowflake.Parse);
+            position ??= json.GetPropertyOrNull("position")?.GetInt32();
+
+            var name = json.GetPropertyOrNull("name")?.GetString() ??
+                json.GetPropertyOrNull("recipients")?.EnumerateArray().Select(User.Parse).Select(u => u.Name).JoinToString(", ") ??
+                id.ToString();
+
+            return new ChannelCategory(
+                id,
+                name,
+                position
+            );
+        }
+
+        public static ChannelCategory Empty { get; } = new(Snowflake.Zero, "Missing", 0);
+    }
+}

DiscordChatExporter.Domain/Discord/Models/Common/IHasIdAndPosition.cs

@@ -0,0 +1,7 @@
+namespace DiscordChatExporter.Domain.Discord.Models.Common
+{
+    public interface IHasIdAndPosition : IHasId
+    {
+        int? Position { get; }
+    }
+}

DiscordChatExporter.Domain/Discord/Models/Common/PositionBasedComparer.cs

@@ -0,0 +1,22 @@
+using System.Collections.Generic;
+
+namespace DiscordChatExporter.Domain.Discord.Models.Common
+{
+    public partial class PositionBasedComparer : IComparer<IHasIdAndPosition>
+    {
+        public int Compare(IHasIdAndPosition? x, IHasIdAndPosition? y)
+        {
+            int result = Comparer<int?>.Default.Compare(x?.Position, y?.Position);
+            if (result == 0)
+            {
+                result = Comparer<ulong?>.Default.Compare(x?.Id.Value, y?.Id.Value);
+            }
+            return result;
+        }
+    }
+
+    public partial class PositionBasedComparer
+    {
+        public static PositionBasedComparer Instance { get; } = new();
+    }
+}

DiscordChatExporter.Domain/Exporting/ExportRequest.cs

@@ -1,5 +1,7 @@
-using System.IO;
+using System;
+using System.IO;
 using System.Text;
+using System.Text.RegularExpressions;
 using DiscordChatExporter.Domain.Discord;
 using DiscordChatExporter.Domain.Discord.Models;
 using DiscordChatExporter.Domain.Internal;
@@ -81,6 +83,26 @@ namespace DiscordChatExporter.Domain.Exporting
             Snowflake? after = null,
             Snowflake? before = null)
         {
+
+            // Formats path
+            outputPath = Regex.Replace(outputPath, "%.", m =>
+                PathEx.EscapePath(m.Value switch
+                {
+                    "%g" => guild.Id.ToString(),
+                    "%G" => guild.Name,
+                    "%t" => channel.Category.Id.ToString(),
+                    "%T" => channel.Category.Name,
+                    "%c" => channel.Id.ToString(),
+                    "%C" => channel.Name,
+                    "%p" => channel.Position?.ToString() ?? "0",
+                    "%P" => channel.Category.Position?.ToString() ?? "0",
+                    "%a" => (after ?? Snowflake.Zero).ToDate().ToString("yyyy-MM-dd"),
+                    "%b" => (before?.ToDate() ?? DateTime.Now).ToString("yyyy-MM-dd"),
+                    "%%" => "%",
+                    _ => m.Value
+                })
+            );
+
             // Output is a directory
             if (Directory.Exists(outputPath) || string.IsNullOrWhiteSpace(Path.GetExtension(outputPath)))
             {
@@ -102,7 +124,7 @@ namespace DiscordChatExporter.Domain.Exporting
             var buffer = new StringBuilder();
 
             // Guild and channel names
-            buffer.Append($"{guild.Name} - {channel.Category} - {channel.Name} [{channel.Id}]");
+            buffer.Append($"{guild.Name} - {channel.Category.Name} - {channel.Name} [{channel.Id}]");
 
             // Date range
             if (after != null || before != null)

DiscordChatExporter.Domain/Exporting/Writers/JsonMessageWriter.cs

@@ -192,7 +192,7 @@ namespace DiscordChatExporter.Domain.Exporting.Writers
             _writer.WriteStartObject("channel");
             _writer.WriteString("id", Context.Request.Channel.Id.ToString());
             _writer.WriteString("type", Context.Request.Channel.Type.ToString());
-            _writer.WriteString("category", Context.Request.Channel.Category);
+            _writer.WriteString("category", Context.Request.Channel.Category.Name);
             _writer.WriteString("name", Context.Request.Channel.Name);
             _writer.WriteString("topic", Context.Request.Channel.Topic);
             _writer.WriteEndObject();

DiscordChatExporter.Domain/Exporting/Writers/MarkdownVisitors/HtmlMarkdownVisitor.cs

@@ -7,6 +7,7 @@ using DiscordChatExporter.Domain.Discord;
 using DiscordChatExporter.Domain.Discord.Models;
 using DiscordChatExporter.Domain.Markdown;
 using DiscordChatExporter.Domain.Markdown.Ast;
+using DiscordChatExporter.Domain.Utilities;
 
 namespace DiscordChatExporter.Domain.Exporting.Writers.MarkdownVisitors
 {
@@ -76,6 +77,7 @@ namespace DiscordChatExporter.Domain.Exporting.Writers.MarkdownVisitors
 
         protected override MarkdownNode VisitMention(MentionNode mention)
         {
+            var mentionId = Snowflake.TryParse(mention.Id);
             if (mention.Type == MentionType.Meta)
             {
                 _buffer
@@ -85,7 +87,7 @@ namespace DiscordChatExporter.Domain.Exporting.Writers.MarkdownVisitors
             }
             else if (mention.Type == MentionType.User)
             {
-                var member = _context.TryGetMember(Snowflake.Parse(mention.Id));
+                var member = mentionId?.Pipe(_context.TryGetMember);
                 var fullName = member?.User.FullName ?? "Unknown";
                 var nick = member?.Nick ?? "Unknown";
 
@@ -96,7 +98,7 @@ namespace DiscordChatExporter.Domain.Exporting.Writers.MarkdownVisitors
             }
             else if (mention.Type == MentionType.Channel)
             {
-                var channel = _context.TryGetChannel(Snowflake.Parse(mention.Id));
+                var channel = mentionId?.Pipe(_context.TryGetChannel);
                 var name = channel?.Name ?? "deleted-channel";
 
                 _buffer
@@ -106,7 +108,7 @@ namespace DiscordChatExporter.Domain.Exporting.Writers.MarkdownVisitors
             }
             else if (mention.Type == MentionType.Role)
             {
-                var role = _context.TryGetRole(Snowflake.Parse(mention.Id));
+                var role = mentionId?.Pipe(_context.TryGetRole);
                 var name = role?.Name ?? "deleted-role";
                 var color = role?.Color;
 

DiscordChatExporter.Domain/Exporting/Writers/MarkdownVisitors/PlainTextMarkdownVisitor.cs

@@ -2,6 +2,7 @@
 using DiscordChatExporter.Domain.Discord;
 using DiscordChatExporter.Domain.Markdown;
 using DiscordChatExporter.Domain.Markdown.Ast;
+using DiscordChatExporter.Domain.Utilities;
 
 namespace DiscordChatExporter.Domain.Exporting.Writers.MarkdownVisitors
 {
@@ -24,27 +25,28 @@ namespace DiscordChatExporter.Domain.Exporting.Writers.MarkdownVisitors
 
         protected override MarkdownNode VisitMention(MentionNode mention)
         {
+            var mentionId = Snowflake.TryParse(mention.Id);
             if (mention.Type == MentionType.Meta)
             {
                 _buffer.Append($"@{mention.Id}");
             }
             else if (mention.Type == MentionType.User)
             {
-                var member = _context.TryGetMember(Snowflake.Parse(mention.Id));
+                var member = mentionId?.Pipe(_context.TryGetMember);
                 var name = member?.User.Name ?? "Unknown";
 
                 _buffer.Append($"@{name}");
             }
             else if (mention.Type == MentionType.Channel)
             {
-                var channel = _context.TryGetChannel(Snowflake.Parse(mention.Id));
+                var channel = mentionId?.Pipe(_context.TryGetChannel);
                 var name = channel?.Name ?? "deleted-channel";
 
                 _buffer.Append($"#{name}");
             }
             else if (mention.Type == MentionType.Role)
             {
-                var role = _context.TryGetRole(Snowflake.Parse(mention.Id));
+                var role = mentionId?.Pipe(_context.TryGetRole);
                 var name = role?.Name ?? "deleted-role";
 
                 _buffer.Append($"@{name}");

DiscordChatExporter.Domain/Exporting/Writers/PlainTextMessageWriter.cs

@@ -113,7 +113,7 @@ namespace DiscordChatExporter.Domain.Exporting.Writers
         {
             await _writer.WriteLineAsync('='.Repeat(62));
             await _writer.WriteLineAsync($"Guild: {Context.Request.Guild.Name}");
-            await _writer.WriteLineAsync($"Channel: {Context.Request.Channel.Category} / {Context.Request.Channel.Name}");
+            await _writer.WriteLineAsync($"Channel: {Context.Request.Channel.Category.Name} / {Context.Request.Channel.Name}");
 
             if (!string.IsNullOrWhiteSpace(Context.Request.Channel.Topic))
                 await _writer.WriteLineAsync($"Topic: {Context.Request.Channel.Topic}");

DiscordChatExporter.Gui/Views/RootView.xaml

@@ -27,10 +27,10 @@
     <Window.Resources>
         <CollectionViewSource x:Key="AvailableChannelsViewSource" Source="{Binding AvailableChannels, Mode=OneWay}">
             <CollectionViewSource.GroupDescriptions>
-                <PropertyGroupDescription PropertyName="Category" />
+                <PropertyGroupDescription PropertyName="Category.Name" />
             </CollectionViewSource.GroupDescriptions>
             <CollectionViewSource.SortDescriptions>
-                <componentModel:SortDescription Direction="Ascending" PropertyName="Category" />
+                <componentModel:SortDescription Direction="Ascending" PropertyName="Position" />
                 <componentModel:SortDescription Direction="Ascending" PropertyName="Name" />
             </CollectionViewSource.SortDescriptions>
         </CollectionViewSource>

License.txt

@@ -1,5 +1,5 @@
  DiscordChatExporter
- Copyright (C) 2017-2020 Alexey Golub
+ Copyright (C) 2017-2021 Alexey Golub
 
  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by