123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786 |
- /*
- This file is part of GNUnet
- Copyright (C) 2017 GNUnet e.V.
- GNUnet is free software: you can redistribute it and/or modify it
- under the terms of the GNU Affero General Public License as published
- by the Free Software Foundation, either version 3 of the License,
- or (at your option) any later version.
- GNUnet 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
- Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <http://www.gnu.org/licenses/>.
- SPDX-License-Identifier: AGPL3.0-or-later
- */
- /**
- * @file sq/sq_result_helper.c
- * @brief helper functions for queries
- * @author Christian Grothoff
- */
- #include "platform.h"
- #include "gnunet_sq_lib.h"
- /**
- * Extract variable-sized binary data from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param column column to extract data from
- * @param[in,out] dst_size where to store size of result, may be NULL
- * @param[out] dst where to store the result (actually a `void **`)
- * @return
- * #GNUNET_YES if all results could be extracted
- * #GNUNET_SYSERR if a result was invalid (non-existing field or NULL)
- */
- static int
- extract_var_blob (void *cls,
- sqlite3_stmt *result,
- unsigned int column,
- size_t *dst_size,
- void *dst)
- {
- int have;
- const void *ret;
- void **rdst = (void **) dst;
- if (SQLITE_NULL ==
- sqlite3_column_type (result,
- column))
- {
- *rdst = NULL;
- *dst_size = 0;
- return GNUNET_YES;
- }
- if (SQLITE_BLOB !=
- sqlite3_column_type (result,
- column))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- /* sqlite manual says to invoke 'sqlite3_column_blob()'
- before calling sqlite3_column_bytes() */
- ret = sqlite3_column_blob (result,
- column);
- have = sqlite3_column_bytes (result,
- column);
- if (have < 0)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- *dst_size = have;
- if (0 == have)
- {
- *rdst = NULL;
- return GNUNET_OK;
- }
- *rdst = GNUNET_malloc (have);
- GNUNET_memcpy (*rdst,
- ret,
- have);
- return GNUNET_OK;
- }
- /**
- * Cleanup memory allocated by #extract_var_blob().
- *
- * @param cls pointer to pointer of allocation
- */
- static void
- clean_var_blob (void *cls)
- {
- void **dptr = (void **) cls;
- if (NULL != *dptr)
- {
- GNUNET_free (*dptr);
- *dptr = NULL;
- }
- }
- /**
- * Variable-size result expected.
- *
- * @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 GNUNET_SQ_ResultSpec
- GNUNET_SQ_result_spec_variable_size (void **dst,
- size_t *sptr)
- {
- struct GNUNET_SQ_ResultSpec rs = {
- .conv = &extract_var_blob,
- .cleaner = &clean_var_blob,
- .dst = dst,
- .cls = dst,
- .result_size = sptr,
- .num_params = 1
- };
- return rs;
- }
- /**
- * Extract fixed-sized binary data from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param column column to extract data from
- * @param[in,out] dst_size where to store size of result, may be NULL
- * @param[out] dst where to store the result
- * @return
- * #GNUNET_YES if all results could be extracted
- * #GNUNET_SYSERR if a result was invalid (non-existing field or NULL)
- */
- static int
- extract_fixed_blob (void *cls,
- sqlite3_stmt *result,
- unsigned int column,
- size_t *dst_size,
- void *dst)
- {
- int have;
- const void *ret;
- if ( (0 == *dst_size) &&
- (SQLITE_NULL ==
- sqlite3_column_type (result,
- column)) )
- {
- return GNUNET_YES;
- }
- if (SQLITE_BLOB !=
- sqlite3_column_type (result,
- column))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- /* sqlite manual says to invoke 'sqlite3_column_blob()'
- before calling sqlite3_column_bytes() */
- ret = sqlite3_column_blob (result,
- column);
- have = sqlite3_column_bytes (result,
- column);
- if (*dst_size != have)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- GNUNET_memcpy (dst,
- ret,
- have);
- return GNUNET_OK;
- }
- /**
- * Fixed-size result expected.
- *
- * @param[out] dst where to store the result
- * @param dst_size number of bytes in @a dst
- * @return array entry for the result specification to use
- */
- struct GNUNET_SQ_ResultSpec
- GNUNET_SQ_result_spec_fixed_size (void *dst,
- size_t dst_size)
- {
- struct GNUNET_SQ_ResultSpec rs = {
- .conv = &extract_fixed_blob,
- .dst = dst,
- .dst_size = dst_size,
- .num_params = 1
- };
- return rs;
- }
- /**
- * Extract fixed-sized binary data from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param column column to extract data from
- * @param[in,out] dst_size where to store size of result, may be NULL
- * @param[out] dst where to store the result
- * @return
- * #GNUNET_YES if all results could be extracted
- * #GNUNET_SYSERR if a result was invalid (non-existing field or NULL)
- */
- static int
- extract_utf8_string (void *cls,
- sqlite3_stmt *result,
- unsigned int column,
- size_t *dst_size,
- void *dst)
- {
- const char *text;
- char **rdst = dst;
- if (SQLITE_NULL ==
- sqlite3_column_type (result,
- column))
- {
- *rdst = NULL;
- return GNUNET_OK;
- }
- if (SQLITE_TEXT !=
- sqlite3_column_type (result,
- column))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- /* sqlite manual guarantees that 'sqlite3_column_text()'
- is 0-terminated */
- text = (const char *) sqlite3_column_text (result,
- column);
- if (NULL == text)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- *dst_size = strlen (text) + 1;
- *rdst = GNUNET_strdup (text);
- return GNUNET_OK;
- }
- /**
- * Cleanup memory allocated by #extract_var_blob().
- *
- * @param cls pointer to pointer of allocation
- */
- static void
- clean_utf8_string (void *cls)
- {
- char **dptr = (char **) cls;
- if (NULL != *dptr)
- {
- GNUNET_free (*dptr);
- *dptr = NULL;
- }
- }
- /**
- * 0-terminated string expected.
- *
- * @param[out] dst where to store the result, allocated
- * @return array entry for the result specification to use
- */
- struct GNUNET_SQ_ResultSpec
- GNUNET_SQ_result_spec_string (char **dst)
- {
- struct GNUNET_SQ_ResultSpec rs = {
- .conv = &extract_utf8_string,
- .cleaner = &clean_utf8_string,
- .cls = dst,
- .dst = dst,
- .num_params = 1
- };
- return rs;
- }
- /**
- * Extract data from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param column column to extract data from
- * @param[in,out] dst_size where to store size of result, may be NULL
- * @param[out] dst where to store the result
- * @return
- * #GNUNET_YES if all results could be extracted
- * #GNUNET_SYSERR if a result was invalid (non-existing field or NULL)
- */
- static int
- extract_rsa_pub (void *cls,
- sqlite3_stmt *result,
- unsigned int column,
- size_t *dst_size,
- void *dst)
- {
- struct GNUNET_CRYPTO_RsaPublicKey **pk = dst;
- int have;
- const void *ret;
- if (SQLITE_BLOB !=
- sqlite3_column_type (result,
- column))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- /* sqlite manual says to invoke 'sqlite3_column_blob()'
- before calling sqlite3_column_bytes() */
- ret = sqlite3_column_blob (result,
- column);
- have = sqlite3_column_bytes (result,
- column);
- if (have < 0)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- *pk = GNUNET_CRYPTO_rsa_public_key_decode (ret,
- have);
- if (NULL == *pk)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- return GNUNET_OK;
- }
- /**
- * Function called to clean up memory allocated
- * by a #GNUNET_PQ_ResultConverter.
- *
- * @param cls closure
- */
- static void
- clean_rsa_pub (void *cls)
- {
- struct GNUNET_CRYPTO_RsaPublicKey **pk = cls;
- if (NULL != *pk)
- {
- GNUNET_CRYPTO_rsa_public_key_free (*pk);
- *pk = NULL;
- }
- }
- /**
- * RSA public key expected.
- *
- * @param[out] rsa where to store the result
- * @return array entry for the result specification to use
- */
- struct GNUNET_SQ_ResultSpec
- GNUNET_SQ_result_spec_rsa_public_key (struct GNUNET_CRYPTO_RsaPublicKey **rsa)
- {
- struct GNUNET_SQ_ResultSpec rs = {
- .conv = &extract_rsa_pub,
- .cleaner = &clean_rsa_pub,
- .dst = rsa,
- .cls = rsa,
- .num_params = 1
- };
- return rs;
- }
- /**
- * Extract data from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param column column to extract data from
- * @param[in,out] dst_size where to store size of result, may be NULL
- * @param[out] dst where to store the result
- * @return
- * #GNUNET_YES if all results could be extracted
- * #GNUNET_SYSERR if a result was invalid (non-existing field or NULL)
- */
- static int
- extract_rsa_sig (void *cls,
- sqlite3_stmt *result,
- unsigned int column,
- size_t *dst_size,
- void *dst)
- {
- struct GNUNET_CRYPTO_RsaSignature **sig = dst;
- int have;
- const void *ret;
- if (SQLITE_BLOB !=
- sqlite3_column_type (result,
- column))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- /* sqlite manual says to invoke 'sqlite3_column_blob()'
- before calling sqlite3_column_bytes() */
- ret = sqlite3_column_blob (result,
- column);
- have = sqlite3_column_bytes (result,
- column);
- if (have < 0)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- *sig = GNUNET_CRYPTO_rsa_signature_decode (ret,
- have);
- if (NULL == *sig)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- return GNUNET_OK;
- }
- /**
- * Function called to clean up memory allocated
- * by a #GNUNET_PQ_ResultConverter.
- *
- * @param cls result data to clean up
- */
- static void
- clean_rsa_sig (void *cls)
- {
- struct GNUNET_CRYPTO_RsaSignature **sig = cls;
- if (NULL != *sig)
- {
- GNUNET_CRYPTO_rsa_signature_free (*sig);
- *sig = NULL;
- }
- }
- /**
- * RSA signature expected.
- *
- * @param[out] sig where to store the result;
- * @return array entry for the result specification to use
- */
- struct GNUNET_SQ_ResultSpec
- GNUNET_SQ_result_spec_rsa_signature (struct GNUNET_CRYPTO_RsaSignature **sig)
- {
- struct GNUNET_SQ_ResultSpec rs = {
- .conv = &extract_rsa_sig,
- .cleaner = &clean_rsa_sig,
- .dst = sig,
- .cls = sig,
- .num_params = 1
- };
- return rs;
- }
- /**
- * Extract absolute time value from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param column column to extract data from
- * @param[in,out] dst_size where to store size of result, may be NULL
- * @param[out] dst where to store the result
- * @return
- * #GNUNET_YES if all results could be extracted
- * #GNUNET_SYSERR if a result was invalid (non-existing field or NULL)
- */
- static int
- extract_abs_time (void *cls,
- sqlite3_stmt *result,
- unsigned int column,
- size_t *dst_size,
- void *dst)
- {
- struct GNUNET_TIME_Absolute *u = dst;
- struct GNUNET_TIME_Absolute t;
- GNUNET_assert (sizeof (uint64_t) == *dst_size);
- if (SQLITE_INTEGER !=
- sqlite3_column_type (result,
- column))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- t.abs_value_us = (uint64_t) sqlite3_column_int64 (result,
- column);
- if (INT64_MAX == t.abs_value_us)
- t = GNUNET_TIME_UNIT_FOREVER_ABS;
- *u = t;
- return GNUNET_OK;
- }
- /**
- * Absolute time expected.
- *
- * @param[out] at where to store the result
- * @return array entry for the result specification to use
- */
- struct GNUNET_SQ_ResultSpec
- GNUNET_SQ_result_spec_absolute_time (struct GNUNET_TIME_Absolute *at)
- {
- struct GNUNET_SQ_ResultSpec rs = {
- .conv = &extract_abs_time,
- .dst = at,
- .dst_size = sizeof (struct GNUNET_TIME_Absolute),
- .num_params = 1
- };
- return rs;
- }
- /**
- * Extract absolute time value in NBO from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param column column to extract data from
- * @param[in,out] dst_size where to store size of result, may be NULL
- * @param[out] dst where to store the result
- * @return
- * #GNUNET_YES if all results could be extracted
- * #GNUNET_SYSERR if a result was invalid (non-existing field or NULL)
- */
- static int
- extract_abs_time_nbo (void *cls,
- sqlite3_stmt *result,
- unsigned int column,
- size_t *dst_size,
- void *dst)
- {
- struct GNUNET_TIME_AbsoluteNBO *u = dst;
- struct GNUNET_TIME_Absolute t;
- GNUNET_assert (sizeof (uint64_t) == *dst_size);
- if (SQLITE_INTEGER !=
- sqlite3_column_type (result,
- column))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- t.abs_value_us = (uint64_t) sqlite3_column_int64 (result,
- column);
- if (INT64_MAX == t.abs_value_us)
- t = GNUNET_TIME_UNIT_FOREVER_ABS;
- *u = GNUNET_TIME_absolute_hton (t);
- return GNUNET_OK;
- }
- /**
- * Absolute time expected.
- *
- * @param[out] at where to store the result
- * @return array entry for the result specification to use
- */
- struct GNUNET_SQ_ResultSpec
- GNUNET_SQ_result_spec_absolute_time_nbo (struct GNUNET_TIME_AbsoluteNBO *at)
- {
- struct GNUNET_SQ_ResultSpec rs = {
- .conv = &extract_abs_time_nbo,
- .dst = at,
- .dst_size = sizeof (struct GNUNET_TIME_AbsoluteNBO),
- .num_params = 1
- };
- return rs;
- }
- /**
- * Extract 16-bit integer from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param column column to extract data from
- * @param[in,out] dst_size where to store size of result, may be NULL
- * @param[out] dst where to store the result
- * @return
- * #GNUNET_YES if all results could be extracted
- * #GNUNET_SYSERR if a result was invalid (non-existing field or NULL)
- */
- static int
- extract_uint16 (void *cls,
- sqlite3_stmt *result,
- unsigned int column,
- size_t *dst_size,
- void *dst)
- {
- uint64_t v;
- uint16_t *u = dst;
- GNUNET_assert (sizeof (uint16_t) == *dst_size);
- if (SQLITE_INTEGER !=
- sqlite3_column_type (result,
- column))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- v = (uint64_t) sqlite3_column_int64 (result,
- column);
- if (v > UINT16_MAX)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- *u = (uint16_t) v;
- return GNUNET_OK;
- }
- /**
- * uint16_t expected.
- *
- * @param[out] u16 where to store the result
- * @return array entry for the result specification to use
- */
- struct GNUNET_SQ_ResultSpec
- GNUNET_SQ_result_spec_uint16 (uint16_t *u16)
- {
- struct GNUNET_SQ_ResultSpec rs = {
- .conv = &extract_uint16,
- .dst = u16,
- .dst_size = sizeof (uint16_t),
- .num_params = 1
- };
- return rs;
- }
- /**
- * Extract 32-bit integer from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param column column to extract data from
- * @param[in,out] dst_size where to store size of result, may be NULL
- * @param[out] dst where to store the result
- * @return
- * #GNUNET_YES if all results could be extracted
- * #GNUNET_SYSERR if a result was invalid (non-existing field or NULL)
- */
- static int
- extract_uint32 (void *cls,
- sqlite3_stmt *result,
- unsigned int column,
- size_t *dst_size,
- void *dst)
- {
- uint64_t v;
- uint32_t *u = dst;
- GNUNET_assert (sizeof (uint32_t) == *dst_size);
- if (SQLITE_INTEGER !=
- sqlite3_column_type (result,
- column))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- v = (uint64_t) sqlite3_column_int64 (result,
- column);
- if (v > UINT32_MAX)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- *u = (uint32_t) v;
- return GNUNET_OK;
- }
- /**
- * uint32_t expected.
- *
- * @param[out] u32 where to store the result
- * @return array entry for the result specification to use
- */
- struct GNUNET_SQ_ResultSpec
- GNUNET_SQ_result_spec_uint32 (uint32_t *u32)
- {
- struct GNUNET_SQ_ResultSpec rs = {
- .conv = &extract_uint32,
- .dst = u32,
- .dst_size = sizeof (uint32_t),
- .num_params = 1
- };
- return rs;
- }
- /**
- * Extract 64-bit integer from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param column column to extract data from
- * @param[in,out] dst_size where to store size of result, may be NULL
- * @param[out] dst where to store the result
- * @return
- * #GNUNET_YES if all results could be extracted
- * #GNUNET_SYSERR if a result was invalid (non-existing field or NULL)
- */
- static int
- extract_uint64 (void *cls,
- sqlite3_stmt *result,
- unsigned int column,
- size_t *dst_size,
- void *dst)
- {
- uint64_t *u = dst;
- GNUNET_assert (sizeof (uint64_t) == *dst_size);
- if (SQLITE_INTEGER !=
- sqlite3_column_type (result,
- column))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- *u = (uint64_t) sqlite3_column_int64 (result,
- column);
- return GNUNET_OK;
- }
- /**
- * uint64_t expected.
- *
- * @param[out] u64 where to store the result
- * @return array entry for the result specification to use
- */
- struct GNUNET_SQ_ResultSpec
- GNUNET_SQ_result_spec_uint64 (uint64_t *u64)
- {
- struct GNUNET_SQ_ResultSpec rs = {
- .conv = &extract_uint64,
- .dst = u64,
- .dst_size = sizeof (uint64_t),
- .num_params = 1
- };
- return rs;
- }
- /* end of sq_result_helper.c */
|