adjust GET /orders/ID to match spec

4 files changed, 394 insertions, 316 deletions

diff --git a/src/lib/Makefile.am b/src/lib/Makefile.am
index 5e9eaa30..df339048 100644
--- a/src/lib/Makefile.am
+++ b/src/lib/Makefile.am
@@ -39,13 +39,15 @@ libtalermerchant_la_SOURCES = \
   merchant_api_post_products.c \
   merchant_api_post_reserves.c \
   merchant_api_post_transfers.c \
-	merchant_api_get_tips.c \
+  merchant_api_get_tips.c \
  \
   merchant_api_tip_authorize.c \
   merchant_api_tip_pickup.c \
   merchant_api_tip_pickup2.c \
   merchant_api_tip_query.c \
-  merchant_api_track_transaction.c
+  merchant_api_track_transaction.c \
+  merchant_api_wallet_get_order.c
+
 #  merchant_api_get_transfers.c
 #  merchant_api_get_order.c \
 #  merchant_api_get_order2.c \
diff --git a/src/lib/merchant_api_get_order2.c b/src/lib/merchant_api_get_order2.c
deleted file mode 100644
index 5196d5b7..00000000
--- a/src/lib/merchant_api_get_order2.c
+++ /dev/null
@@ -1,314 +0,0 @@
-/*
-  This file is part of TALER
-  Copyright (C) 2018, 2020 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 lib/merchant_api_check_payment.c
- * @brief Implementation of the /check-payment GET request
- * @author Christian Grothoff
- * @author Marcello Stanisci
- * @author Florian Dold
- */
-#include "platform.h"
-#include <curl/curl.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 <taler/taler_json_lib.h>
-#include <taler/taler_signatures.h>
-
-
-/**
- * @brief A check payment operation handle
- */
-struct TALER_MERCHANT_CheckPaymentOperation
-{
-
-  /**
-   * The url for this request.
-   */
-  char *url;
-
-  /**
-   * Handle for the request.
-   */
-  struct GNUNET_CURL_Job *job;
-
-  /**
-   * Function to call with the result.
-   */
-  TALER_MERCHANT_CheckPaymentCallback 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 GET /check-payment request.
- *
- * @param cls the `struct TALER_MERCHANT_CheckPaymentOperation`
- * @param response_code HTTP response code, 0 on error
- * @param json response body, should be NULL
- */
-static void
-handle_check_payment_finished (void *cls,
-                               long response_code,
-                               const void *response)
-{
-  struct TALER_MERCHANT_CheckPaymentOperation *cpo = cls;
-  struct TALER_Amount refund_amount = { 0 };
-  const json_t *json = response;
-  const json_t *refunded;
-
-  struct GNUNET_JSON_Specification spec[] = {
-    TALER_JSON_spec_amount ("refund_amount",
-                            &refund_amount),
-    GNUNET_JSON_spec_end ()
-  };
-
-  cpo->job = NULL;
-
-  if (MHD_HTTP_OK != response_code)
-  {
-    struct TALER_MERCHANT_HttpResponse hr;
-
-    TALER_MERCHANT_parse_error_details_ (response,
-                                         response_code,
-                                         &hr);
-    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                "Checking payment failed with HTTP status code %u/%d\n",
-                (unsigned int) response_code,
-                (int) hr.ec);
-    GNUNET_break_op (0);
-    cpo->cb (cpo->cb_cls,
-             &hr,
-             GNUNET_SYSERR,
-             GNUNET_SYSERR,
-             NULL,
-             NULL);
-    TALER_MERCHANT_check_payment_cancel (cpo);
-    return;
-  }
-
-  if (! json_boolean_value (json_object_get (json, "paid")))
-  {
-    const char *taler_pay_uri = json_string_value (json_object_get (json,
-                                                                    "taler_pay_uri"));
-    if (NULL == taler_pay_uri)
-    {
-      struct TALER_MERCHANT_HttpResponse hr = {
-        .ec = TALER_EC_CHECK_PAYMENT_RESPONSE_MALFORMED,
-        .reply = json
-      };
-      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                  "no taler_pay_uri in unpaid check-payment response\n");
-      GNUNET_break_op (0);
-      cpo->cb (cpo->cb_cls,
-               &hr,
-               GNUNET_SYSERR,
-               GNUNET_SYSERR,
-               NULL,
-               NULL);
-    }
-    else
-    {
-      struct TALER_MERCHANT_HttpResponse hr = {
-        .reply = json,
-        .http_status = MHD_HTTP_OK
-      };
-      cpo->cb (cpo->cb_cls,
-               &hr,
-               GNUNET_NO,
-               GNUNET_NO,
-               NULL,
-               taler_pay_uri);
-    }
-    TALER_MERCHANT_check_payment_cancel (cpo);
-    return;
-  }
-
-  if ( (NULL == (refunded = json_object_get (json, "refunded"))) ||
-       ( (json_true () == refunded) &&
-         (GNUNET_OK !=
-          GNUNET_JSON_parse (json,
-                             spec,
-                             NULL, NULL)) ) )
-  {
-    struct TALER_MERCHANT_HttpResponse hr = {
-      .ec = TALER_EC_CHECK_PAYMENT_RESPONSE_MALFORMED,
-      .reply = json
-    };
-    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                "check payment failed to parse JSON\n");
-    GNUNET_break_op (0);
-    cpo->cb (cpo->cb_cls,
-             &hr,
-             GNUNET_SYSERR,
-             GNUNET_SYSERR,
-             NULL,
-             NULL);
-    TALER_MERCHANT_check_payment_cancel (cpo);
-    return;
-  }
-  {
-    struct TALER_MERCHANT_HttpResponse hr = {
-      .reply = json,
-      .http_status = MHD_HTTP_OK
-    };
-
-    cpo->cb (cpo->cb_cls,
-             &hr,
-             GNUNET_YES,
-             (json_true () == refunded),
-             (json_true () == refunded) ? &refund_amount : NULL,
-             NULL);
-  }
-  TALER_MERCHANT_check_payment_cancel (cpo);
-}
-
-
-/**
- * Issue a /check-payment request to the backend.  Checks the status
- * of a payment.
- *
- * @param ctx execution context
- * @param backend_url base URL of the merchant backend
- * @param order_id order id to identify the payment
- * @param session_id sesion id for the payment (or NULL if the payment is not bound to a session)
- * @param timeout timeout to use in long polling (how long may the server wait to reply
- *        before generating an unpaid response). Note that this is just provided to
- *        the server, we as client will block until the response comes back or until
- *        #TALER_MERCHANT_poll_payment_cancel() is called.
- * @param check_payment_cb callback which will work the response gotten from the backend
- * @param check_payment_cb_cls closure to pass to @a check_payment_cb
- * @return handle for this operation, NULL upon errors
- */
-struct TALER_MERCHANT_CheckPaymentOperation *
-TALER_MERCHANT_check_payment (
-  struct GNUNET_CURL_Context *ctx,
-  const char *backend_url,
-  const char *order_id,
-  const char *session_id,
-  struct GNUNET_TIME_Relative timeout,
-  TALER_MERCHANT_CheckPaymentCallback check_payment_cb,
-  void *check_payment_cb_cls)
-{
-  struct TALER_MERCHANT_CheckPaymentOperation *cpo;
-  CURL *eh;
-  char *timeout_s;
-  unsigned int ts;
-  long tlong;
-
-  GNUNET_assert (NULL != backend_url);
-  GNUNET_assert (NULL != order_id);
-  ts = (unsigned int) (timeout.rel_value_us
-                       / GNUNET_TIME_UNIT_SECONDS.rel_value_us);
-  /* set curl timeout to *our* long poll timeout plus one minute
-     (for network latency and processing delays) */
-  tlong = (long) (GNUNET_TIME_relative_add (timeout,
-                                            GNUNET_TIME_UNIT_MINUTES).
-                  rel_value_us
-                  / GNUNET_TIME_UNIT_MILLISECONDS.rel_value_us);
-  GNUNET_asprintf (&timeout_s,
-                   "%u",
-                   ts);
-  cpo = GNUNET_new (struct TALER_MERCHANT_CheckPaymentOperation);
-  cpo->ctx = ctx;
-  cpo->cb = check_payment_cb;
-  cpo->cb_cls = check_payment_cb_cls;
-  cpo->url = TALER_url_join (backend_url, "check-payment",
-                             "order_id", order_id,
-                             "session_id", session_id,
-                             (0 != ts) ? "timeout" : NULL,
-                             timeout_s,
-                             NULL);
-  if (NULL == cpo->url)
-  {
-    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-                "Could not construct request URL.\n");
-    GNUNET_free (cpo);
-    return NULL;
-  }
-  GNUNET_free (timeout_s);
-  eh = curl_easy_init ();
-  if (CURLE_OK != curl_easy_setopt (eh,
-                                    CURLOPT_URL,
-                                    cpo->url))
-  {
-    GNUNET_break (0);
-    curl_easy_cleanup (eh);
-    GNUNET_free (cpo->url);
-    GNUNET_free (cpo);
-    return NULL;
-  }
-  if (CURLE_OK != curl_easy_setopt (eh,
-                                    CURLOPT_TIMEOUT_MS,
-                                    tlong))
-  {
-    GNUNET_break (0);
-    curl_easy_cleanup (eh);
-    GNUNET_free (cpo->url);
-    GNUNET_free (cpo);
-    return NULL;
-  }
-
-  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-              "Checking payment from %s\n",
-              cpo->url);
-  if (NULL == (cpo->job = GNUNET_CURL_job_add (ctx,
-                                               eh,
-                                               GNUNET_YES,
-                                               &handle_check_payment_finished,
-                                               cpo)))
-  {
-    GNUNET_break (0);
-    GNUNET_free (cpo->url);
-    GNUNET_free (cpo);
-    return NULL;
-  }
-  return cpo;
-}
-
-
-/**
- * Cancel a GET /check-payment request.
- *
- * @param cph handle to the request to be canceled
- */
-void
-TALER_MERCHANT_check_payment_cancel (
-  struct TALER_MERCHANT_CheckPaymentOperation *cph)
-{
-  if (NULL != cph->job)
-  {
-    GNUNET_CURL_job_cancel (cph->job);
-    cph->job = NULL;
-  }
-  GNUNET_free (cph->url);
-  GNUNET_free (cph);
-}
-
-
-/* end of merchant_api_check_payment.c */
diff --git a/src/lib/merchant_api_get_order3.c b/src/lib/merchant_api_merchant_get_order.c
index 6b0190af..6b0190af 100644
--- a/src/lib/merchant_api_get_order3.c
+++ b/src/lib/merchant_api_merchant_get_order.c
diff --git a/src/lib/merchant_api_wallet_get_order.c b/src/lib/merchant_api_wallet_get_order.c
new file mode 100644
index 00000000..38e2dc09
--- /dev/null
+++ b/src/lib/merchant_api_wallet_get_order.c
@@ -0,0 +1,390 @@
+/*
+  This file is part of TALER
+  Copyright (C) 2018, 2020 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 lib/merchant_api_wallet_get_order.c
+ * @brief Implementation of the GET /orders/$ID request
+ * @author Christian Grothoff
+ * @author Marcello Stanisci
+ * @author Florian Dold
+ */
+#include "platform.h"
+#include <curl/curl.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 <taler/taler_json_lib.h>
+#include <taler/taler_signatures.h>
+
+
+/**
+ * @brief A GET /orders/$ID handle
+ */
+struct TALER_MERCHANT_OrderWalletGetHandle
+{
+
+  /**
+   * The url for this request.
+   */
+  char *url;
+
+  /**
+   * Handle for the request.
+   */
+  struct GNUNET_CURL_Job *job;
+
+  /**
+   * Function to call with the result.
+   */
+  TALER_MERCHANT_OrderWalletGetCallback 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 GET /check-payment request.
+ *
+ * @param cls the `struct TALER_MERCHANT_OrderWalletGetHandle`
+ * @param response_code HTTP response code, 0 on error
+ * @param json response body, should be NULL
+ */
+static void
+handle_wallet_get_order_finished (void *cls,
+                                  long response_code,
+                                  const void *response)
+{
+  struct TALER_MERCHANT_OrderWalletGetHandle *owgh = cls;
+  const json_t *json = response;
+
+  owgh->job = NULL;
+  if (MHD_HTTP_OK != response_code)
+  {
+    struct TALER_MERCHANT_HttpResponse hr;
+
+    TALER_MERCHANT_parse_error_details_ (response,
+                                         response_code,
+                                         &hr);
+    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+                "Checking order status failed with HTTP status code %u/%d\n",
+                (unsigned int) response_code,
+                (int) hr.ec);
+    GNUNET_break_op (0);
+    owgh->cb (owgh->cb_cls,
+              &hr,
+              GNUNET_SYSERR,
+              GNUNET_SYSERR,
+              NULL,
+              NULL,
+              NULL,
+              NULL,
+              0,
+              NULL);
+    TALER_MERCHANT_wallet_order_get_cancel (owgh);
+    return;
+  }
+
+  if (! json_boolean_value (json_object_get (json, "paid")))
+  {
+    /* Status is: unpaid */
+    const char *taler_pay_uri = json_string_value (json_object_get (json,
+                                                                    "taler_pay_uri"));
+    const char *already_paid = json_string_value (json_object_get (json,
+                                                                   "already_paid_order_id"));
+    if (NULL == taler_pay_uri)
+    {
+      struct TALER_MERCHANT_HttpResponse hr = {
+        .ec = TALER_EC_CHECK_PAYMENT_RESPONSE_MALFORMED,
+        .reply = json
+      };
+
+      GNUNET_break_op (0);
+      owgh->cb (owgh->cb_cls,
+                &hr,
+                GNUNET_SYSERR,
+                GNUNET_SYSERR,
+                NULL,
+                NULL,
+                NULL,
+                NULL,
+                0,
+                NULL);
+    }
+    else
+    {
+      struct TALER_MERCHANT_HttpResponse hr = {
+        .reply = json,
+        .http_status = MHD_HTTP_OK
+      };
+
+      owgh->cb (owgh->cb_cls,
+                &hr,
+                GNUNET_NO,
+                GNUNET_NO,
+                NULL,
+                taler_pay_uri,
+                already_paid,
+                NULL,
+                0,
+                NULL);
+    }
+    TALER_MERCHANT_wallet_order_get_cancel (owgh);
+    return;
+  }
+
+  {
+    struct TALER_Amount refund_amount;
+    json_t *refunds;
+    bool refunded;
+    struct TALER_MerchantPublicKeyP merchant_pub;
+
+    struct GNUNET_JSON_Specification spec[] = {
+      GNUNET_JSON_spec_bool ("refunded",
+                             &refunded),
+      GNUNET_JSON_spec_fixed_auto ("merchant_pub",
+                                   &merchant_pub),
+      TALER_JSON_spec_amount ("refund_amount",
+                              &refund_amount),
+      GNUNET_JSON_spec_json ("refunds",
+                             &refunds),
+      GNUNET_JSON_spec_end ()
+    };
+
+    if (GNUNET_OK !=
+        GNUNET_JSON_parse (json,
+                           spec,
+                           NULL, NULL))
+    {
+      struct TALER_MERCHANT_HttpResponse hr = {
+        .ec = TALER_EC_CHECK_PAYMENT_RESPONSE_MALFORMED,
+        .reply = json
+      };
+
+      GNUNET_break_op (0);
+      owgh->cb (owgh->cb_cls,
+                &hr,
+                GNUNET_SYSERR,
+                GNUNET_SYSERR,
+                NULL,
+                NULL,
+                NULL,
+                NULL,
+                0,
+                NULL);
+      TALER_MERCHANT_wallet_order_get_cancel (owgh);
+      return;
+    }
+
+    // FIXME: check 'refunds' is an array!
+
+    {
+      struct TALER_MERCHANT_HttpResponse hr = {
+        .reply = json,
+        .http_status = MHD_HTTP_OK
+      };
+
+      owgh->cb (owgh->cb_cls,
+                &hr,
+                GNUNET_YES,
+                refunded ? GNUNET_YES : GNUNET_NO,
+                refunded ? &refund_amount : NULL,
+                NULL, /* paid! */
+                NULL, /* paid! */
+                &merchant_pub,
+                0, // FIXME: parse refunds!
+                NULL); // FIXME: parse refunds!
+    }
+    GNUNET_JSON_parse_free (spec);
+  }
+  TALER_MERCHANT_wallet_order_get_cancel (owgh);
+}
+
+
+/**
+ * Checks the status of a payment.  Issue a GET /orders/$ID request to the
+ * backend.  The @a h_contract serves as identification of the wallet and is
+ * used to authorize the request.
+ *
+ * @param ctx execution context
+ * @param backend_url base URL of the merchant backend
+ * @param order_id order id to identify the payment
+ * @param h_contract hash of the contract to authenticate the wallet
+ * @param timeout timeout to use in long polling (how long may the server wait to reply
+ *        before generating an unpaid response). Note that this is just provided to
+ *        the server, we as client will block until the response comes back or until
+ *        #TALER_MERCHANT_order_get_cancel() is called.
+ * @param session_id for which session should the payment status be checked
+ * @param min_refund long poll for the service to approve a refund exceeding this value;
+ *        use NULL to not wait for any refund (only for payment). Only makes sense
+ *        with a non-zero @a timeout. Can be NULL.
+ * @param cb callback which will work the response gotten from the backend
+ * @param cb_cls closure to pass to @a cb
+ * @return handle for this operation, NULL upon errors
+ */
+struct TALER_MERCHANT_OrderWalletGetHandle *
+TALER_MERCHANT_wallet_order_get (struct GNUNET_CURL_Context *ctx,
+                                 const char *backend_url,
+                                 const char *order_id,
+                                 const struct GNUNET_HashCode *h_contract,
+                                 struct GNUNET_TIME_Relative timeout,
+                                 const char *session_id,
+                                 const struct TALER_Amount *min_refund,
+                                 TALER_MERCHANT_OrderWalletGetCallback cb,
+                                 void *cb_cls)
+{
+  struct TALER_MERCHANT_OrderWalletGetHandle *owgh;
+  unsigned long long tms;
+  long tlong;
+
+  GNUNET_assert (NULL != backend_url);
+  GNUNET_assert (NULL != order_id);
+  owgh = GNUNET_new (struct TALER_MERCHANT_OrderWalletGetHandle);
+  owgh->ctx = ctx;
+  owgh->cb = cb;
+  owgh->cb_cls = cb_cls;
+  tms = (unsigned long long) (timeout.rel_value_us
+                              / GNUNET_TIME_UNIT_MILLISECONDS.rel_value_us);
+  /* set curl timeout to *our* long poll timeout plus one minute
+     (for network latency and processing delays) */
+  tlong = (long) (GNUNET_TIME_relative_add (timeout,
+                                            GNUNET_TIME_UNIT_MINUTES).
+                  rel_value_us
+                  / GNUNET_TIME_UNIT_MILLISECONDS.rel_value_us);
+  {
+    char timeout_ms[32];
+    struct GNUNET_CRYPTO_HashAsciiEncoded h_contract_s;
+    char *path;
+
+    GNUNET_CRYPTO_hash_to_enc (h_contract,
+                               &h_contract_s);
+    GNUNET_snprintf (timeout_ms,
+                     sizeof (timeout_ms),
+                     "%llu",
+                     tms);
+    GNUNET_asprintf (&path,
+                     "orders/%s",
+                     order_id);
+    owgh->url = TALER_url_join (backend_url,
+                                path,
+                                "h_contract",
+                                h_contract_s.encoding,
+                                "session_id",
+                                session_id,
+                                (0 != tms)
+                                ? "timeout_ms"
+                                : NULL,
+                                timeout_ms,
+                                (NULL != min_refund)
+                                ? "refund"
+                                : NULL,
+                                (NULL != min_refund)
+                                ? TALER_amount2s (min_refund)
+                                : NULL,
+                                NULL);
+    GNUNET_free (path);
+  }
+  if (NULL == owgh->url)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Could not construct request URL.\n");
+    GNUNET_free (owgh);
+    return NULL;
+  }
+
+  {
+    CURL *eh;
+
+    eh = curl_easy_init ();
+    if (NULL == eh)
+    {
+      GNUNET_break (0);
+      GNUNET_free (owgh->url);
+      GNUNET_free (owgh);
+      return NULL;
+    }
+    if (CURLE_OK !=
+        curl_easy_setopt (eh,
+                          CURLOPT_URL,
+                          owgh->url))
+    {
+      GNUNET_break (0);
+      curl_easy_cleanup (eh);
+      GNUNET_free (owgh->url);
+      GNUNET_free (owgh);
+      return NULL;
+    }
+    if (CURLE_OK !=
+        curl_easy_setopt (eh,
+                          CURLOPT_TIMEOUT_MS,
+                          tlong))
+    {
+      GNUNET_break (0);
+      curl_easy_cleanup (eh);
+      GNUNET_free (owgh->url);
+      GNUNET_free (owgh);
+      return NULL;
+    }
+
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                "Checking order status at %s\n",
+                owgh->url);
+    if (NULL == (owgh->job =
+                   GNUNET_CURL_job_add (ctx,
+                                        eh,
+                                        GNUNET_YES,
+                                        &handle_wallet_get_order_finished,
+                                        owgh)))
+    {
+      GNUNET_break (0);
+      GNUNET_free (owgh->url);
+      GNUNET_free (owgh);
+      return NULL;
+    }
+  }
+  return owgh;
+}
+
+
+/**
+ * Cancel a GET /orders/$ID request.
+ *
+ * @param owgh handle to the request to be canceled
+ */
+void
+TALER_MERCHANT_wallet_get_order_cancel (
+  struct TALER_MERCHANT_OrderWalletGetHandle *owgh)
+{
+  if (NULL != owgh->job)
+  {
+    GNUNET_CURL_job_cancel (owgh->job);
+    owgh->job = NULL;
+  }
+  GNUNET_free (owgh->url);
+  GNUNET_free (owgh);
+}
+
+
+/* end of merchant_api_wallet_get_order.c */