123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876 |
- /*
- This file is part of GNUnet
- Copyright (C) 2014, 2015, 2016 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 pq/pq_result_helper.c
- * @brief functions to extract result values
- * @author Christian Grothoff
- */
- #include "platform.h"
- #include "gnunet_util_lib.h"
- #include "gnunet_pq_lib.h"
- /**
- * Function called to clean up memory allocated
- * by a #GNUNET_PQ_ResultConverter.
- *
- * @param cls closure
- * @param rd result data to clean up
- */
- static void
- clean_varsize_blob (void *cls,
- void *rd)
- {
- void **dst = rd;
- (void) cls;
- if (NULL != *dst)
- {
- GNUNET_free (*dst);
- *dst = NULL;
- }
- }
- /**
- * Extract data from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param int row to extract data from
- * @param fname name (or prefix) of the fields to extract 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)
- */
- static int
- extract_varsize_blob (void *cls,
- PGresult *result,
- int row,
- const char *fname,
- size_t *dst_size,
- void *dst)
- {
- size_t len;
- const char *res;
- void *idst;
- int fnum;
- (void) cls;
- *dst_size = 0;
- *((void **) dst) = NULL;
- fnum = PQfnumber (result,
- fname);
- if (fnum < 0)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- if (PQgetisnull (result,
- row,
- fnum))
- {
- /* Let's allow this for varsize */
- return GNUNET_OK;
- }
- /* if a field is null, continue but
- * remember that we now return a different result */
- len = PQgetlength (result,
- row,
- fnum);
- res = PQgetvalue (result,
- row,
- fnum);
- GNUNET_assert (NULL != res);
- *dst_size = len;
- idst = GNUNET_malloc (len);
- *((void **) dst) = idst;
- GNUNET_memcpy (idst,
- res,
- len);
- return GNUNET_OK;
- }
- /**
- * 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 GNUNET_PQ_ResultSpec
- GNUNET_PQ_result_spec_variable_size (const char *name,
- void **dst,
- size_t *sptr)
- {
- struct GNUNET_PQ_ResultSpec res =
- { &extract_varsize_blob,
- &clean_varsize_blob, NULL,
- (void *) (dst), 0, name, sptr };
- return res;
- }
- /**
- * Extract data from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param int row to extract data from
- * @param fname name (or prefix) of the fields to extract from
- * @param[in] dst_size desired size, never 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,
- PGresult *result,
- int row,
- const char *fname,
- size_t *dst_size,
- void *dst)
- {
- size_t len;
- const char *res;
- int fnum;
- (void) cls;
- fnum = PQfnumber (result,
- fname);
- if (fnum < 0)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- if (PQgetisnull (result,
- row,
- fnum))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- /* if a field is null, continue but
- * remember that we now return a different result */
- len = PQgetlength (result,
- row,
- fnum);
- if (*dst_size != len)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- res = PQgetvalue (result,
- row,
- fnum);
- GNUNET_assert (NULL != res);
- GNUNET_memcpy (dst,
- res,
- len);
- return GNUNET_OK;
- }
- /**
- * Fixed-size result expected.
- *
- * @param name name of the field in the table
- * @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_PQ_ResultSpec
- GNUNET_PQ_result_spec_fixed_size (const char *name,
- void *dst,
- size_t dst_size)
- {
- struct GNUNET_PQ_ResultSpec res =
- { &extract_fixed_blob,
- NULL, NULL,
- (dst), dst_size, name, NULL };
- return res;
- }
- /**
- * Extract data from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param int row to extract data from
- * @param fname name (or prefix) of the fields to extract 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_public_key (void *cls,
- PGresult *result,
- int row,
- const char *fname,
- size_t *dst_size,
- void *dst)
- {
- struct GNUNET_CRYPTO_RsaPublicKey **pk = dst;
- size_t len;
- const char *res;
- int fnum;
- (void) cls;
- *pk = NULL;
- fnum = PQfnumber (result,
- fname);
- if (fnum < 0)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- if (PQgetisnull (result,
- row,
- fnum))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- /* if a field is null, continue but
- * remember that we now return a different result */
- len = PQgetlength (result,
- row,
- fnum);
- res = PQgetvalue (result,
- row,
- fnum);
- *pk = GNUNET_CRYPTO_rsa_public_key_decode (res,
- len);
- 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
- * @param rd result data to clean up
- */
- static void
- clean_rsa_public_key (void *cls,
- void *rd)
- {
- struct GNUNET_CRYPTO_RsaPublicKey **pk = rd;
- (void) cls;
- if (NULL != *pk)
- {
- GNUNET_CRYPTO_rsa_public_key_free (*pk);
- *pk = NULL;
- }
- }
- /**
- * 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 GNUNET_PQ_ResultSpec
- GNUNET_PQ_result_spec_rsa_public_key (const char *name,
- struct GNUNET_CRYPTO_RsaPublicKey **rsa)
- {
- struct GNUNET_PQ_ResultSpec res =
- { &extract_rsa_public_key,
- &clean_rsa_public_key,
- NULL,
- (void *) rsa, 0, name, NULL };
- return res;
- }
- /**
- * Extract data from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param int row to extract data from
- * @param fname name (or prefix) of the fields to extract 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_signature (void *cls,
- PGresult *result,
- int row,
- const char *fname,
- size_t *dst_size,
- void *dst)
- {
- struct GNUNET_CRYPTO_RsaSignature **sig = dst;
- size_t len;
- const char *res;
- int fnum;
- (void) cls;
- *sig = NULL;
- fnum = PQfnumber (result,
- fname);
- if (fnum < 0)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- if (PQgetisnull (result,
- row,
- fnum))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- /* if a field is null, continue but
- * remember that we now return a different result */
- len = PQgetlength (result,
- row,
- fnum);
- res = PQgetvalue (result,
- row,
- fnum);
- *sig = GNUNET_CRYPTO_rsa_signature_decode (res,
- len);
- 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 closure
- * @param rd result data to clean up
- */
- static void
- clean_rsa_signature (void *cls,
- void *rd)
- {
- struct GNUNET_CRYPTO_RsaSignature **sig = rd;
- (void) cls;
- if (NULL != *sig)
- {
- GNUNET_CRYPTO_rsa_signature_free (*sig);
- *sig = NULL;
- }
- }
- /**
- * 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 GNUNET_PQ_ResultSpec
- GNUNET_PQ_result_spec_rsa_signature (const char *name,
- struct GNUNET_CRYPTO_RsaSignature **sig)
- {
- struct GNUNET_PQ_ResultSpec res =
- { &extract_rsa_signature,
- &clean_rsa_signature,
- NULL,
- (void *) sig, 0, (name), NULL };
- return res;
- }
- /**
- * Extract data from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param int row to extract data from
- * @param fname name (or prefix) of the fields to extract 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_string (void *cls,
- PGresult *result,
- int row,
- const char *fname,
- size_t *dst_size,
- void *dst)
- {
- char **str = dst;
- size_t len;
- const char *res;
- int fnum;
- (void) cls;
- *str = NULL;
- fnum = PQfnumber (result,
- fname);
- if (fnum < 0)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- if (PQgetisnull (result,
- row,
- fnum))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- /* if a field is null, continue but
- * remember that we now return a different result */
- len = PQgetlength (result,
- row,
- fnum);
- res = PQgetvalue (result,
- row,
- fnum);
- *str = GNUNET_strndup (res,
- len);
- if (NULL == *str)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- return GNUNET_OK;
- }
- /**
- * Function called to clean up memory allocated
- * by a #GNUNET_PQ_ResultConverter.
- *
- * @param cls closure
- * @param rd result data to clean up
- */
- static void
- clean_string (void *cls,
- void *rd)
- {
- char **str = rd;
- (void) cls;
- if (NULL != *str)
- {
- GNUNET_free (*str);
- *str = NULL;
- }
- }
- /**
- * 0-terminated string expected.
- *
- * @param name name of the field in the table
- * @param[out] dst where to store the result, allocated
- * @return array entry for the result specification to use
- */
- struct GNUNET_PQ_ResultSpec
- GNUNET_PQ_result_spec_string (const char *name,
- char **dst)
- {
- struct GNUNET_PQ_ResultSpec res =
- { &extract_string,
- &clean_string,
- NULL,
- (void *) dst, 0, (name), NULL };
- return res;
- }
- /**
- * Extract data from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param int row to extract data from
- * @param fname name (or prefix) of the fields to extract 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,
- PGresult *result,
- int row,
- const char *fname,
- size_t *dst_size,
- void *dst)
- {
- struct GNUNET_TIME_Absolute *udst = dst;
- const int64_t *res;
- int fnum;
- (void) cls;
- fnum = PQfnumber (result,
- fname);
- if (fnum < 0)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- if (PQgetisnull (result,
- row,
- fnum))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- GNUNET_assert (NULL != dst);
- if (sizeof (struct GNUNET_TIME_Absolute) != *dst_size)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- if (sizeof (int64_t) !=
- PQgetlength (result,
- row,
- fnum))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- res = (int64_t *) PQgetvalue (result,
- row,
- fnum);
- if (INT64_MAX == *res)
- *udst = GNUNET_TIME_UNIT_FOREVER_ABS;
- else
- udst->abs_value_us = GNUNET_ntohll ((uint64_t) *res);
- return GNUNET_OK;
- }
- /**
- * 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 GNUNET_PQ_ResultSpec
- GNUNET_PQ_result_spec_absolute_time (const char *name,
- struct GNUNET_TIME_Absolute *at)
- {
- struct GNUNET_PQ_ResultSpec res =
- { &extract_abs_time,
- NULL,
- NULL,
- (void *) at, sizeof (*at), (name), NULL };
- return res;
- }
- /**
- * Absolute time in network byte order 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 GNUNET_PQ_ResultSpec
- GNUNET_PQ_result_spec_absolute_time_nbo (const char *name,
- struct GNUNET_TIME_AbsoluteNBO *at)
- {
- struct GNUNET_PQ_ResultSpec res =
- GNUNET_PQ_result_spec_auto_from_type(name, &at->abs_value_us__);
- return res;
- }
- /**
- * Extract data from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param int row to extract data from
- * @param fname name (or prefix) of the fields to extract 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,
- PGresult *result,
- int row,
- const char *fname,
- size_t *dst_size,
- void *dst)
- {
- uint16_t *udst = dst;
- const uint16_t *res;
- int fnum;
- (void) cls;
- fnum = PQfnumber (result,
- fname);
- if (fnum < 0)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- if (PQgetisnull (result,
- row,
- fnum))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- GNUNET_assert (NULL != dst);
- if (sizeof (uint16_t) != *dst_size)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- if (sizeof (uint16_t) !=
- PQgetlength (result,
- row,
- fnum))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- res = (uint16_t *) PQgetvalue (result,
- row,
- fnum);
- *udst = ntohs (*res);
- return GNUNET_OK;
- }
- /**
- * 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 GNUNET_PQ_ResultSpec
- GNUNET_PQ_result_spec_uint16 (const char *name,
- uint16_t *u16)
- {
- struct GNUNET_PQ_ResultSpec res =
- { &extract_uint16,
- NULL,
- NULL,
- (void *) u16, sizeof (*u16), (name), NULL };
- return res;
- }
- /**
- * Extract data from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param int row to extract data from
- * @param fname name (or prefix) of the fields to extract 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,
- PGresult *result,
- int row,
- const char *fname,
- size_t *dst_size,
- void *dst)
- {
- uint32_t *udst = dst;
- const uint32_t *res;
- int fnum;
- (void) cls;
- fnum = PQfnumber (result,
- fname);
- if (fnum < 0)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- if (PQgetisnull (result,
- row,
- fnum))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- GNUNET_assert (NULL != dst);
- if (sizeof (uint32_t) != *dst_size)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- if (sizeof (uint32_t) !=
- PQgetlength (result,
- row,
- fnum))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- res = (uint32_t *) PQgetvalue (result,
- row,
- fnum);
- *udst = ntohl (*res);
- return GNUNET_OK;
- }
- /**
- * 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 GNUNET_PQ_ResultSpec
- GNUNET_PQ_result_spec_uint32 (const char *name,
- uint32_t *u32)
- {
- struct GNUNET_PQ_ResultSpec res =
- { &extract_uint32,
- NULL,
- NULL,
- (void *) u32, sizeof (*u32), (name), NULL };
- return res;
- }
- /**
- * Extract data from a Postgres database @a result at row @a row.
- *
- * @param cls closure
- * @param result where to extract data from
- * @param int row to extract data from
- * @param fname name (or prefix) of the fields to extract 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,
- PGresult *result,
- int row,
- const char *fname,
- size_t *dst_size,
- void *dst)
- {
- uint64_t *udst = dst;
- const uint64_t *res;
- int fnum;
- (void) cls;
- fnum = PQfnumber (result,
- fname);
- if (fnum < 0)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- if (PQgetisnull (result,
- row,
- fnum))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- GNUNET_assert (NULL != dst);
- if (sizeof (uint64_t) != *dst_size)
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- if (sizeof (uint64_t) !=
- PQgetlength (result,
- row,
- fnum))
- {
- GNUNET_break (0);
- return GNUNET_SYSERR;
- }
- res = (uint64_t *) PQgetvalue (result,
- row,
- fnum);
- *udst = GNUNET_ntohll (*res);
- return GNUNET_OK;
- }
- /**
- * 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 GNUNET_PQ_ResultSpec
- GNUNET_PQ_result_spec_uint64 (const char *name,
- uint64_t *u64)
- {
- struct GNUNET_PQ_ResultSpec res =
- { &extract_uint64,
- NULL,
- NULL,
- (void *) u64, sizeof (*u64), (name), NULL };
- return res;
- }
- /* end of pq_result_helper.c */
|