gpgidgeneration.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Anne Jan Brouwer
// SPDX-License-Identifier: GPL-3.0-or-later
#ifndef SRC_GPGIDGENERATION_H_
#define SRC_GPGIDGENERATION_H_
 
#include <QByteArray>
#include <QString>
#include <optional>

class GpgIdGeneration {
public:
  static const QByteArray kGenerationPrefix;
  static const QByteArray kFolderPrefix;
  static const QByteArray kStorePrefix;
  static const qint64 kMaxGeneration;

  struct Header {
    qint64 generation = 0;
    std::optional<QString> folder;
    std::optional<QString> store;
  };

  static auto parse(const QByteArray &contents, QString *error = nullptr)
      -> std::optional<Header>;

  static auto header(qint64 generation, const QString &folder,
                     const QString &store = {}) -> QByteArray;

  static auto withHeader(qint64 generation, const QString &folder,
                         const QByteArray &recipients,
                         const QString &store = {}) -> QByteArray;

  static auto storeIdFor(const QString &storeRoot,
                         const std::optional<QString> &onDisk,
                         QString *error = nullptr) -> std::optional<QString>;

  static auto folderOf(const QString &gpgIdFile, const QString &storeRoot)
      -> std::optional<QString>;

  static auto remembered(const QString &gpgIdFile, QString *error = nullptr)
      -> std::optional<qint64>;

  enum class Verdict {
    Accepted,
    Rollback,
    Unbound,
    Conflict,
    WrongFolder,
    WrongStore,
    Malformed,
    RecordUnavailable,
  };

  static auto accept(const QString &gpgIdFile, const QByteArray &contents,
                     const QString &storeRoot, QString *error = nullptr)
      -> Verdict;

  static auto reserveNext(const QString &gpgIdFile,
                          std::optional<qint64> verifiedOnDisk,
                          QString *error = nullptr) -> std::optional<qint64>;

  static auto recordWritten(const QString &gpgIdFile,
                            const QByteArray &contents,
                            QString *error = nullptr) -> bool;

  static auto digest(const QByteArray &contents) -> QString;

  static auto key(const QString &gpgIdFile) -> QString;

  static auto recordFile() -> QString;

  static auto storeRecordFile() -> QString;
 
private:
  static auto boundToItsFolder(const QString &gpgIdFile, const Header &header,
                               const QString &storeRoot, QString *error)
      -> bool;

  static auto ofThisStore(const QString &gpgIdFile, const Header &header,
                          const QString &pinned, bool alreadyAccepted,
                          const QString &recordPath, QString *error) -> bool;

  static auto wayThrough(qint64 last, const QString &recordPath,
                         const QString &saving) -> QString;

  static auto staleList(const QString &gpgIdFile, const Header &header,
                        qint64 last, const QString &recordPath, QString *error)
      -> Verdict;
};
 
#endif // SRC_GPGIDGENERATION_H_