aboutsummaryrefslogtreecommitdiffstats
path: root/src/calendarwriter.h
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-09-24 16:36:25 +0200
committerDanilo M. <danix@danix.xyz>2026-09-24 16:36:25 +0200
commit4818cf555141d83b0d8414c86c3b7aef26286dd3 (patch)
treea0aa97b38841c00634a46313b994fdb6b475755a /src/calendarwriter.h
parent1d46fbbe97cd890da984596fa2076d3f83b1c663 (diff)
downloadqtmaildir-4818cf555141d83b0d8414c86c3b7aef26286dd3.tar.gz
qtmaildir-4818cf555141d83b0d8414c86c3b7aef26286dd3.zip
feat: write calendar files atomically, refusing stale ones
Diffstat (limited to 'src/calendarwriter.h')
-rw-r--r--src/calendarwriter.h43
1 files changed, 43 insertions, 0 deletions
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