merchant

Merchant backend to process payments, run by merchants
Log | Files | Refs | Submodules | README | LICENSE

merchant_api_post_webhooks.c (6997B)


      1 /*
      2   This file is part of TALER
      3   Copyright (C) 2022 Taler Systems SA
      4 
      5   TALER is free software; you can redistribute it and/or modify
      6   it under the terms of the GNU Lesser General Public License as
      7   published by the Free Software Foundation; either version 2.1,
      8   or (at your option) any later version.
      9 
     10   TALER is distributed in the hope that it will be useful,
     11   but WITHOUT ANY WARRANTY; without even the implied warranty of
     12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     13   GNU Lesser General Public License for more details.
     14 
     15   You should have received a copy of the GNU Lesser General
     16   Public License along with TALER; see the file COPYING.LGPL.
     17   If not, see <http://www.gnu.org/licenses/>
     18 */
     19 /**
     20  * @file merchant_api_post_webhooks.c
     21  * @brief Implementation of the POST /webhooks request
     22  *        of the merchant's HTTP API
     23  * @author Priscilla HUANG
     24  */
     25 #include "platform.h"
     26 #include <curl/curl.h>
     27 #include <jansson.h>
     28 #include <microhttpd.h> /* just for HTTP status codes */
     29 #include <gnunet/gnunet_util_lib.h>
     30 #include "taler_merchant_service.h"
     31 #include "merchant_api_curl_defaults.h"
     32 #include "merchant_api_common.h"
     33 #include <taler/taler_json_lib.h>
     34 #include <taler/taler_curl_lib.h>
     35 
     36 
     37 /**
     38  * Handle for a POST /webhooks/$ID operation.
     39  */
     40 struct TALER_MERCHANT_WebhooksPostHandle
     41 {
     42 
     43   /**
     44    * The url for this request.
     45    */
     46   char *url;
     47 
     48   /**
     49    * Handle for the request.
     50    */
     51   struct GNUNET_CURL_Job *job;
     52 
     53   /**
     54    * Function to call with the result.
     55    */
     56   TALER_MERCHANT_WebhooksPostCallback cb;
     57 
     58   /**
     59    * Closure for @a cb.
     60    */
     61   void *cb_cls;
     62 
     63   /**
     64    * Reference to the execution context.
     65    */
     66   struct GNUNET_CURL_Context *ctx;
     67 
     68   /**
     69    * Minor context that holds body and headers.
     70    */
     71   struct TALER_CURL_PostContext post_ctx;
     72 
     73 };
     74 
     75 
     76 /**
     77  * Function called when we're done processing the
     78  * HTTP POST /webhooks request.
     79  *
     80  * @param cls the `struct TALER_MERCHANT_WebhooksPostHandle`
     81  * @param response_code HTTP response code, 0 on error
     82  * @param response response body, NULL if not in JSON
     83  */
     84 static void
     85 handle_post_webhooks_finished (void *cls,
     86                                long response_code,
     87                                const void *response)
     88 {
     89   struct TALER_MERCHANT_WebhooksPostHandle *wph = cls;
     90   const json_t *json = response;
     91   struct TALER_MERCHANT_HttpResponse hr = {
     92     .http_status = (unsigned int) response_code,
     93     .reply = json
     94   };
     95 
     96   wph->job = NULL;
     97   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
     98               "POST /webhooks completed with response code %u\n",
     99               (unsigned int) response_code);
    100   switch (response_code)
    101   {
    102   case 0:
    103     hr.ec = TALER_EC_GENERIC_INVALID_RESPONSE;
    104     break;
    105   case MHD_HTTP_NO_CONTENT:
    106     break;
    107   case MHD_HTTP_BAD_REQUEST:
    108     hr.ec = TALER_JSON_get_error_code (json);
    109     hr.hint = TALER_JSON_get_error_hint (json);
    110     /* This should never happen, either us
    111      * or the merchant is buggy (or API version conflict);
    112      * just pass JSON reply to the application */
    113     break;
    114   case MHD_HTTP_UNAUTHORIZED:
    115     hr.ec = TALER_JSON_get_error_code (json);
    116     hr.hint = TALER_JSON_get_error_hint (json);
    117     /* Nothing really to verify, merchant says we need to authenticate. */
    118     break;
    119   case MHD_HTTP_FORBIDDEN:
    120     hr.ec = TALER_JSON_get_error_code (json);
    121     hr.hint = TALER_JSON_get_error_hint (json);
    122     /* Nothing really to verify, merchant says we tried to abort the payment
    123      * after it was successful. We should pass the JSON reply to the
    124      * application */
    125     break;
    126   case MHD_HTTP_NOT_FOUND:
    127     hr.ec = TALER_JSON_get_error_code (json);
    128     hr.hint = TALER_JSON_get_error_hint (json);
    129     /* Nothing really to verify, this should never
    130        happen, we should pass the JSON reply to the
    131        application */
    132     break;
    133   case MHD_HTTP_CONFLICT:
    134     hr.ec = TALER_JSON_get_error_code (json);
    135     hr.hint = TALER_JSON_get_error_hint (json);
    136     break;
    137   case MHD_HTTP_INTERNAL_SERVER_ERROR:
    138     hr.ec = TALER_JSON_get_error_code (json);
    139     hr.hint = TALER_JSON_get_error_hint (json);
    140     /* Server had an internal issue; we should retry,
    141        but this API leaves this to the application */
    142     break;
    143   default:
    144     TALER_MERCHANT_parse_error_details_ (json,
    145                                          response_code,
    146                                          &hr);
    147     /* unexpected response code */
    148     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
    149                 "Unexpected response code %u/%d\n",
    150                 (unsigned int) response_code,
    151                 (int) hr.ec);
    152     GNUNET_break_op (0);
    153     break;
    154   }
    155   wph->cb (wph->cb_cls,
    156            &hr);
    157   TALER_MERCHANT_webhooks_post_cancel (wph);
    158 }
    159 
    160 
    161 struct TALER_MERCHANT_WebhooksPostHandle *
    162 TALER_MERCHANT_webhooks_post (
    163   struct GNUNET_CURL_Context *ctx,
    164   const char *backend_url,
    165   const char *webhook_id,
    166   const char *event_type,
    167   const char *url,
    168   const char *http_method,
    169   const char *header_template,
    170   const char *body_template,
    171   TALER_MERCHANT_WebhooksPostCallback cb,
    172   void *cb_cls)
    173 {
    174   struct TALER_MERCHANT_WebhooksPostHandle *wph;
    175   json_t *req_obj;
    176 
    177   req_obj = GNUNET_JSON_PACK (
    178     GNUNET_JSON_pack_string ("webhook_id",
    179                              webhook_id),
    180     GNUNET_JSON_pack_string ("event_type",
    181                              event_type),
    182     GNUNET_JSON_pack_string ("url",
    183                              url),
    184     GNUNET_JSON_pack_string ("http_method",
    185                              http_method),
    186     GNUNET_JSON_pack_string ("header_template",
    187                              header_template),
    188     GNUNET_JSON_pack_string ("body_template",
    189                              body_template));
    190   wph = GNUNET_new (struct TALER_MERCHANT_WebhooksPostHandle);
    191   wph->ctx = ctx;
    192   wph->cb = cb;
    193   wph->cb_cls = cb_cls;
    194   wph->url = TALER_url_join (backend_url,
    195                              "private/webhooks",
    196                              NULL);
    197   if (NULL == wph->url)
    198   {
    199     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
    200                 "Could not construct request URL.\n");
    201     json_decref (req_obj);
    202     GNUNET_free (wph);
    203     return NULL;
    204   }
    205   {
    206     CURL *eh;
    207 
    208     eh = TALER_MERCHANT_curl_easy_get_ (wph->url);
    209     GNUNET_assert (GNUNET_OK ==
    210                    TALER_curl_easy_post (&wph->post_ctx,
    211                                          eh,
    212                                          req_obj));
    213     json_decref (req_obj);
    214     wph->job = GNUNET_CURL_job_add2 (ctx,
    215                                      eh,
    216                                      wph->post_ctx.headers,
    217                                      &handle_post_webhooks_finished,
    218                                      wph);
    219     GNUNET_assert (NULL != wph->job);
    220   }
    221   return wph;
    222 }
    223 
    224 
    225 void
    226 TALER_MERCHANT_webhooks_post_cancel (
    227   struct TALER_MERCHANT_WebhooksPostHandle *wph)
    228 {
    229   if (NULL != wph->job)
    230   {
    231     GNUNET_CURL_job_cancel (wph->job);
    232     wph->job = NULL;
    233   }
    234   TALER_curl_easy_post_finished (&wph->post_ctx);
    235   GNUNET_free (wph->url);
    236   GNUNET_free (wph);
    237 }
    238 
    239 
    240 /* end of merchant_api_post_webhooks.c */