summaryrefslogtreecommitdiff
path: root/src/pq/pq_helper.c
blob: bd54447e7880ecf8312ff58510e53400589b0b92 (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
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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
/*
  This file is part of TALER
  Copyright (C) 2014, 2015 Christian Grothoff (and other contributing authors)

  TALER 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, or (at your option) any later version.

  TALER 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
  TALER; see the file COPYING.  If not, If not, see <http://www.gnu.org/licenses/>
*/
/**
 * @file pq/pq_helper.c
 * @brief functions to initialize parameter arrays
 * @author Christian Grothoff
 */
#include "platform.h"
#include <gnunet/gnunet_util_lib.h>
#include "taler_pq_lib.h"


/**
 * Generate query parameter for a currency, consisting of the three
 * components "value", "fraction" and "currency" in this order. The
 * types must be a 64-bit integer, 32-bit integer and a
 * #TALER_CURRENCY_LEN-sized BLOB/VARCHAR respectively.
 *
 * @param x pointer to the query parameter to pass
 * @return array entry for the query parameters to use
 */
struct TALER_PQ_QueryParam
TALER_PQ_query_param_amount_nbo (const struct TALER_AmountNBO *x)
{
  struct TALER_PQ_QueryParam res =
    { TALER_PQ_QF_AMOUNT_NBO, x, sizeof (*x) };
  return res;
}


/**
 * Generate query parameter for a currency, consisting of the three
 * components "value", "fraction" and "currency" in this order. The
 * types must be a 64-bit integer, 32-bit integer and a
 * #TALER_CURRENCY_LEN-sized BLOB/VARCHAR respectively.
 *
 * @param x pointer to the query parameter to pass
 * @return array entry for the query parameters to use
 */
struct TALER_PQ_QueryParam
TALER_PQ_query_param_amount (const struct TALER_Amount *x)
{
  struct TALER_PQ_QueryParam res =
    { TALER_PQ_QF_AMOUNT, x, sizeof (*x) };
  return res;
}


/**
 * Generate query parameter for an RSA public key.  The
 * database must contain a BLOB type in the respective position.
 *
 * @param x the query parameter to pass
 * @return array entry for the query parameters to use
 */
struct TALER_PQ_QueryParam
TALER_PQ_query_param_rsa_public_key (const struct GNUNET_CRYPTO_rsa_PublicKey *x)
{
  struct TALER_PQ_QueryParam res =
    { TALER_PQ_QF_RSA_PUBLIC_KEY, (x), 0 };
  return res;
}


/**
 * Generate query parameter for an RSA signature.  The
 * database must contain a BLOB type in the respective position.
 *
 * @param x the query parameter to pass
 * @return array entry for the query parameters to use
 */
struct TALER_PQ_QueryParam
TALER_PQ_query_param_rsa_signature (const struct GNUNET_CRYPTO_rsa_Signature *x)
{
  struct TALER_PQ_QueryParam res =
    { TALER_PQ_QF_RSA_SIGNATURE, (x), 0 };
  return res;
}


/**
 * Generate query parameter for an absolute time value.
 * The database must store a 64-bit integer.
 *
 * @param x pointer to the query parameter to pass
 * @return array entry for the query parameters to use
 */
struct TALER_PQ_QueryParam
TALER_PQ_query_param_absolute_time (const struct GNUNET_TIME_Absolute *x)
{
  struct TALER_PQ_QueryParam res =
    { TALER_PQ_QF_TIME_ABSOLUTE, x, sizeof (*x) };
  return res;
}


/**
 * Generate query parameter for an absolute time value.
 * The database must store a 64-bit integer.
 *
 * @param x pointer to the query parameter to pass
 */
struct TALER_PQ_QueryParam
TALER_PQ_query_param_absolute_time_nbo(const struct GNUNET_TIME_AbsoluteNBO *x)
{
  struct TALER_PQ_QueryParam res =
    TALER_PQ_query_param_auto_from_type (&x->abs_value_us__);
  return res;
}


/**
 * Generate query parameter for an uint16_t in host byte order.
 *
 * @param x pointer to the query parameter to pass
 */
struct TALER_PQ_QueryParam
TALER_PQ_query_param_uint16 (const uint16_t *x)
{
  struct TALER_PQ_QueryParam res =
    { TALER_PQ_QF_UINT16, x, sizeof (*x) };
  return res;
}


/**
 * Generate query parameter for an uint32_t in host byte order.
 *
 * @param x pointer to the query parameter to pass
 */
struct TALER_PQ_QueryParam
TALER_PQ_query_param_uint32 (const uint32_t *x)
{
  struct TALER_PQ_QueryParam res =
    { TALER_PQ_QF_UINT32, x, sizeof (*x) };
  return res;
}


/**
 * Generate query parameter for an uint16_t in host byte order.
 *
 * @param x pointer to the query parameter to pass
 */
struct TALER_PQ_QueryParam
TALER_PQ_query_param_uint64 (const uint64_t *x)
{
  struct TALER_PQ_QueryParam res =
    { TALER_PQ_QF_UINT64, x, sizeof (*x) };
  return res;
}


/**
 * Generate query parameter for a JSON object (stored as a string
 * in the DB).
 *
 * @param x pointer to the json object to pass
 */
struct TALER_PQ_QueryParam
TALER_PQ_query_param_json (const json_t *x)
{
  struct TALER_PQ_QueryParam res =
    { TALER_PQ_QF_JSON, x, 0 };
  return res;
}


/**
 * Variable-size result expected.
 *
 * @param name name of the field in the table
 * @param[out] dst where to store the result, allocated
 * @param[out] sptr where to store the size of @a dst
 * @return array entry for the result specification to use
 */
struct TALER_PQ_ResultSpec
TALER_PQ_result_spec_variable_size (const char *name,
                                    void **dst,
                                    size_t *sptr)
{
  struct TALER_PQ_ResultSpec res =
    { TALER_PQ_RF_VARSIZE_BLOB, (void *) (dst), 0, name, sptr };
  return res;
}


/**
 * Currency amount expected.
 *
 * @param name name of the field in the table
 * @param[out] amount where to store the result
 * @return array entry for the result specification to use
 */
struct TALER_PQ_ResultSpec
TALER_PQ_result_spec_amount_nbo (const char *name,
				 struct TALER_AmountNBO *amount)
{
  struct TALER_PQ_ResultSpec res =
    {TALER_PQ_RF_AMOUNT_NBO, (void *) amount, sizeof (*amount), name, NULL };
  return res;
}


/**
 * Currency amount expected.
 *
 * @param name name of the field in the table
 * @param[out] amount where to store the result
 * @return array entry for the result specification to use
 */
struct TALER_PQ_ResultSpec
TALER_PQ_result_spec_amount (const char *name,
			     struct TALER_Amount *amount)
{
  struct TALER_PQ_ResultSpec res =
    {TALER_PQ_RF_AMOUNT, (void *) amount, sizeof (*amount), name, NULL };
  return res;
}


/**
 * RSA public key expected.
 *
 * @param name name of the field in the table
 * @param[out] rsa where to store the result
 * @return array entry for the result specification to use
 */
struct TALER_PQ_ResultSpec
TALER_PQ_result_spec_rsa_public_key (const char *name,
				     struct GNUNET_CRYPTO_rsa_PublicKey **rsa)
{
  struct TALER_PQ_ResultSpec res =
    {TALER_PQ_RF_RSA_PUBLIC_KEY, (void *) rsa, 0, name, NULL };
  return res;
}


/**
 * RSA signature expected.
 *
 * @param name name of the field in the table
 * @param[out] sig where to store the result;
 * @return array entry for the result specification to use
 */
struct TALER_PQ_ResultSpec
TALER_PQ_result_spec_rsa_signature (const char *name,
				    struct GNUNET_CRYPTO_rsa_Signature **sig)
{
  struct TALER_PQ_ResultSpec res =
    {TALER_PQ_RF_RSA_SIGNATURE, (void *) sig, 0, (name), NULL };
  return res;
}


/**
 * Absolute time expected.
 *
 * @param name name of the field in the table
 * @param[out] at where to store the result
 * @return array entry for the result specification to use
 */
struct TALER_PQ_ResultSpec
TALER_PQ_result_spec_absolute_time (const char *name,
				    struct GNUNET_TIME_Absolute *at)
{
  struct TALER_PQ_ResultSpec res =
    {TALER_PQ_RF_TIME_ABSOLUTE, (void *) at, sizeof (*at), (name), NULL };
  return res;
}


/**
 * Absolute time expected.
 *
 * @param name name of the field in the table
 * @param[out] at where to store the result
 * @return array entry for the result specification to use
 */
struct TALER_PQ_ResultSpec
TALER_PQ_result_spec_absolute_time_nbo (const char *name,
                                        struct GNUNET_TIME_AbsoluteNBO *at)
{
  struct TALER_PQ_ResultSpec res =
    TALER_PQ_result_spec_auto_from_type(name, &at->abs_value_us__);
  return res;
}


/**
 * uint16_t expected.
 *
 * @param name name of the field in the table
 * @param[out] u16 where to store the result
 * @return array entry for the result specification to use
 */
struct TALER_PQ_ResultSpec
TALER_PQ_result_spec_uint16 (const char *name,
                             uint16_t *u16)
{
  struct TALER_PQ_ResultSpec res =
    {TALER_PQ_RF_UINT16, (void *) u16, sizeof (*u16), (name), NULL };
  return res;
}


/**
 * uint32_t expected.
 *
 * @param name name of the field in the table
 * @param[out] u32 where to store the result
 * @return array entry for the result specification to use
 */
struct TALER_PQ_ResultSpec
TALER_PQ_result_spec_uint32 (const char *name,
                             uint32_t *u32)
{
  struct TALER_PQ_ResultSpec res =
    {TALER_PQ_RF_UINT32, (void *) u32, sizeof (*u32), (name), NULL };
  return res;
}


/**
 * uint64_t expected.
 *
 * @param name name of the field in the table
 * @param[out] u64 where to store the result
 * @return array entry for the result specification to use
 */
struct TALER_PQ_ResultSpec
TALER_PQ_result_spec_uint64 (const char *name,
                             uint64_t *u64)
{
  struct TALER_PQ_ResultSpec res =
    {TALER_PQ_RF_UINT64, (void *) u64, sizeof (*u64), (name), NULL };
  return res;
}


/**
 * json_t expected.
 *
 * @param name name of the field in the table
 * @param[out] jp where to store the result
 * @return array entry for the result specification to use
 */
struct TALER_PQ_ResultSpec
TALER_PQ_result_spec_json (const char *name,
                           json_t **jp)
{
  struct TALER_PQ_ResultSpec res =
    {TALER_PQ_RF_JSON, (void *) jp, 0, (name), NULL };
  return res;
}

/* end of pq_helper.c */