aboutsummaryrefslogtreecommitdiffstats
path: root/src/core/function/gpg/GpgCommandExecutor.h
blob: 046b61e43d5a33da50e7e37d74c865723abf9f7a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/**
 * Copyright (C) 2021-2024 Saturneric <[email protected]>
 *
 * This file is part of GpgFrontend.
 *
 * GpgFrontend is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * GpgFrontend 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 GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
 *
 * The initial version of the source code is inherited from
 * the gpg4usb project, which is under GPL-3.0-or-later.
 *
 * All the source code of GpgFrontend was modified and released by
 * Saturneric <[email protected]> starting on May 12, 2021.
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 */

#pragma once

#include "core/function/basic/GpgFunctionObject.h"
#include "core/function/gpg/GpgContext.h"
#include "core/module/Module.h"

namespace GpgFrontend {

using GpgCommandExecutorCallback = std::function<void(int, QString, QString)>;
using GpgCommandExecutorInterator = std::function<void(QProcess *)>;

/**
 * @brief Extra commands related to GPG
 *
 */
class GPGFRONTEND_CORE_EXPORT GpgCommandExecutor
    : public SingletonFunctionObject<GpgCommandExecutor> {
 public:
  struct GPGFRONTEND_CORE_EXPORT ExecuteContext {
    QString cmd;
    QStringList arguments;
    GpgCommandExecutorCallback cb_func;
    GpgCommandExecutorInterator int_func;
    Module::TaskRunnerPtr task_runner = nullptr;

    /**
     * @brief Construct a new Execute Context object
     *
     */
    ExecuteContext() = default;

    /**
     * @brief Construct a new Execute Context object
     *
     * @param cmd
     * @param arguments
     * @param callback
     * @param task_runner
     * @param int_func
     */
    ExecuteContext(
        QString cmd, QStringList arguments,
        GpgCommandExecutorCallback callback = [](int, const QString &,
                                                 const QString &) {},
        Module::TaskRunnerPtr task_runner = nullptr,
        GpgCommandExecutorInterator int_func = [](QProcess *) {});

    /**
     * @brief Construct a new Execute Context object
     *
     * @param arguments
     * @param callback
     * @param task_runner
     * @param int_func
     */
    ExecuteContext(
        QStringList arguments,
        GpgCommandExecutorCallback callback = [](int, const QString &,
                                                 const QString &) {},
        Module::TaskRunnerPtr task_runner = nullptr,
        GpgCommandExecutorInterator int_func = [](QProcess *) {});
  };

  using ExecuteContexts = QContainer<ExecuteContext>;

  explicit GpgCommandExecutor(int channel = kGpgFrontendDefaultChannel);

  /**
   * @brief Excuting a command
   *
   * @param arguments Command parameters
   * @param interact_func Command answering function
   */
  static void ExecuteSync(const ExecuteContext &);

  /**
   * @brief
   *
   */
  static void ExecuteConcurrentlyAsync(const ExecuteContexts &);

  /**
   * @brief
   *
   */
  static void ExecuteConcurrentlySync(const ExecuteContexts &);

  /**
   * @brief
   *
   */
  auto GpgExecuteSync(const ExecuteContext &) -> std::tuple<int, QString>;

  /**
   * @brief
   *
   */
  auto GpgConfExecuteSync(const ExecuteContext &) -> std::tuple<int, QString>;

  /**
   * @brief
   *
   * @param context
   */
  void GpgExecuteAsync(const ExecuteContext &);

  /**
   * @brief
   *
   * @param context
   */
  void GpgConfExecuteAsync(const ExecuteContext &);

 private:
  GpgContext &ctx_ =
      GpgContext::GetInstance(SingletonFunctionObject::GetChannel());
};

}  // namespace GpgFrontend