aboutsummaryrefslogtreecommitdiffstats
path: root/src/core/function/gpg/GpgAutomatonHandler.h
blob: f86299e88d15bb511103ef76ed92270d52ba16c2 (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
/**
 * 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/GpgFrontendCore.h"
#include "core/function/basic/GpgFunctionObject.h"
#include "core/function/gpg/GpgContext.h"
#include "core/typedef/GpgTypedef.h"

namespace GpgFrontend {

class GpgAutomatonHandler
    : public SingletonFunctionObject<GpgAutomatonHandler> {
 public:
  using Command = QString;
  using AutomatonState = enum {
    AS_START,
    AS_SELECT,
    AS_COMMAND,
    AS_VALUE,
    AS_REASON_CODE,
    AS_REASON_TEXT,
    AS_REALLY_ULTIMATE,
    AS_SAVE,
    AS_ERROR,
    AS_QUIT,
  };

  struct AutomatonHandelStruct;

  using AutomatonActionHandler =
      std::function<Command(AutomatonHandelStruct&, AutomatonState)>;
  using AutomatonNextStateHandler =
      std::function<AutomatonState(AutomatonState, QString, QString)>;

  struct AutomatonHandelStruct {
    explicit AutomatonHandelStruct(QString key_fpr);
    void SetStatus(AutomatonState next_state);
    auto CurrentStatus() -> AutomatonState;
    void SetHandler(AutomatonNextStateHandler next_state_handler,
                    AutomatonActionHandler action_handler);
    auto NextState(QString gpg_status, QString args) -> AutomatonState;
    auto Action() -> Command;
    void SetSuccess(bool success);
    [[nodiscard]] auto Success() const -> bool;
    auto KeyFpr() -> QString;

   private:
    AutomatonState current_state_ = AS_START;
    AutomatonNextStateHandler next_state_handler_;
    AutomatonActionHandler action_handler_;
    bool success_ = false;
    QString key_fpr_;
  };

  /**
   * @brief Construct a new Gpg Key Manager object
   *
   * @param channel
   */
  explicit GpgAutomatonHandler(
      int channel = SingletonFunctionObject::GetDefaultChannel());

  /**
   * @brief
   *
   * @param key
   * @param next_state_handler
   * @param action_handler
   * @param flags
   * @return true
   * @return false
   */
  auto DoInteract(const GpgKey& key,
                  AutomatonNextStateHandler next_state_handler,
                  AutomatonActionHandler action_handler, int flags = 0) -> bool;

  /**
   * @brief
   *
   * @param next_state_handler
   * @param action_handler
   * @return true
   * @return false
   */
  auto DoCardInteract(AutomatonNextStateHandler next_state_handler,
                      AutomatonActionHandler action_handler) -> bool;

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

  /**
   * @brief
   *
   * @param handle
   * @param status
   * @param args
   * @param fd
   * @return gpgme_error_t
   */
  static auto interator_cb_func(void* handle, const char* status,
                                const char* args, int fd) -> gpgme_error_t;
};

using AutomatonNextStateHandler =
    GpgAutomatonHandler::AutomatonNextStateHandler;
using AutomatonState = GpgAutomatonHandler::AutomatonState;
using AutomatonActionHandler = GpgAutomatonHandler::AutomatonActionHandler;
using AutomatonHandelStruct = GpgAutomatonHandler::AutomatonHandelStruct;

}  // namespace GpgFrontend