File: keyvalueframe.h

package info (click to toggle)
signalbackup-tools 20250313.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 3,752 kB
  • sloc: cpp: 47,042; sh: 477; ansic: 399; ruby: 19; makefile: 3
file content (311 lines) | stat: -rw-r--r-- 10,351 bytes parent folder | download
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
/*
  Copyright (C) 2021-2025  Selwin van Dijk

  This file is part of signalbackup-tools.

  signalbackup-tools 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.

  signalbackup-tools 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 signalbackup-tools.  If not, see <https://www.gnu.org/licenses/>.
*/

#ifndef KEYVALUEFRAME_H_
#define KEYVALUEFRAME_H_

#include <string_view>

#include "../backupframe/backupframe.h"
#include "../base64/base64.h"
#include "../common_be.h"

class KeyValueFrame : public BackupFrame
{
  enum FIELD
  {
    INVALID = 0,
    KEY = 1,          // string
    BLOBVALUE = 2,    // bytes
    BOOLEANVALUE = 3, // bool
    FLOATVALUE = 4,   // float
    INTEGERVALUE = 5, // int32
    LONGVALUE = 6,    // int64
    STRINGVALUE = 7   // string
  };

  static Registrar s_registrar;
 public:
  inline explicit KeyValueFrame(uint64_t count = 0);
  inline KeyValueFrame(unsigned char const *bytes, size_t length, uint64_t count = 0);
  inline virtual ~KeyValueFrame() override = default;
  inline virtual KeyValueFrame *clone() const override;
  inline virtual KeyValueFrame *move_clone() override;
  inline static BackupFrame *create(unsigned char const *bytes, size_t length, uint64_t count = 0);
  inline virtual void printInfo() const override;
  inline virtual FRAMETYPE frameType() const override;
  inline std::pair<unsigned char *, uint64_t> getData() const override;
  inline virtual bool validate(uint64_t) const override;
  inline std::string getHumanData() const override;
  inline unsigned int getField(std::string_view const &str) const;
  inline std::string key() const;
  inline std::string value() const;
  inline std::string valueType() const;
 private:
  inline uint64_t dataSize() const override;
};

inline KeyValueFrame::KeyValueFrame(uint64_t count)
  :
  BackupFrame(count)
{}

inline KeyValueFrame::KeyValueFrame(unsigned char const *bytes, size_t length, uint64_t count)
  :
  BackupFrame(bytes, length, count)
{}

inline KeyValueFrame *KeyValueFrame::clone() const
{
  return new KeyValueFrame(*this);
}

inline KeyValueFrame *KeyValueFrame::move_clone()
{
  return new KeyValueFrame(std::move(*this));
}

inline BackupFrame *KeyValueFrame::create(unsigned char const *bytes, size_t length, uint64_t count)
{
  return new KeyValueFrame(bytes, length, count);
}

inline void KeyValueFrame::printInfo() const // virtual
{
  //DEBUGOUT("TYPE: KEYVALUEFRAME");
  Logger::message("Frame number: ", d_count);
  Logger::message("        Size: ", d_constructedsize);
  Logger::message("        Type: KEYVALUEFRAME");
  for (auto const &p : d_framedata)
  {
    if (std::get<0>(p) == FIELD::KEY)
      Logger::message("         - (key  : \"", bepaald::bytesToString(std::get<1>(p), std::get<2>(p)), "\" (", std::get<2>(p), " bytes)");
    else if (std::get<0>(p) == FIELD::BLOBVALUE)
      Logger::message("         - (blobvalue   : \"", bepaald::bytesToString(std::get<1>(p), std::get<2>(p)), "\" (", std::get<2>(p), " bytes)");
    else if (std::get<0>(p) == FIELD::BOOLEANVALUE)
      Logger::message("         - (booleanvalue : \"", std::boolalpha, (bytesToInt64(std::get<1>(p), std::get<2>(p)) ? true : false), "\")");
    else if (std::get<0>(p) == FIELD::FLOATVALUE) // note, this is untested, none of my backups contain a KVFrame with this field
      Logger::message("         - (floatvalue : \"", bepaald::toString(*reinterpret_cast<float *>(std::get<1>(p))), "\" (", std::get<2>(p), " bytes)");
    else if (std::get<0>(p) == FIELD::INTEGERVALUE)
      Logger::message("         - (integervalue : \"", bytesToInt32(std::get<1>(p), std::get<2>(p)), "\" (", std::get<2>(p), " bytes)");
    else if (std::get<0>(p) == FIELD::LONGVALUE)
      Logger::message("         - (longvalue : \"", bytesToUint64(std::get<1>(p), std::get<2>(p)), "\" (", std::get<2>(p), " bytes)");
    else if (std::get<0>(p) == FIELD::STRINGVALUE)
      Logger::message("         - (stringvalue : \"", bepaald::bytesToString(std::get<1>(p), std::get<2>(p)), "\" (", std::get<2>(p), " bytes)");
  }
}

inline BackupFrame::FRAMETYPE KeyValueFrame::frameType() const // virtual override
{
  return FRAMETYPE::KEYVALUE;
}

inline uint64_t KeyValueFrame::dataSize() const
{
  uint64_t size = 0;
  for (auto const &fd : d_framedata)
  {
    switch (std::get<0>(fd))
    {
      case FIELD::KEY:
      case FIELD::STRINGVALUE:
      case FIELD::BLOBVALUE:
      {
        uint64_t stringsize = std::get<2>(fd);
        size += varIntSize(stringsize);
        size += stringsize + 1; // +1 for fieldtype + wiretype
        break;
      }
      case FIELD::INTEGERVALUE:
      case FIELD::LONGVALUE:
      case FIELD::BOOLEANVALUE:
      {
        uint64_t val = bytesToInt64(std::get<1>(fd), std::get<2>(fd));
        size += varIntSize(val);
        size += 1; // for fieldtype + wiretype
        break;
      }
      case FIELD::FLOATVALUE: // note, this is untested, none of my backups contain a KVFrame with this field
      {
        size += 5; // fixed32? +1 for fieldtype + wiretype
        break;
      }
    }
  }

  // for size of this entire frame.
  size += varIntSize(size);
  return ++size;
}

inline std::pair<unsigned char *, uint64_t> KeyValueFrame::getData() const
{
  uint64_t size = dataSize();
  unsigned char *data = new unsigned char[size];
  uint64_t datapos = 0;

  datapos += setFieldAndWire(FRAMETYPE::KEYVALUE, WIRETYPE::LENGTHDELIM, data + datapos);
  datapos += setFrameSize(size, data + datapos);

  for (auto const &fd : d_framedata)
  {
    switch (std::get<0>(fd))
    {
      case FIELD::KEY:
      case FIELD::STRINGVALUE:
      case FIELD::BLOBVALUE:
      {
        datapos += putLengthDelimType(fd, data + datapos);
        break;
      }
      case FIELD::INTEGERVALUE:
      case FIELD::LONGVALUE:
      case FIELD::BOOLEANVALUE:
      {
        datapos += putVarIntType(fd, data + datapos);
        break;
      }
      case FIELD::FLOATVALUE:
      {
        datapos += putFixed32Type(fd, data + datapos); // untested
        break;
      }
    }
  }
  return {data, size};

}

// not sure about the requirements, but I'm guessing
// 1 key and at least one value is required
inline bool KeyValueFrame::validate(uint64_t) const
{
  if (d_framedata.empty())
    return false;

  bool foundkey = false;
  bool foundvalue = false;
  for (auto const &p : d_framedata)
  {
    if (std::get<0>(p) == FIELD::KEY)
      foundkey = true;
    if (std::get<0>(p) == FIELD::STRINGVALUE ||
        std::get<0>(p) == FIELD::BOOLEANVALUE ||
        std::get<0>(p) == FIELD::BLOBVALUE ||
        std::get<0>(p) == FIELD::INTEGERVALUE ||
        std::get<0>(p) == FIELD::LONGVALUE ||
        std::get<0>(p) == FIELD::FLOATVALUE)
      foundvalue = true;
  }

  return foundkey && foundvalue;
}

inline std::string KeyValueFrame::getHumanData() const
{
  std::string data;
  for (auto const &p : d_framedata)
  {
    if (std::get<0>(p) == FIELD::KEY)
      data += "KEY:string:" + bepaald::bytesToString(std::get<1>(p), std::get<2>(p)) + "\n";
    else if (std::get<0>(p) == FIELD::BLOBVALUE)
      data += "BLOBVALUE:bytes:" + Base64::bytesToBase64String(std::get<1>(p), std::get<2>(p)) + "\n";
    else if (std::get<0>(p) == FIELD::BOOLEANVALUE)
      data += "BOOLEANVALUE:bool:" + (bytesToInt64(std::get<1>(p), std::get<2>(p)) ? "true"s : "false"s) + "\n";
    else if (std::get<0>(p) == FIELD::FLOATVALUE)
      data += "FLOATVALUE:float:" + Base64::bytesToBase64String(std::get<1>(p), std::get<2>(p)) + "\n"; // warning, untested
    else if (std::get<0>(p) == FIELD::INTEGERVALUE)
      data += "INTEGERVALUE:int32:" + bepaald::toString(bytesToInt32(std::get<1>(p), std::get<2>(p))) + "\n";
    else if (std::get<0>(p) == FIELD::LONGVALUE)
      data += "LONGVALUE:int64:" + bepaald::toString(bytesToInt64(std::get<1>(p), std::get<2>(p))) + "\n";
    else if (std::get<0>(p) == FIELD::STRINGVALUE)
      data += "STRINGVALUE:string:" + bepaald::bytesToString(std::get<1>(p), std::get<2>(p)) + "\n";
  }
  return data;
}

inline unsigned int KeyValueFrame::getField(std::string_view const &str) const
{
  if (str == "KEY")
    return FIELD::KEY;
  if (str == "BLOBVALUE")
    return FIELD::BLOBVALUE;
  if (str == "BOOLEANVALUE")
    return FIELD::BOOLEANVALUE;
  if (str == "FLOATVALUE")
    return FIELD::FLOATVALUE;
  if (str == "LONGVALUE")
    return FIELD::LONGVALUE;
  if (str == "INTEGERVALUE")
    return FIELD::INTEGERVALUE;
  if (str == "STRINGVALUE")
    return FIELD::STRINGVALUE;
  return FIELD::INVALID;
}

inline std::string KeyValueFrame::key() const
{
  for (auto const &p : d_framedata)
    if (std::get<0>(p) == FIELD::KEY)
      return bepaald::bytesToString(std::get<1>(p), std::get<2>(p));
  return std::string();
}

inline std::string KeyValueFrame::value() const
{
  for (auto const &p : d_framedata)
  {
    if (std::get<0>(p) == FIELD::STRINGVALUE)
      return bepaald::bytesToString(std::get<1>(p), std::get<2>(p));

    if (std::get<0>(p) == FIELD::INTEGERVALUE || std::get<0>(p) == FIELD::LONGVALUE)
      return bepaald::toString(bytesToInt64(std::get<1>(p), std::get<2>(p)));

    if (std::get<0>(p) == FIELD::BLOBVALUE || std::get<0>(p) == FIELD::FLOATVALUE) // float is untested
      return Base64::bytesToBase64String(std::get<1>(p), std::get<2>(p));

    if (std::get<0>(p) == FIELD::BOOLEANVALUE)
      return (bytesToInt64(std::get<1>(p), std::get<2>(p)) ? "true"s : "false"s);
  }
  return std::string();
}

inline std::string KeyValueFrame::valueType() const
{
  for (auto const &p : d_framedata)
  {
    if (std::get<0>(p) == FIELD::STRINGVALUE)
      return "STRING";

    if (std::get<0>(p) == FIELD::INTEGERVALUE || std::get<0>(p) == FIELD::LONGVALUE)
      return "INTEGER";

    if (std::get<0>(p) == FIELD::BLOBVALUE)
      return "BLOB";

    if (std::get<0>(p) == FIELD::FLOATVALUE)
      return "FLOAT";

    if (std::get<0>(p) == FIELD::BOOLEANVALUE)
      return "BOOL";
  }
  return std::string();
}

#endif