util.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2014 Anne Jan Brouwer
// SPDX-License-Identifier: GPL-3.0-or-later
#ifndef SRC_UTIL_H_
#define SRC_UTIL_H_
 
#include "appsettings.h"
#include <QProcessEnvironment>
#include <QRegularExpression>
#include <QString>
#include <QStringList>
 
#include <functional>
#include <optional>
 
class QFile;
class QFileDevice;

constexpr int MS_PER_SECOND = 1000;

class Util {
public:
  static void applyPassProcessDefaults();

  static auto gitCeiling(const QString &store) -> QString;

  static auto repositoryPassClimbsTo(const QString &store) -> QString;

  static auto gitStoreVariables(const QString &store, const QString &git = {},
                                std::optional<uint> asUser = std::nullopt)
      -> QList<std::pair<QString, QString>>;

  static void setGitOwnerForTests(std::optional<uint> user);

  static auto mkpathForStore(const QString &path) -> bool;

  static auto passUmask(const QString &value) -> int;

  static auto findBinaryInPath(const QString &binary) -> QString;
  static auto findBinaryInPath(const QString &binary,
                               const QStringList &searchPaths) -> QString;
  static auto findPasswordStore() -> QString;
  static auto expandTilde(const QString &path) -> QString;
  static auto normalizeFolderPath(const QString &path) -> QString;
  static auto configIsValid(const AppSettings &s) -> bool;
  static auto endsWithGpg() -> const QRegularExpression &;
  static auto protocolRegex() -> const QRegularExpression &;
  static auto isLaunchableWebUrl(const QString &value) -> bool;
  static auto linkifyUrls(const QString &text, bool *linked = nullptr)
      -> QString;
  static auto newLinesRegex() -> const QRegularExpression &;
  static auto isValidKeyId(const QString &keyId) -> bool;
  static auto regularFilesUnder(const QString &dir,
                                const QStringList &nameFilters,
                                QStringList *skipped = nullptr,
                                bool hiddenFiles = false) -> QStringList;
  static auto directoriesUnder(const QString &dir) -> QStringList;
  static auto isLinkedFolder(const QString &path) -> bool;
  static auto isUnderLink(const QString &path, const QString &storeRoot,
                          bool includeSelf = true) -> bool;
  static auto removeTree(const QString &dir) -> bool;

  static auto replaceFile(const QString &from, const QString &to, bool replace)
      -> bool;

  static auto openRegularFile(const QString &path, QFile &file) -> bool;

  static constexpr qint64 kMaxGpgIdBytes = 1024 * 1024;

  static auto readRegularFile(const QString &path, qint64 maxBytes)
      -> std::optional<QByteArray>;

  using Filler = std::function<QString(QFileDevice &)>;

  static auto stageFileReplacing(const QString &path, bool replace,
                                 const Filler &fill, QString *error = nullptr)
      -> bool;

  static auto writeFileReplacing(const QString &path, const QByteArray &bytes,
                                 bool replace, QString *error = nullptr)
      -> bool;

  static auto copyFileReplacing(const QString &src, const QString &dst,
                                bool replace, QString *error = nullptr) -> bool;

  static auto syncToDisk(QFileDevice &file) -> bool;
 
private:
  static void initialiseEnvironment();
  static QProcessEnvironment _env;
  static bool _envInitialised;
};
 
#endif // SRC_UTIL_H_