commit 18a7b7fe003abc65b9f03e23a8998f3dfb6148b6
parent e3d4b6e27296916afb5fa675b0534d6212a4927f
Author: Matyja Lukas Adam <lukas.matyja@students.bfh.ch>
Date: Tue, 16 Jan 2024 14:45:06 +0100
[lib] adjust charity get API
Diffstat:
2 files changed, 341 insertions(+), 36 deletions(-)
diff --git a/src/lib/donau_api_charities_get.c b/src/lib/donau_api_charities_get.c
@@ -0,0 +1,305 @@
+/*
+ This file is part of TALER
+ Copyright (C) 2024 Taler Systems SA
+
+ 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
+ CHARITYABILITY 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, see
+ <http://www.gnu.org/licenses/>
+*/
+
+/**
+ * @file lib/donau_api_charities_get.c
+ * @brief Implementation of the "handle" component of the donau's HTTP API
+ * @author Lukas Matyja
+ */
+#include <gnunet/gnunet_curl_lib.h>
+#include <taler/taler_json_lib.h>
+#include "donau_service.h"
+#include "donau_api_curl_defaults.h"
+#include "donau_json_lib.h"
+
+
+/**
+ * Handle for a GET /charities/$CHARITY_ID request.
+ */
+struct DONAU_CharitiesGetHandle
+{
+ /**
+ * The url for the /charities/$CHARITY_ID request.
+ */
+ char *url;
+
+ /**
+ * Entry for this request with the `struct GNUNET_CURL_Context`.
+ */
+ struct GNUNET_CURL_Job *job;
+
+ /**
+ * Function to call with the result.
+ */
+ DONAU_GetCharitiesResponseCallback cb;
+
+ /**
+ * Charity id we are querying.
+ */
+ uint64_t charity_id;
+
+ /**
+ * Closure to pass to @e cb.
+ */
+ void *cb_cls;
+
+};
+
+/**
+ * Decode the JSON in @a resp_obj from the /charities/$ID response
+ * and store the data in the @a charity_data.
+ *
+ * @param[in] resp_obj JSON object to parse
+ * @param[out] charity_data where to store the results we decoded
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
+ * (malformed JSON)
+ */
+static enum GNUNET_GenericReturnValue
+handle_charities_get_ok (const json_t *resp_obj,
+ struct DONAU_CharityGetHandle *cgh)
+{
+ const json_t *charity_hist_array;
+ const char *name;
+ if (JSON_OBJECT != json_typeof (resp_obj))
+ {
+ GNUNET_break_op (0);
+ return GNUNET_SYSERR;
+ }
+ struct DONAU_GetCharityResponse charity_resp = {
+ .hr.reply = resp_obj,
+ .hr.http_status = MHD_HTTP_OK
+ };
+ struct GNUNET_JSON_Specification spec[] = {
+ GNUNET_JSON_spec_string ("name",
+ &name),
+ GNUNET_JSON_spec_fixed_auto ("charity_pub",
+ &charity_resp.details.ok.charity->charity_pub),
+ TALER_JSON_spec_amount_any ("max_per_year",
+ &charity_resp.details.ok.charity->max_per_year),
+ TALER_JSON_spec_amount_any ("receipts_to_date",
+ &charty_resp.details.ok.charity->receipts_to_date),
+ GNUNET_JSON_spec_uint32 ("current_year",
+ &charity_resp.details.ok.charity->current_year),
+ GNUNET_JSON_spec_end ()
+ };
+
+ if (GNUNET_OK !=
+ GNUNET_JSON_parse (resp_obj,
+ spec,
+ NULL,
+ NULL))
+ {
+ GNUNET_break_op (0);
+ return GNUNET_SYSERR;
+ }
+ charity_resp.details.ok.charity->name = GNUNET_strdup (name);
+
+ // /* parse the charity history data */
+ // charity_resp.details.ok.charity->num_hist
+ // = json_array_size (charity_hist_array);
+ // if (0 != charity_resp.details.ok.charity->num_hist)
+ // {
+ // json_t *charity_history_obj;
+ // unsigned int index;
+
+ // charity_resp.details.ok.charity->donation_history
+ // = GNUNET_new_array (charity_resp.details.ok.charity->num_hist,
+ // struct DONAU_CharityHistoryYear);
+ // json_array_foreach (charity_hist_array, index, charity_history_obj) {
+ // struct DONAU_CharityHistoryYear *donation_history = &charity_resp.details.ok.charity->donation_history[index];
+ // struct GNUNET_JSON_Specification history_spec[] = {
+ // TALER_JSON_spec_amount_any ("final_amount",
+ // &donation_history->final_amount),
+ // GNUNET_JSON_spec_uint32 ("year",
+ // &donation_history->year),
+ // GNUNET_JSON_spec_end ()
+ // };
+
+ // if (GNUNET_OK !=
+ // GNUNET_JSON_parse (charity_history_obj,
+ // history_spec,
+ // NULL, NULL))
+ // {
+ // GNUNET_break_op (0);
+ // return GNUNET_SYSERR;
+ // }
+ // }
+ // }
+
+ cgh->cb (cgh->cb_cls,
+ &charity_resp);
+ cgh->cb = NULL;
+ return GNUNET_OK;
+}
+
+
+/**
+ * Callback used when downloading the reply to a /charity request
+ * is complete.
+ *
+ * @param cls the `struct KeysRequest`
+ * @param response_code HTTP response code, 0 on error
+ * @param resp_obj parsed JSON result, NULL on error
+ */
+static void
+handle_charities_get_finished (void *cls,
+ long response_code,
+ const void *resp_obj)
+{
+ //struct DONAU_Charity *cd = NULL;
+
+ struct DONAU_CharityGetHandle *cgh = cls;
+ const json_t *j = resp_obj;
+ struct DONAU_GetCharityResponse gcresp = {
+ .hr.reply = j,
+ .hr.http_status = (unsigned int) response_code
+ };
+
+ cgh->job = NULL;
+ switch (response_code)
+ {
+ case 0:
+ gcresp.hr.ec = TALER_EC_GENERIC_INVALID_RESPONSE;
+ break;
+ case MHD_HTTP_OK:
+ if (GNUNET_OK !=
+ handle_charity_get_ok (j,
+ cgh))
+ {
+ gcresp.hr.http_status = 0;
+ gcresp.hr.ec = TALER_EC_GENERIC_REPLY_MALFORMED;
+ }
+ break;
+ case MHD_HTTP_BAD_REQUEST:
+ /* This should never happen, either us or the donau is buggy
+ (or API version conflict); just pass JSON reply to the application */
+ gcresp.hr.ec = TALER_JSON_get_error_code (j);
+ gcresp.hr.hint = TALER_JSON_get_error_hint (j);
+ break;
+ case MHD_HTTP_NOT_FOUND:
+ /* Nothing really to verify, this should never
+ happen, we should pass the JSON reply to the application */
+ gcresp.hr.ec = TALER_JSON_get_error_code (j);
+ gcresp.hr.hint = TALER_JSON_get_error_hint (j);
+ break;
+ case MHD_HTTP_INTERNAL_SERVER_ERROR:
+ /* Server had an internal issue; we should retry, but this API
+ leaves this to the application */
+ gcresp.hr.ec = TALER_JSON_get_error_code (j);
+ gcresp.hr.hint = TALER_JSON_get_error_hint (j);
+ break;
+ default:
+ /* unexpected response code */
+ GNUNET_break_op (0);
+ gcresp.hr.ec = TALER_JSON_get_error_code (j);
+ gcresp.hr.hint = TALER_JSON_get_error_hint (j);
+ GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+ "Unexpected response code %u/%d for GET %s\n",
+ (unsigned int) response_code,
+ (int) gcresp.hr.ec,
+ cgh->url);
+ break;
+ }
+ if (NULL != cgh->cb)
+ {
+ cgh->cb (cgh->cb_cls,
+ &gcresp);
+ cgh->cb = NULL;
+ }
+ DONAU_charity_get_cancel (cgh);
+}
+
+struct DONAU_CharityGetHandle *
+DONAU_charities_get (
+ struct GNUNET_CURL_Context *ctx,
+ const char *url,
+ const uint64_t id,
+ const struct DONAU_BearerToken bearer, //TODO: check authorization
+ struct GNUNET_TIME_Relative timeout,
+ DONAU_GetCharityResponseCallback cb,
+ void *cb_cls)
+{
+ struct DONAU_CharityGetHandle *cgh;
+ CURL *eh;
+
+ TALER_LOG_DEBUG ("Connecting to the donau (%s)\n",
+ url);
+ cgh = GNUNET_new (struct DONAU_CharityGetHandle);
+ cgh->url = GNUNET_strdup (url);
+ cgh->cb = cb;
+ cgh->charity_id = id;
+ cgh->cb_cls = cb_cls;
+ char arg_str[sizeof (id) * 2 + 32];
+ char id_str[sizeof (id) * 2];
+ char *end;
+ char timeout_str[32];
+
+ end = GNUNET_STRINGS_data_to_string (&id,
+ sizeof (id),
+ id_str,
+ sizeof (id_str));
+ *end = '\0';
+ GNUNET_snprintf (timeout_str,
+ sizeof (timeout_str),
+ "%llu",
+ (unsigned long long)
+ (timeout.rel_value_us
+ / GNUNET_TIME_UNIT_MILLISECONDS.rel_value_us));
+ GNUNET_snprintf (arg_str,
+ sizeof (arg_str),
+ "charities/%s",
+ id_str);
+ cgh->url = TALER_url_join (url,
+ arg_str,
+ NULL);
+ if (NULL == cgh->url)
+ {
+ GNUNET_free (cgh);
+ return NULL;
+ }
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+ "Requesting a charity with URL `%s'.\n",
+ cgh->url);
+ eh = DONAU_curl_easy_get_ (cgh->url);
+ if (NULL == eh)
+ {
+ GNUNET_break (0);
+ GNUNET_free (cgh->url);
+ GNUNET_free (cgh);
+ return NULL;
+ }
+ cgh->job = GNUNET_CURL_job_add (ctx,
+ eh,
+ &handle_charity_get_finished,
+ cgh);
+ return cgh;
+}
+
+void
+DONAU_charities_get_cancel (
+ struct DONAU_CharityGetHandle *cgh)
+{
+ if (NULL != cgh->job)
+ {
+ GNUNET_CURL_job_cancel (cgh->job);
+ cgh->job = NULL;
+ }
+ GNUNET_free (cgh->url);
+ GNUNET_free (cgh);
+}
+\ No newline at end of file
diff --git a/src/lib/donau_api_charity_get.c b/src/lib/donau_api_charity_get.c
@@ -74,7 +74,7 @@ static enum GNUNET_GenericReturnValue
handle_charity_get_ok (const json_t *resp_obj,
struct DONAU_CharityGetHandle *cgh)
{
- const json_t *charity_hist_array;
+ //const json_t *charity_hist_array;
const char *name;
if (JSON_OBJECT != json_typeof (resp_obj))
{
@@ -88,17 +88,16 @@ handle_charity_get_ok (const json_t *resp_obj,
struct GNUNET_JSON_Specification spec[] = {
GNUNET_JSON_spec_string ("name",
&name),
- GNUNET_JSON_spec_fixed_auto ("pub_key",
- &charity_resp.details.ok.charity->pub_key),
+ GNUNET_JSON_spec_fixed_auto ("charity_pub",
+ &charity_resp.details.ok.charity->charity_pub),
TALER_JSON_spec_amount_any ("max_per_year",
&charity_resp.details.ok.charity->max_per_year),
- GNUNET_JSON_spec_array_const ("donation_history",
- &charity_hist_array),
- GNUNET_JSON_spec_uint32 ("num_hist",
- &charity_resp.details.ok.charity->num_hist),
+ TALER_JSON_spec_amount_any ("receipts_to_date",
+ &charity_resp.details.ok.charity->receipts_to_date),
+ GNUNET_JSON_spec_uint32 ("current_year",
+ &charity_resp.details.ok.charity->current_year),
GNUNET_JSON_spec_end ()
};
-
if (GNUNET_OK !=
GNUNET_JSON_parse (resp_obj,
spec,
@@ -111,36 +110,36 @@ handle_charity_get_ok (const json_t *resp_obj,
charity_resp.details.ok.charity->name = GNUNET_strdup (name);
/* parse the charity history data */
- charity_resp.details.ok.charity->num_hist
- = json_array_size (charity_hist_array);
- if (0 != charity_resp.details.ok.charity->num_hist)
- {
- json_t *charity_history_obj;
- unsigned int index;
+ // charity_resp.details.ok.charity->num_hist
+ // = json_array_size (charity_hist_array);
+ // if (0 != charity_resp.details.ok.charity->num_hist)
+ // {
+ // json_t *charity_history_obj;
+ // unsigned int index;
- charity_resp.details.ok.charity->donation_history
- = GNUNET_new_array (charity_resp.details.ok.charity->num_hist,
- struct DONAU_CharityHistoryYear);
- json_array_foreach (charity_hist_array, index, charity_history_obj) {
- struct DONAU_CharityHistoryYear *donation_history = &charity_resp.details.ok.charity->donation_history[index];
- struct GNUNET_JSON_Specification history_spec[] = {
- TALER_JSON_spec_amount_any ("final_amount",
- &donation_history->final_amount),
- GNUNET_JSON_spec_uint32 ("year",
- &donation_history->year),
- GNUNET_JSON_spec_end ()
- };
+ // charity_resp.details.ok.charity->donation_history
+ // = GNUNET_new_array (charity_resp.details.ok.charity->num_hist,
+ // struct DONAU_CharityHistoryYear);
+ // json_array_foreach (charity_hist_array, index, charity_history_obj) {
+ // struct DONAU_CharityHistoryYear *donation_history = &charity_resp.details.ok.charity->donation_history[index];
+ // struct GNUNET_JSON_Specification history_spec[] = {
+ // TALER_JSON_spec_amount_any ("final_amount",
+ // &donation_history->final_amount),
+ // GNUNET_JSON_spec_uint32 ("year",
+ // &donation_history->year),
+ // GNUNET_JSON_spec_end ()
+ // };
- if (GNUNET_OK !=
- GNUNET_JSON_parse (charity_history_obj,
- history_spec,
- NULL, NULL))
- {
- GNUNET_break_op (0);
- return GNUNET_SYSERR;
- }
- }
- }
+ // if (GNUNET_OK !=
+ // GNUNET_JSON_parse (charity_history_obj,
+ // history_spec,
+ // NULL, NULL))
+ // {
+ // GNUNET_break_op (0);
+ // return GNUNET_SYSERR;
+ // }
+ // }
+ //}
cgh->cb (cgh->cb_cls,
&charity_resp);
