2 This file is part of GNUnet
3 Copyright (C) 2012 GNUnet e.V.
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
21 * @author Christian Grothoff
24 * Helper library to access a MySQL database
26 * @defgroup mysql MySQL library
27 * Helper library to access a MySQL database.
30 #ifndef GNUNET_MY_LIB_H
31 #define GNUNET_MY_LIB_H
33 #include "gnunet_util_lib.h"
34 #include "gnunet_mysql_lib.h"
35 #include <mysql/mysql.h>
40 #if 0 /* keep Emacsens' auto-indent happy */
48 * Information we pass to #GNUNET_MY_exec_prepared() to
49 * initialize the arguments of the prepared statement.
51 struct GNUNET_MY_QueryParam;
55 * Function called to convert input argument into SQL parameters.
58 * @param pq data about the query
59 * @param qbind array of parameters to initialize
63 (*GNUNET_MY_QueryConverter)(void *cls,
64 const struct GNUNET_MY_QueryParam *qp,
69 * Information we pass to #GNUNET_MY_exec_prepared() to
70 * initialize the arguments of the prepared statement.
72 struct GNUNET_MY_QueryParam
76 * Function to call for the type conversion.
78 GNUNET_MY_QueryConverter conv;
81 * Closure for @e conv.
86 * Number of arguments the @a conv converter expects to initialize.
88 unsigned int num_params;
91 * Information to pass to @e conv.
96 * Information to pass to @e conv. Size of @a data.
98 unsigned long data_len ;
104 * End of query parameter specification.
106 * @return array last entry for the result specification to use
108 #define GNUNET_MY_query_param_end { NULL, NULL, 0, NULL, 0 }
113 * Generate query parameter for a buffer @a ptr of
116 * @param ptr pointer to the query parameter to pass
117 * @oaran ptr_size number of bytes in @a ptr
119 struct GNUNET_MY_QueryParam
120 GNUNET_MY_query_param_fixed_size (const void *ptr,
124 * Run a prepared SELECT statement.
126 * @param mc mysql context
127 * @param sh handle to SELECT statment
128 * @param params parameters to the statement
132 GNUNET_MY_exec_prepared (struct GNUNET_MYSQL_Context *mc,
133 struct GNUNET_MYSQL_StatementHandle *sh,
134 const struct GNUNET_MY_QueryParam *params);
138 * Information we pass to #GNUNET_MY_extract_result() to
139 * initialize the arguments of the prepared statement.
141 struct GNUNET_MY_ResultParam;
145 * Function called to convert input argument into SQL parameters.
148 * @param pq data about the query
149 * @return -1 on error
152 (*GNUNET_MY_ResultConverter)(void *cls,
153 struct GNUNET_MY_QueryParam *qp,
154 MYSQL_BIND *results);
158 * Information we pass to #GNUNET_MY_extract_result() to
159 * initialize the arguments of the prepared statement.
161 struct GNUNET_MY_ResultSpec
165 * Function to call for the type conversion.
167 GNUNET_MY_ResultConverter conv;
170 * Closure for @e conv.
175 * Destination for the data.
180 * Allowed size for the data, 0 for variable-size
181 * (in this case, the type of @e dst is a `void **`
182 * and we need to allocate a buffer of the right size).
187 * Where to store actual size of the result.
195 * End of result speceter specification.
197 * @return array last entry for the result specification to use
199 #define GNUNET_MY_result_spec_end { NULL, NULL, NULL, 0, NULL }
204 * Obtain fixed size result of @a ptr_size bytes from
205 * MySQL, store in already allocated buffer at @a ptr.
207 * @spec ptr where to write the result
208 * @oaran ptr_size number of bytes available at @a ptr
210 struct GNUNET_MY_ResultSpec
211 GNUNET_MY_result_spec_fixed_size (void *ptr,
215 * Generate query parameter for a string
217 *@param ptr pointer to the string query parameter to pass
219 struct GNUNET_MY_QueryParam
220 GNUNET_MY_query_param_string (const char *ptr);
223 * Generate fixed-size query parameter with size determined
226 * @param x pointer to the query parameter to pass
228 #define GNUNET_MY_query_param_auto_from_type(x) GNUNET_MY_query_param_fixed_size ((x), sizeof (*(x)))
231 * Generate query parameter for an RSA public key. The
232 * database must contain a BLOB type in the respective position.
234 * @param x the query parameter to pass
235 * @return array entry for the query parameters to use
237 struct GNUNET_MY_QueryParam
238 GNUNET_MY_query_param_rsa_public_key (const struct GNUNET_CRYPTO_RsaPublicKey *x);
241 * Generate query parameter for an RSA signature. The
242 * database must contain a BLOB type in the respective position
244 *@param x the query parameter to pass
245 *@return array entry for the query parameters to use
247 struct GNUNET_MY_QueryParam
248 GNUNET_MY_query_param_rsa_signature (const struct GNUNET_CRYPTO_RsaSignature *x);
251 * Generate query parameter for an absolute time value.
252 * The database must store a 64-bit integer.
254 *@param x pointer to the query parameter to pass
255 *@return array entry for the query parameters to use
257 struct GNUNET_MY_QueryParam
258 GNUNET_MY_query_param_absolute_time (const struct GNUNET_TIME_Absolute *x);
261 * Generate query parameter for an absolute time value.
262 * The database must store a 64-bit integer.
264 *@param x pointer to the query parameter to pass
266 struct GNUNET_MY_QueryParam
267 GNUNET_MY_query_param_absolute_time_nbo (const struct GNUNET_TIME_AbsoluteNBO *x);
270 * Generate query parameter for an uint16_t in host byte order.
272 * @param x pointer to the query parameter to pass
274 struct GNUNET_MY_QueryParam
275 GNUNET_MY_query_param_uint16 (const uint16_t *x);
278 * Generate query parameter for an uint32_t in host byte order
280 *@param x pointer to the query parameter to pass
282 struct GNUNET_MY_QueryParam
283 GNUNET_MY_query_param_uint32 (const uint32_t *x);
286 * Generate query parameter for an uint64_t in host byte order
288 *@param x pointer to the query parameter to pass
290 struct GNUNET_MY_QueryParam
291 GNUNET_MY_query_param_uint64 (const uint64_t *x);
294 * We expect a fixed-size result, with size determined by the type of `* dst`
296 * @spec name name of the field in the table
297 * @spec dst point to where to store the result, type fits expected result size
298 * @return array entry for the result specification to use
300 #define GNUNET_MY_result_spec_auto_from_type(dst) GNUNET_MY_result_spec_fixed_size ((dst), sizeof (*(dst)))
309 * Variable-size result expected
311 * @param[out] dst where to store the result, allocated
312 * @param[out] sptr where to store the size of @a dst
313 * @return array entru for the result specification to use
315 struct GNUNET_MY_ResultSpec
316 GNUNET_MY_result_spec_variable_size (void **dst,
319 * RSA public key expected
321 * @param name name of the field in the table
322 * @param[out] rsa where to store the result
323 * @return array entry for the result specification to use
325 struct GNUNET_MY_ResultSpec
326 GNUNET_MY_result_spec_rsa_public_key (struct GNUNET_CRYPTO_RsaPublicKey **rsa);
329 * RSA signature expected.
331 * @param[out] sig where to store the result;
332 * @return array entry for the result specification to use
334 struct GNUNET_MY_ResultSpec
335 GNUNET_MY_result_spec_rsa_signature (struct GNUNET_CRYPTO_RsaSignature **sig);
338 * 0- terminated string exprected.
340 * @param[out] dst where to store the result, allocated
341 * @return array entry for the result specification to use
343 struct GNUNET_MY_ResultSpec
344 GNUNET_MY_result_spec_string (char **dst);
347 * Absolute time expected
349 * @param name name of the field in the table
350 * @param[out] at where to store the result
351 * @return array entry for the result specification to use
353 struct GNUNET_MY_ResultSpec
354 GNUNET_MY_result_spec_absolute_time (struct GNUNET_TIME_Absolute *at);
357 * Absolute time in network byte order expected
359 * @param[out] at where to store the result
360 * @return array entry for the result specification to use
362 struct GNUNET_MY_ResultSpec
363 GNUNET_MY_result_spec_absolute_time_nbo (struct GNUNET_TIME_AbsoluteNBO *at);
368 * @param[out] u16 where to store the result
369 * @return array entry for the result specification to use
371 struct GNUNET_MY_ResultSpec
372 GNUNET_MY_result_spec_uint16 (uint16_t *u16);
377 * @param[out] u32 where to store the result
378 * @return array entry for the result specification to use
380 struct GNUNET_MY_ResultSpec
381 GNUNET_MY_result_spec_uint32 (uint32_t *u32);
386 * @param[out] u64 where to store the result
387 * @return array entry for the result specification to use
389 struct GNUNET_MY_ResultSpec
390 GNUNET_MY_result_spec_uint64 (uint64_t *u64);
393 GNUNET_MY_extract_result (struct GNUNET_MYSQL_StatementHandle *sh,
394 struct GNUNET_MY_QueryParam *qp,
395 struct GNUNET_MY_ResultSpec *specs,
398 #if 0 /* keep Emacsens' auto-indent happy */
407 /** @} */ /* end of group */