feat: write calendar files atomically, refusing stale ones

5 files changed, 233 insertions, 0 deletions

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 8af8374..e70039e 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -46,6 +46,7 @@ add_library(qtmaildir_lib STATIC
     signatures.cpp
     repeatrule.cpp
     calendarstore.cpp
+    calendarwriter.cpp
 )
 
 target_include_directories(qtmaildir_lib
diff --git a/src/calendarwriter.cpp b/src/calendarwriter.cpp
new file mode 100644
index 0000000..4c81a37
--- /dev/null
+++ b/src/calendarwriter.cpp
@@ -0,0 +1,64 @@
+/*
+ * qtmaildir - a Qt6 mail client for notmuch-indexed Maildirs
+ * Copyright (C) 2026 Danilo M. <danix@danix.xyz>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include "calendarwriter.h"
+
+#include <QFile>
+#include <QFileInfo>
+#include <QSaveFile>
+
+namespace CalendarWriter {
+
+Result replace(const QString &path, const std::optional<QByteArray> &expected,
+               const std::optional<QByteArray> &newText, QString *error)
+{
+    QFile current(path);
+    const bool exists = current.exists();
+    if (expected.has_value() != exists)
+        return Result::Stale;
+    if (exists) {
+        if (!current.open(QIODevice::ReadOnly)) {
+            *error = current.errorString();
+            return Result::IoError;
+        }
+        if (current.readAll() != *expected)
+            return Result::Stale;
+        current.close();
+    }
+
+    if (!newText) {
+        if (!QFile::remove(path)) {
+            *error = QFile(path).errorString();
+            return Result::IoError;
+        }
+        return Result::Ok;
+    }
+
+    // QSaveFile is the platform's atomic write: a temporary in the same
+    // directory, renamed on commit(). Its temporary is named "<name>.XXXXXX",
+    // which does not end in .ics, so vdirsyncer never lists it.
+    QSaveFile file(path);
+    if (!file.open(QIODevice::WriteOnly) || file.write(*newText) != newText->size()
+        || !file.commit()) {
+        *error = file.errorString();
+        return Result::IoError;
+    }
+    return Result::Ok;
+}
+
+}  // namespace CalendarWriter
diff --git a/src/calendarwriter.h b/src/calendarwriter.h
new file mode 100644
index 0000000..0bcca09
--- /dev/null
+++ b/src/calendarwriter.h
@@ -0,0 +1,43 @@
+/*
+ * qtmaildir - a Qt6 mail client for notmuch-indexed Maildirs
+ * Copyright (C) 2026 Danilo M. <danix@danix.xyz>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#pragma once
+
+#include <QByteArray>
+#include <QString>
+
+#include <optional>
+
+/// Every write to the calendar vdir goes through here.
+///
+/// One function covers create, edit, delete and every undo of those, because
+/// each is the same act: the file must currently be X, and must become Y,
+/// where either may be "absent". vdirsyncer writes the same files from cron,
+/// so "must currently be X" is the stale check that stops a save from
+/// silently discarding what a sync just pulled.
+namespace CalendarWriter {
+
+enum class Result { Ok, Stale, IoError };
+
+/// `expected` nullopt: the file must not exist. `newText` nullopt: delete it.
+/// A write goes to a hidden temporary in the same directory and is renamed
+/// into place, so vdirsyncer, which lists only *.ics, never reads half a file.
+Result replace(const QString &path, const std::optional<QByteArray> &expected,
+               const std::optional<QByteArray> &newText, QString *error);
+
+}  // namespace CalendarWriter
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
index 6df7112..6be4a22 100644
--- a/tests/CMakeLists.txt
+++ b/tests/CMakeLists.txt
@@ -74,6 +74,7 @@ target_compile_definitions(test_contactstore PRIVATE
     FIXTURE_DIR="${CMAKE_CURRENT_SOURCE_DIR}/fixtures")
 add_qtmaildir_test(repeatrule)
 add_qtmaildir_test(calendarstore)
+add_qtmaildir_test(calendarwriter)
 add_qtmaildir_test(signatures)
 add_qtmaildir_test(busyindicator)
 add_qtmaildir_test(tagstrip)
diff --git a/tests/test_calendarwriter.cpp b/tests/test_calendarwriter.cpp
new file mode 100644
index 0000000..1989d0e
--- /dev/null
+++ b/tests/test_calendarwriter.cpp
@@ -0,0 +1,124 @@
+/*
+ * qtmaildir - a Qt6 mail client for notmuch-indexed Maildirs
+ * Copyright (C) 2026 Danilo M. <danix@danix.xyz>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include <QtTest>
+#include <QDir>
+#include <QFile>
+#include <QTemporaryDir>
+
+#include "calendarwriter.h"
+
+namespace {
+
+QByteArray read(const QString &path)
+{
+    QFile f(path);
+    return f.open(QIODevice::ReadOnly) ? f.readAll() : QByteArray();
+}
+
+} // namespace
+
+class TestCalendarWriter : public QObject
+{
+    Q_OBJECT
+
+private slots:
+    void createsAFileThatDidNotExist();
+    void refusesToCreateOverAnExistingFile();
+    void replacesWhenTheFileIsWhatWasExpected();
+    void refusesWhenTheFileChangedUnderneath();
+    void deletes();
+    void leavesNoTemporaryFileBehind();
+};
+
+void TestCalendarWriter::createsAFileThatDidNotExist()
+{
+    QTemporaryDir dir;
+    const QString path = dir.filePath(QStringLiteral("a.ics"));
+    QString error;
+    QCOMPARE(CalendarWriter::replace(path, std::nullopt, QByteArray("new"), &error),
+             CalendarWriter::Result::Ok);
+    QCOMPARE(read(path), QByteArray("new"));
+}
+
+void TestCalendarWriter::refusesToCreateOverAnExistingFile()
+{
+    QTemporaryDir dir;
+    const QString path = dir.filePath(QStringLiteral("a.ics"));
+    QFile f(path);
+    QVERIFY(f.open(QIODevice::WriteOnly));
+    f.write("synced in meanwhile");
+    f.close();
+    QString error;
+    QCOMPARE(CalendarWriter::replace(path, std::nullopt, QByteArray("new"), &error),
+             CalendarWriter::Result::Stale);
+    QCOMPARE(read(path), QByteArray("synced in meanwhile"));
+}
+
+void TestCalendarWriter::replacesWhenTheFileIsWhatWasExpected()
+{
+    QTemporaryDir dir;
+    const QString path = dir.filePath(QStringLiteral("a.ics"));
+    QString error;
+    CalendarWriter::replace(path, std::nullopt, QByteArray("one"), &error);
+    QCOMPARE(CalendarWriter::replace(path, QByteArray("one"), QByteArray("two"), &error),
+             CalendarWriter::Result::Ok);
+    QCOMPARE(read(path), QByteArray("two"));
+}
+
+void TestCalendarWriter::refusesWhenTheFileChangedUnderneath()
+{
+    QTemporaryDir dir;
+    const QString path = dir.filePath(QStringLiteral("a.ics"));
+    QString error;
+    CalendarWriter::replace(path, std::nullopt, QByteArray("synced"), &error);
+    // The caller loaded "one"; a sync wrote "synced" since. Nothing is clobbered.
+    QCOMPARE(CalendarWriter::replace(path, QByteArray("one"), QByteArray("two"), &error),
+             CalendarWriter::Result::Stale);
+    QCOMPARE(read(path), QByteArray("synced"));
+    // Also stale: expecting a file that a sync has removed.
+    QFile::remove(path);
+    QCOMPARE(CalendarWriter::replace(path, QByteArray("synced"), QByteArray("two"), &error),
+             CalendarWriter::Result::Stale);
+    QVERIFY(!QFile::exists(path));
+}
+
+void TestCalendarWriter::deletes()
+{
+    QTemporaryDir dir;
+    const QString path = dir.filePath(QStringLiteral("a.ics"));
+    QString error;
+    CalendarWriter::replace(path, std::nullopt, QByteArray("one"), &error);
+    QCOMPARE(CalendarWriter::replace(path, QByteArray("one"), std::nullopt, &error),
+             CalendarWriter::Result::Ok);
+    QVERIFY(!QFile::exists(path));
+}
+
+void TestCalendarWriter::leavesNoTemporaryFileBehind()
+{
+    QTemporaryDir dir;
+    const QString path = dir.filePath(QStringLiteral("a.ics"));
+    QString error;
+    CalendarWriter::replace(path, std::nullopt, QByteArray("one"), &error);
+    CalendarWriter::replace(path, QByteArray("one"), QByteArray("two"), &error);
+    QCOMPARE(QDir(dir.path()).entryList(QDir::Files | QDir::Hidden),
+             QStringList{ QStringLiteral("a.ics") });
+}
+
+QTEST_MAIN(TestCalendarWriter)
+#include "test_calendarwriter.moc"