add token family GET and POST handlers to merchant lib

3 files changed, 622 insertions, 0 deletions

diff --git a/src/include/taler_merchant_service.h b/src/include/taler_merchant_service.h
index e8c890b1..057c9eff 100644
--- a/src/include/taler_merchant_service.h
+++ b/src/include/taler_merchant_service.h
@@ -1895,6 +1895,172 @@ TALER_MERCHANT_product_delete_cancel (
   struct TALER_MERCHANT_ProductDeleteHandle *pdh);
 
 
+/* ********************* /tokenfamilies ************************** */
+
+/**
+ * Handle for a GET /tokenfamilies/$SLUG operation.
+ */
+struct TALER_MERCHANT_TokenFamilyGetHandle;
+
+
+/**
+ * Response to GET /tokenfamilies/$SLUG operation.
+ */
+struct TALER_MERCHANT_TokenFamilyGetResponse
+{
+  /**
+   * HTTP response details
+   */
+  struct TALER_MERCHANT_HttpResponse hr;
+
+  /**
+   * Details depending on HTTP status.
+   */
+  union
+  {
+    /**
+     * Details for #MHD_HTTP_OK.
+     */
+    struct
+    {
+
+      /**
+       * Identifier for the token family consisting of unreserved characters
+       * according to RFC 3986.
+       */
+      const char *slug;
+
+      /**
+       * Human-readable name for the token family.
+       */
+      const char *name;
+
+      /**
+       * description of the token family
+       */
+      const char *description;
+
+      /**
+       * Optional map from IETF BCP 47 language tags to localized descriptions.
+       */
+      const json_t *description_i18n;
+
+      /**
+       * Start time of the token family's validity period.
+       */
+      struct GNUNET_TIME_Timestamp valid_after;
+
+      /**
+       * End time of the token family's validity period.
+       */
+      struct GNUNET_TIME_Timestamp valid_before;
+
+      /**
+       * Validity duration of an issued token.
+       */
+      struct GNUNET_TIME_Relative duration;
+
+      /**
+       * Kind of token family, "subscription" or "discount".
+       */
+      const char *kind;
+
+      /**
+       * How many tokens have been issued for this family.
+       */
+      uint64_t issued;
+
+      /**
+       * How many tokens have been redeemed for this family.
+       */
+      uint64_t redeemed;
+    } ok;
+
+  } details;
+
+};
+
+/**
+ * Cancel GET /tokenfamilies/$SLUG operation.
+ *
+ * @param handle operation to cancel
+ */
+void
+TALER_MERCHANT_token_family_get_cancel (
+  struct TALER_MERCHANT_TokenFamilyGetHandle *handle);
+
+
+/**
+ * Function called with the result of the GET /tokenfamilies/$SLUG operation.
+ *
+ * @param cls closure
+ * @param pgr response details
+ */
+typedef void
+(*TALER_MERCHANT_TokenFamilyGetCallback)(
+  void *cls,
+  const struct TALER_MERCHANT_TokenFamilyGetResponse *pgr);
+
+/**
+ * Handle for a POST /tokenfamilies operation.
+ */
+struct TALER_MERCHANT_TokenFamiliesPostHandle;
+
+
+/**
+ * Function called with the result of the POST /tokenfamilies operation.
+ *
+ * @param cls closure
+ * @param hr HTTP response details
+ */
+typedef void
+(*TALER_MERCHANT_TokenFamiliesPostCallback)(
+  void *cls,
+  const struct TALER_MERCHANT_HttpResponse *hr);
+
+
+/**
+ * Make a POST /tokenfamilies request to add a token family to the
+ * merchant instance.
+ *
+ * @param ctx the context
+ * @param backend_url HTTP base URL for the backend
+ * @param slug short, url-safe identifier for the token family
+ * @param name human-readable name for the token family
+ * @param description description of the token family
+ * @param description_i18n Map from IETF BCP 47 language tags to localized descriptions
+ * @param valid_after when the token family becomes valid
+ * @param valid_before when the token family expires
+ * @param duration how long tokens issued by this token family are valid for
+ * @param kind kind of token family, "subscription" or "discount"
+ * @param cb function to call with the backend's result
+ * @param cb_cls closure for @a cb
+ * @return the request handle; NULL upon error
+ */
+struct TALER_MERCHANT_TokenFamiliesPostHandle *
+TALER_MERCHANT_token_families_post (
+  struct GNUNET_CURL_Context *ctx,
+  const char *backend_url,
+  const char *slug,
+  const char *name,
+  const char *description,
+  const json_t *description_i18n,
+  struct GNUNET_TIME_Timestamp valid_after,
+  struct GNUNET_TIME_Timestamp valid_before,
+  struct GNUNET_TIME_Relative duration,
+  const char *kind,
+  TALER_MERCHANT_TokenFamiliesPostCallback cb,
+  void *cb_cls);
+
+/**
+ * Cancel POST /tokenfamilies operation.
+ *
+ * @param handle operation to cancel
+ */
+void
+TALER_MERCHANT_token_families_post_cancel (
+  struct TALER_MERCHANT_TokenFamiliesPostHandle *handle);
+
 /* ********************* /orders ************************** */
 
 
diff --git a/src/lib/merchant_api_get_tokenfamily.c b/src/lib/merchant_api_get_tokenfamily.c
new file mode 100644
index 00000000..d7e6b06e
--- /dev/null
+++ b/src/lib/merchant_api_get_tokenfamily.c
@@ -0,0 +1,210 @@
+/*
+  This file is part of TALER
+  Copyright (C) 2014-2023 Taler Systems SA
+
+  TALER is free software; you can redistribute it and/or modify it under the
+  terms of the GNU Lesser General Public License as published by the Free Software
+  Foundation; either version 2.1, 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 Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License along with
+  TALER; see the file COPYING.LGPL.  If not, see
+  <http://www.gnu.org/licenses/>
+*/
+/**
+ * @file merchant_api_get_tokenfamily.c
+ * @brief Implementation of the GET /tokenfamily/$ID request of the merchant's HTTP API
+ * @author Christian Blättler
+ */
+#include "platform.h"
+#include <curl/curl.h>
+#include <gnunet/gnunet_common.h>
+#include <gnunet/gnunet_json_lib.h>
+#include <jansson.h>
+#include <microhttpd.h> /* just for HTTP status codes */
+#include <gnunet/gnunet_util_lib.h>
+#include <gnunet/gnunet_curl_lib.h>
+#include "taler_merchant_service.h"
+#include "merchant_api_curl_defaults.h"
+#include <taler/taler_json_lib.h>
+#include <taler/taler_signatures.h>
+
+
+/**
+ * Handle for a GET /tokenfamilies/$SLUG operation.
+ */
+struct TALER_MERCHANT_TokenFamilyGetHandle
+{
+  /**
+   * The url for this request.
+   */
+  char *url;
+
+  /**
+   * Handle for the request.
+   */
+  struct GNUNET_CURL_Job *job;
+
+  /**
+   * Function to call with the result.
+   */
+  TALER_MERCHANT_TokenFamilyGetCallback cb;
+
+  /**
+   * Closure for @a cb.
+   */
+  void *cb_cls;
+
+  /**
+   * Reference to the execution context.
+   */
+  struct GNUNET_CURL_Context *ctx;
+
+};
+
+
+/**
+ * Function called when we're done processing the
+ * HTTP GET /tokenfamilies/$ID request.
+ *
+ * @param cls the `struct TALER_MERCHANT_TokenFamilyGetHandle`
+ * @param response_code HTTP response code, 0 on error
+ * @param response response body, NULL if not in JSON
+ */
+static void
+handle_get_token_family_finished (void *cls,
+                                  long response_code,
+                                  const void *response)
+{
+  struct TALER_MERCHANT_TokenFamilyGetHandle *handle = cls;
+  const json_t *json = response;
+  struct TALER_MERCHANT_TokenFamilyGetResponse res = {
+    .hr.http_status = (unsigned int) response_code,
+    .hr.reply = json
+  };
+
+  handle->job = NULL;
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "Got /tokenfamilies/$ID response with status code %u\n",
+              (unsigned int) response_code);
+  switch (response_code)
+  {
+  case MHD_HTTP_OK:
+    {
+      // Parse token family response
+      struct GNUNET_JSON_Specification spec[] = {
+        GNUNET_JSON_spec_string ("slug",
+                                 &res.details.ok.slug),
+        GNUNET_JSON_spec_string ("name",
+                                 &res.details.ok.name),
+        GNUNET_JSON_spec_string ("description",
+                                 &res.details.ok.description),
+        GNUNET_JSON_spec_object_const ("description_i18n",
+                                       &res.details.ok.description_i18n),
+        GNUNET_JSON_spec_timestamp ("valid_after",
+                                    &res.details.ok.valid_after),
+        GNUNET_JSON_spec_timestamp ("valid_before",
+                                    &res.details.ok.valid_before),
+        GNUNET_JSON_spec_relative_time ("duation",
+                                        &res.details.ok.duration),
+        GNUNET_JSON_spec_string ("kind",
+                                 &res.details.ok.kind),
+        GNUNET_JSON_spec_uint64 ("issued",
+                                 &res.details.ok.issued),
+        GNUNET_JSON_spec_uint64 ("redeemed",
+                                 &res.details.ok.redeemed),
+        GNUNET_JSON_spec_end ()
+      };
+
+      if (GNUNET_OK ==
+          GNUNET_JSON_parse (json,
+                             spec,
+                             NULL, NULL))
+      {
+        handle->cb (handle->cb_cls,
+                    &res);
+        GNUNET_JSON_parse_free (spec);
+        TALER_MERCHANT_token_family_get_cancel (handle);
+        return;
+      }
+      res.hr.http_status = 0;
+      res.hr.ec = TALER_EC_GENERIC_INVALID_RESPONSE;
+      break;
+    }
+  case MHD_HTTP_UNAUTHORIZED:
+    res.hr.ec = TALER_JSON_get_error_code (json);
+    res.hr.hint = TALER_JSON_get_error_hint (json);
+    /* Nothing really to verify, merchant says we need to authenticate. */
+    break;
+  case MHD_HTTP_NOT_FOUND:
+    res.hr.ec = TALER_JSON_get_error_code (json);
+    res.hr.hint = TALER_JSON_get_error_hint (json);
+    break;
+  default:
+    /* unexpected response code */
+    res.hr.ec = TALER_JSON_get_error_code (json);
+    res.hr.hint = TALER_JSON_get_error_hint (json);
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Unexpected response code %u/%d\n",
+                (unsigned int) response_code,
+                (int) res.hr.ec);
+    break;
+  }
+}
+
+struct TALER_MERCHANT_TokenFamilyGetHandle *
+TALER_MERCHANT_token_family_get (
+  struct GNUNET_CURL_Context *ctx,
+  const char *backend_url,
+  const char *token_family_slug,
+  TALER_MERCHANT_TokenFamilyGetCallback cb,
+  void *cb_cls)
+{
+  struct TALER_MERCHANT_TokenFamilyGetHandle *handle;
+  CURL *eh;
+
+  handle = GNUNET_new (struct TALER_MERCHANT_TokenFamilyGetHandle);
+  handle->ctx = ctx;
+  handle->cb = cb;
+  handle->cb_cls = cb_cls;
+  {
+    char *path;
+
+    GNUNET_asprintf (&path,
+                     "private/tokenfamilies/%s",
+                     token_family_slug);
+    handle->url = TALER_url_join (backend_url,
+                                  path,
+                                  NULL);
+    GNUNET_free (path);
+  }
+  if (NULL == handle->url)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Could not construct request URL.\n");
+    GNUNET_free (handle);
+    return NULL;
+  }
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "Requesting URL '%s'\n",
+              handle->url);
+  eh = TALER_MERCHANT_curl_easy_get_ (handle->url);
+  handle->job = GNUNET_CURL_job_add (ctx,
+                                     eh,
+                                     &handle_get_token_family_finished,
+                                     handle);
+  return handle;
+}
+
+void
+TALER_MERCHANT_token_family_get_cancel (
+  struct TALER_MERCHANT_TokenFamilyGetHandle *handle)
+{
+  if (NULL != handle->job)
+    GNUNET_CURL_job_cancel (handle->job);
+  GNUNET_free (handle->url);
+  GNUNET_free (handle);
+}
\ No newline at end of file
diff --git a/src/lib/merchant_api_post_tokenfamilies.c b/src/lib/merchant_api_post_tokenfamilies.c
new file mode 100644
index 00000000..0c5e18c2
--- /dev/null
+++ b/src/lib/merchant_api_post_tokenfamilies.c
@@ -0,0 +1,246 @@
+/*
+  This file is part of TALER
+  Copyright (C) 2020-2024 Taler Systems SA
+
+  TALER is free software; you can redistribute it and/or modify
+  it under the terms of the GNU Lesser General Public License as
+  published by the Free Software Foundation; either version 2.1,
+  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 Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General
+  Public License along with TALER; see the file COPYING.LGPL.
+  If not, see <http://www.gnu.org/licenses/>
+*/
+/**
+ * @file merchant_api_post_tokenfamilies.c
+ * @brief Implementation of the POST /tokenfamilies request
+ *        of the merchant's HTTP API
+ * @author Christian Blättler
+ */
+#include "platform.h"
+#include <curl/curl.h>
+#include <gnunet/gnunet_json_lib.h>
+#include <gnunet/gnunet_time_lib.h>
+#include <jansson.h>
+#include <microhttpd.h> /* just for HTTP status codes */
+#include <gnunet/gnunet_util_lib.h>
+#include "taler_merchant_service.h"
+#include "merchant_api_curl_defaults.h"
+#include "merchant_api_common.h"
+#include <taler/taler_json_lib.h>
+#include <taler/taler_curl_lib.h>
+
+
+/**
+ * Handle for a POST /tokenfamilies operation.
+ */
+struct TALER_MERCHANT_TokenFamiliesPostHandle
+{
+
+  /**
+   * The url for this request.
+   */
+  char *url;
+
+  /**
+   * Handle for the request.
+   */
+  struct GNUNET_CURL_Job *job;
+
+  /**
+   * Function to call with the result.
+   */
+  TALER_MERCHANT_TokenFamiliesPostCallback cb;
+
+  /**
+   * Closure for @a cb.
+   */
+  void *cb_cls;
+
+  /**
+   * Reference to the execution context.
+   */
+  struct GNUNET_CURL_Context *ctx;
+
+  /**
+   * Minor context that holds body and headers.
+   */
+  struct TALER_CURL_PostContext post_ctx;
+
+};
+
+/**
+ * Function called when we're done processing the
+ * HTTP POST /tokenfamilies request.
+ *
+ * @param cls the `struct TALER_MERCHANT_TokenFamiliesPostHandle`
+ * @param response_code HTTP response code, 0 on error
+ * @param response response body, NULL if not in JSON
+ */
+static void
+handle_post_token_families_finished (void *cls,
+                                    long response_code,
+                                    const void *response)
+{
+  struct TALER_MERCHANT_TokenFamiliesPostHandle *handle = cls;
+  const json_t *json = response;
+  struct TALER_MERCHANT_HttpResponse hr = {
+    .http_status = (unsigned int) response_code,
+    .reply = json
+  };
+
+  handle->job = NULL;
+  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+              "POST /tokenfamilies completed with response code %u\n",
+              (unsigned int) response_code);
+              switch (response_code)
+  {
+  case 0:
+    hr.ec = TALER_EC_GENERIC_INVALID_RESPONSE;
+    break;
+  case MHD_HTTP_NO_CONTENT:
+    break;
+  case MHD_HTTP_BAD_REQUEST:
+    hr.ec = TALER_JSON_get_error_code (json);
+    hr.hint = TALER_JSON_get_error_hint (json);
+    /* This should never happen, either us
+     * or the merchant is buggy (or API version conflict);
+     * just pass JSON reply to the application */
+    break;
+  case MHD_HTTP_UNAUTHORIZED:
+    hr.ec = TALER_JSON_get_error_code (json);
+    hr.hint = TALER_JSON_get_error_hint (json);
+    /* Nothing really to verify, merchant says we need to authenticate. */
+    break;
+  case MHD_HTTP_FORBIDDEN:
+    hr.ec = TALER_JSON_get_error_code (json);
+    hr.hint = TALER_JSON_get_error_hint (json);
+    /* Nothing really to verify, merchant says we tried to abort the payment
+     * after it was successful. We should pass the JSON reply to the
+     * application */
+    break;
+  case MHD_HTTP_NOT_FOUND:
+    hr.ec = TALER_JSON_get_error_code (json);
+    hr.hint = TALER_JSON_get_error_hint (json);
+    /* Nothing really to verify, this should never
+       happen, we should pass the JSON reply to the
+       application */
+    break;
+  case MHD_HTTP_CONFLICT:
+    hr.ec = TALER_JSON_get_error_code (json);
+    hr.hint = TALER_JSON_get_error_hint (json);
+    break;
+  case MHD_HTTP_INTERNAL_SERVER_ERROR:
+    hr.ec = TALER_JSON_get_error_code (json);
+    hr.hint = TALER_JSON_get_error_hint (json);
+    /* Server had an internal issue; we should retry,
+       but this API leaves this to the application */
+    break;
+  default:
+    TALER_MERCHANT_parse_error_details_ (json,
+                                         response_code,
+                                         &hr);
+    /* unexpected response code */
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Unexpected response code %u/%d\n",
+                (unsigned int) response_code,
+                (int) hr.ec);
+    GNUNET_break_op (0);
+    break;
+  }
+  handle->cb (handle->cb_cls,
+              &hr);
+  TALER_MERCHANT_token_families_post_cancel (handle);
+}
+
+struct TALER_MERCHANT_TokenFamiliesPostHandle *
+TALER_MERCHANT_token_families_post (
+  struct GNUNET_CURL_Context *ctx,
+  const char *backend_url,
+  const char *slug,
+  const char *name,
+  const char *description,
+  const json_t *description_i18n,
+  struct GNUNET_TIME_Timestamp valid_after,
+  struct GNUNET_TIME_Timestamp valid_before,
+  struct GNUNET_TIME_Relative duration,
+  const char *kind,
+  TALER_MERCHANT_TokenFamiliesPostCallback cb,
+  void *cb_cls)
+{
+  struct TALER_MERCHANT_TokenFamiliesPostHandle *handle;
+  json_t *req_obj;
+
+  req_obj = GNUNET_JSON_PACK (
+    GNUNET_JSON_pack_string ("slug",
+                             slug),
+    GNUNET_JSON_pack_string ("name",
+                             name),
+    GNUNET_JSON_pack_string ("description",
+                             description),
+    GNUNET_JSON_pack_allow_null (
+      GNUNET_JSON_pack_object_incref ("description_i18n",
+                                      (json_t *) description_i18n)),
+    GNUNET_JSON_pack_allow_null (
+      GNUNET_JSON_pack_timestamp ("valid_after",
+                                  valid_after)),
+    GNUNET_JSON_pack_timestamp ("valid_before",
+                                valid_before),
+    GNUNET_JSON_pack_time_rel ("duration",
+                               duration),
+    GNUNET_JSON_pack_string ("kind",
+                             kind));
+  handle = GNUNET_new (struct TALER_MERCHANT_TokenFamiliesPostHandle);
+  handle->ctx = ctx;
+  handle->cb = cb;
+  handle->cb_cls = cb_cls;
+  handle->url = TALER_url_join (backend_url,
+                                "private/tokenfamilies",
+                                NULL);
+  if (NULL == handle->url)
+  {
+
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Could not construct request URL.\n");
+    json_decref (req_obj);
+    GNUNET_free (handle);
+    return NULL;
+  }
+  {
+    CURL *eh;
+
+    eh = TALER_MERCHANT_curl_easy_get_ (handle->url);
+    GNUNET_assert (GNUNET_OK ==
+                   TALER_curl_easy_post (&handle->post_ctx,
+                                         eh,
+                                         req_obj));
+    json_decref (req_obj);
+    handle->job = GNUNET_CURL_job_add2 (ctx,
+                                        eh,
+                                        handle->post_ctx.headers,
+                                        &handle_post_token_families_finished,
+                                        handle);
+    GNUNET_assert (NULL != handle->job);
+  }
+  return handle;
+}
+
+
+void
+TALER_MERCHANT_token_families_post_cancel (
+  struct TALER_MERCHANT_TokenFamiliesPostHandle *pph)
+{
+  if (NULL != pph->job)
+  {
+    GNUNET_CURL_job_cancel (pph->job);
+    pph->job = NULL;
+  }
+  TALER_curl_easy_post_finished (&pph->post_ctx);
+  GNUNET_free (pph->url);
+  GNUNET_free (pph);
+}