JonKazama-Hellion/HellionChat
1
0
Fork 0
Code Issues Pull Requests Actions Releases 28 Activity

Add message export for GDPR Art. 15 right of access

Browse Source 
The privacy story is incomplete without a way to actually hand the
data over. New Export section in the Privacy tab streams matching
messages to a Markdown, JSON or CSV file using Dalamud's file
dialog and a background thread, so the settings UI stays
responsive even when the export crawls a 150k-message archive.

MessageStore.StreamForExport returns a MessageEnumerator over
non-deleted rows filtered by ChatType list and date range, sorted
ascending. MessageExporter.ExportToFile takes that enumerator,
optionally narrows by SenderSource.TextValue substring (case-
insensitive), and writes one of three formats:

  Markdown — human-readable, day headers, [HH:mm] ChatType Sender:
  prefix per line, trailing total.

  JSON — single object with metadata (filter snapshot, exported_at,
  plugin name) and a messages array carrying id, ISO-8601 date,
  numeric and named ChatType, source/target kinds, receiver,
  content_id, sender plaintext, content plaintext.

  CSV — header line plus quoted-when-needed rows for spreadsheet
  ingestion.

Sender plaintext, channel filter, date range and format are
exposed as form fields above the Export button. Empty channel
selection means "all stored channels", a 0-day range means "no
time limit". Result count and target path are reported via
WrapperUtil notifications.
This commit is contained in:
Jon Kazama
2026-05-01 20:41:58 +02:00
parent 33cfc7effa
commit 68a6910c53
6 changed files with 534 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ChatTwo/Ui/SettingsTabs/Privacy.cs
+144
View File
@@ -1,4 +1,5 @@
using ChatTwo.Code;
using ChatTwo.Export;
using ChatTwo.Privacy;
using ChatTwo.Resources;
using ChatTwo.Util;
@@ -56,6 +57,13 @@ internal sealed class Privacy : ISettingsTab
private bool RetentionRunning;
// Export form state
private int ExportRangeDays = 30;
private string ExportSenderSubstring = string.Empty;
private readonly HashSet<ChatType> ExportSelectedChannels = [];
private ExportFormat ExportFormat = ExportFormat.Markdown;
private bool ExportRunning;
public void Draw(bool changed)
{
if (ImGui.Button(HellionStrings.Wizard_Reopen_Button))
@@ -138,6 +146,142 @@ internal sealed class Privacy : ISettingsTab
ImGui.Spacing();
DrawCleanupSection();
ImGui.Spacing();
ImGui.Separator();
ImGui.Spacing();
DrawExportSection();
}
private void DrawExportSection()
{
ImGui.TextUnformatted(HellionStrings.Export_Heading);
using (ImRaii.PushIndent(ImGui.GetStyle().IndentSpacing, false))
{
ImGuiUtil.HelpText(HellionStrings.Export_Help);
ImGui.Spacing();
if (ImGui.InputInt(HellionStrings.Export_Range_Label, ref ExportRangeDays))
ExportRangeDays = Math.Max(0, ExportRangeDays);
ImGui.InputText(HellionStrings.Export_Sender_Label, ref ExportSenderSubstring, 256);
using (var tree = ImRaii.TreeNode(HellionStrings.Export_Channels_Heading))
{
if (tree.Success)
{
using (ImRaii.PushIndent(ImGui.GetStyle().IndentSpacing, false))
{
ImGuiUtil.HelpText(HellionStrings.Export_Channels_AllOff);
foreach (var (heading, types) in Groups)
{
using var subTree = ImRaii.TreeNode($"{heading()}##export-group-{heading()}");
if (!subTree.Success)
continue;
using (ImRaii.PushIndent(ImGui.GetStyle().IndentSpacing, false))
foreach (var type in types)
{
var enabled = ExportSelectedChannels.Contains(type);
if (ImGui.Checkbox($"{type}##export-{(int)type}", ref enabled))
{
if (enabled)
ExportSelectedChannels.Add(type);
else
ExportSelectedChannels.Remove(type);
}
}
}
}
}
}
ImGui.Spacing();
ImGui.TextUnformatted(HellionStrings.Export_Format_Label);
ImGui.SameLine();
var fmt = (int)ExportFormat;
if (ImGui.RadioButton(HellionStrings.Export_Format_Markdown, ref fmt, (int)ExportFormat.Markdown))
ExportFormat = ExportFormat.Markdown;
ImGui.SameLine();
if (ImGui.RadioButton(HellionStrings.Export_Format_Json, ref fmt, (int)ExportFormat.Json))
ExportFormat = ExportFormat.Json;
ImGui.SameLine();
if (ImGui.RadioButton(HellionStrings.Export_Format_Csv, ref fmt, (int)ExportFormat.Csv))
ExportFormat = ExportFormat.Csv;
ImGui.Spacing();
using (ImRaii.Disabled(ExportRunning))
{
if (ImGui.Button(HellionStrings.Export_Button))
PromptExport();
}
if (ExportRunning)
ImGuiUtil.HelpText(HellionStrings.Export_Running);
}
}
private void PromptExport()
{
var defaultName = $"hellion-chat-export-{DateTimeOffset.Now:yyyyMMdd-HHmm}";
var ext = ExportFormat.Extension();
Plugin.FileDialogManager.SaveFileDialog(
HellionStrings.Export_Dialog_Title,
ExportFormat.Filter(),
defaultName,
ext,
(success, path) =>
{
if (!success || string.IsNullOrWhiteSpace(path))
return;
StartExport(path);
});
}
private void StartExport(string path)
{
if (ExportRunning)
return;
ExportRunning = true;
var types = ExportSelectedChannels.Count > 0
? ExportSelectedChannels.Select(t => (int)(ushort)t).ToList()
: null;
DateTimeOffset? from = ExportRangeDays > 0
? DateTimeOffset.UtcNow.AddDays(-ExportRangeDays)
: null;
var senderSubstring = string.IsNullOrWhiteSpace(ExportSenderSubstring) ? null : ExportSenderSubstring.Trim();
var format = ExportFormat;
var filterDesc = new MessageExporter.FilterDescription(types, from, null, senderSubstring);
new Thread(() =>
{
try
{
using var enumerator = Plugin.MessageManager.Store.StreamForExport(types, from, null);
var written = MessageExporter.ExportToFile(path, format, enumerator, filterDesc);
if (written > 0)
WrapperUtil.AddNotification(string.Format(HellionStrings.Export_Success, written, path), NotificationType.Success);
else
WrapperUtil.AddNotification(HellionStrings.Export_Empty, NotificationType.Info);
}
catch (Exception e)
{
Plugin.Log.Error(e, "Export failed");
WrapperUtil.AddNotification(HellionStrings.Export_Error, NotificationType.Error);
}
finally
{
ExportRunning = false;
}
}) { IsBackground = true }.Start();
}
private void DrawRetentionSection()