pass.h

// SPDX-FileCopyrightText: 2016 Anne Jan Brouwer
// SPDX-License-Identifier: GPL-3.0-or-later
#ifndef SRC_PASS_H_
#define SRC_PASS_H_
 
#include "enums.h"
#include "executor.h"
#include "userinfo.h"
 
#include <QProcess>
#include <QQueue>
#include <QString>
#include <QStringList>
#include <cassert>
#include <map>

struct ResolvedGpgconfCommand {
  QString program;
  QStringList arguments;
};

class Pass : public QObject {
  Q_OBJECT
 
  bool wrapperRunning;
  QStringList env;
 
protected:
  Executor exec;

  using PROCESS = Enums::PROCESS;
 
public:
  Pass();
  void init();
  static bool gpgSupportsEd25519();
  static QString getDefaultKeyTemplate();
 
  ~Pass() override = default;
 
  // Git operations
  virtual void GitInit() = 0;
  virtual void GitPull() = 0;
  virtual void GitPull_b() = 0;
  virtual void GitPush() = 0;
 
  // Password operations
  virtual void Show(QString file) = 0;
  virtual void OtpGenerate(QString file) = 0;
  virtual void Insert(QString file, QString value, bool force) = 0;
  virtual void Remove(QString file, bool isDir) = 0;
  virtual void Move(const QString srcDir, const QString dest,
                    const bool force = false) = 0;
  virtual void Copy(const QString srcDir, const QString dest,
                    const bool force = false) = 0;
  virtual void Init(QString path, const QList<UserInfo> &users) = 0;
  virtual void Grep(QString pattern, bool caseInsensitive = false) = 0;

  virtual auto generatePassword(unsigned int length, const QString &charset)
      -> QString;
 
  // GPG operations
  void GenerateGPGKeys(QString batch);
  auto listKeys(QStringList keystrings, bool secret = false) -> QList<UserInfo>;
  auto listKeys(const QString &keystring = "", bool secret = false)
      -> QList<UserInfo>;
  void updateEnv();
 
  // Static helpers
  static auto resolveGpgconfCommand(const QString &gpgPath)
      -> ResolvedGpgconfCommand;
  static auto getGpgIdPath(const QString &for_file) -> QString;
  static auto getRecipientList(const QString &for_file) -> QStringList;
  static auto getRecipientString(const QString &for_file,
                                 const QString &separator = " ",
                                 int *count = nullptr) -> QStringList;
 
protected:
  void executeWrapper(PROCESS id, const QString &app, const QStringList &args,
                      bool readStdout = true, bool readStderr = true);
  auto generateRandomPassword(const QString &charset, unsigned int length)
      -> QString;
  auto boundedRandom(quint32 bound) -> quint32;
  void setEnvVar(const QString &key, const QString &value);

  virtual void executeWrapper(PROCESS id, const QString &app,
                              const QStringList &args, QString input,
                              bool readStdout = true, bool readStderr = true);
 
protected slots:
  virtual void finished(int id, int exitCode, const QString &out,
                        const QString &err);
 
private:
  void handleProcessError(PROCESS pid, int exitCode, const QString &out,
                          const QString &err);
  void handleGrepError(int exitCode, const QString &err);
  auto formatInsertError(const QString &friendly, const QString &err)
      -> QString;
  void emitProcessFinishedSignal(PROCESS pid, const QString &out,
                                 const QString &err);
 
signals:
  void error(QProcess::ProcessError);
  void startingExecuteWrapper();
  void statusMsg(const QString &msg, int timeout);
  void critical(const QString &title, const QString &message);

  void processErrorExit(int exitCode, const QString &err);

  void finishedAny(const QString &out, const QString &err);
  void finishedGitInit(const QString &out, const QString &err);
  void finishedGitPull(const QString &out, const QString &err);
  void finishedGitPush(const QString &out, const QString &err);
  void finishedShow(const QString &out);
  void finishedOtpGenerate(const QString &out);
  void finishedInsert(const QString &out, const QString &err);
  void finishedRemove(const QString &out, const QString &err);
  void finishedInit(const QString &out, const QString &err);
  void finishedMove(const QString &out, const QString &err);
  void finishedCopy(const QString &out, const QString &err);
  void finishedGenerate(const QString &out, const QString &err);
  void finishedGenerateGPGKeys(const QString &out, const QString &err);
  void finishedGrep(const QList<QPair<QString, QStringList>> &results);
};

QString gpgErrorMessage(const QString &err);

QList<QPair<QString, QStringList>> parseGrepOutput(const QString &rawOut);
 
#endif // SRC_PASS_H_