filecontent.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2018 Anne Jan Brouwer
// SPDX-License-Identifier: GPL-3.0-or-later
#ifndef SRC_FILECONTENT_H_
#define SRC_FILECONTENT_H_
 
#include <QList>
#include <QString>
#include <QStringList>
#include <functional>

struct NamedValue {
  QString name;
  QString value;
  QString originalLine;
};

inline bool operator==(const NamedValue &a, const NamedValue &b) {
  return a.name == b.name && a.value == b.value;
}

class NamedValues : public QList<NamedValue> {
public:
  NamedValues();
  NamedValues(std::initializer_list<NamedValue> values);

  auto takeValue(const QString &name) -> QString;

  auto takeNamedValue(const QString &name) -> NamedValue;
};

class FileContent {
public:
  static constexpr int kMaxNamedFields = 1000;

  static constexpr int kMaxDisplayLines = 10000;

  [[nodiscard]] static auto boundedForDisplay(const QString &text) -> QString;

  static auto parse(const QString &fileContent,
                    const QStringList &templateFields, bool allFields,
                    const std::function<bool(const QString &)> &alsoField = {})
      -> FileContent;

  [[nodiscard]] auto getPassword() const -> QString;

  [[nodiscard]] auto getPasswordForDisplay() const -> QString;

  [[nodiscard]] auto getNamedValues() const -> NamedValues;

  [[nodiscard]] auto getRemainingData() const -> QString;

  [[nodiscard]] auto getRemainingDataForDisplay() const -> QString;

  [[nodiscard]] auto getRemainingLineCount() const -> qsizetype;

  [[nodiscard]] static auto isOtpFieldName(const QString &name) -> bool;

  [[nodiscard]] static auto isSecretFieldName(const QString &name,
                                              const QStringList &secrets)
      -> bool;

  [[nodiscard]] static auto isOtpUriValue(const QString &value) -> bool;

  [[nodiscard]] auto getOtpUri() const -> QString;
 
private:
  FileContent(QString password, NamedValues namedValues, QString remainingData,
              QString remainingDataDisplay, QString otpUri,
              qsizetype remainingLines);

  QString password;
  NamedValues namedValues;
  QString remainingData, remainingDataDisplay; 
  QString otpUri;
  qsizetype remainingLines = 0;
};
 
#endif // SRC_FILECONTENT_H_