LCOV - code coverage report
Current view: top level - lib - merchant_api_patch_template.c (source / functions) Hit Total Coverage
Test: coverage.info Lines: 41 81 50.6 %
Date: 2025-06-23 16:22:09 Functions: 3 3 100.0 %

          Line data    Source code
       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_patch_template.c
      21             :  * @brief Implementation of the PATCH /templates/$ID 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_common.h"
      32             : #include "merchant_api_curl_defaults.h"
      33             : #include <taler/taler_json_lib.h>
      34             : #include <taler/taler_curl_lib.h>
      35             : 
      36             : 
      37             : /**
      38             :  * Handle for a PATCH /templates/$ID operation.
      39             :  */
      40             : struct TALER_MERCHANT_TemplatePatchHandle
      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_TemplatePatchCallback 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 PATCH /templates/$ID request.
      79             :  *
      80             :  * @param cls the `struct TALER_MERCHANT_TemplatePatchHandle`
      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           4 : handle_patch_template_finished (void *cls,
      86             :                                 long response_code,
      87             :                                 const void *response)
      88             : {
      89           4 :   struct TALER_MERCHANT_TemplatePatchHandle *tph = cls;
      90           4 :   const json_t *json = response;
      91           4 :   struct TALER_MERCHANT_HttpResponse hr = {
      92           4 :     .http_status = (unsigned int) response_code,
      93             :     .reply = json
      94             :   };
      95             : 
      96           4 :   tph->job = NULL;
      97           4 :   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
      98             :               "PATCH /templates/$ID completed with response code %u\n",
      99             :               (unsigned int) response_code);
     100           4 :   switch (response_code)
     101             :   {
     102           0 :   case 0:
     103           0 :     hr.ec = TALER_EC_GENERIC_INVALID_RESPONSE;
     104           0 :     break;
     105           2 :   case MHD_HTTP_NO_CONTENT:
     106           2 :     break;
     107           0 :   case MHD_HTTP_BAD_REQUEST:
     108           0 :     hr.ec = TALER_JSON_get_error_code (json);
     109           0 :     hr.hint = TALER_JSON_get_error_hint (json);
     110           0 :     GNUNET_break_op (0);
     111             :     /* This should never happen, either us
     112             :      * or the merchant is buggy (or API version conflict);
     113             :      * just pass JSON reply to the application */
     114           0 :     break;
     115           0 :   case MHD_HTTP_UNAUTHORIZED:
     116           0 :     hr.ec = TALER_JSON_get_error_code (json);
     117           0 :     hr.hint = TALER_JSON_get_error_hint (json);
     118             :     /* Nothing really to verify, merchant says we need to authenticate. */
     119           0 :     break;
     120           0 :   case MHD_HTTP_FORBIDDEN:
     121           0 :     hr.ec = TALER_JSON_get_error_code (json);
     122           0 :     hr.hint = TALER_JSON_get_error_hint (json);
     123             :     /* Nothing really to verify, merchant says we tried to abort the payment
     124             :      * after it was successful. We should pass the JSON reply to the
     125             :      * application */
     126           0 :     break;
     127           2 :   case MHD_HTTP_NOT_FOUND:
     128           2 :     hr.ec = TALER_JSON_get_error_code (json);
     129           2 :     hr.hint = TALER_JSON_get_error_hint (json);
     130           2 :     break;
     131           0 :   case MHD_HTTP_CONFLICT:
     132           0 :     hr.ec = TALER_JSON_get_error_code (json);
     133           0 :     hr.hint = TALER_JSON_get_error_hint (json);
     134           0 :     break;
     135           0 :   case MHD_HTTP_INTERNAL_SERVER_ERROR:
     136           0 :     hr.ec = TALER_JSON_get_error_code (json);
     137           0 :     hr.hint = TALER_JSON_get_error_hint (json);
     138             :     /* Server had an internal issue; we should retry,
     139             :        but this API leaves this to the application */
     140           0 :     break;
     141           0 :   default:
     142           0 :     TALER_MERCHANT_parse_error_details_ (json,
     143             :                                          response_code,
     144             :                                          &hr);
     145             :     /* unexpected response code */
     146           0 :     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
     147             :                 "Unexpected response code %u/%d\n",
     148             :                 (unsigned int) response_code,
     149             :                 (int) hr.ec);
     150           0 :     GNUNET_break_op (0);
     151           0 :     break;
     152             :   }
     153           4 :   tph->cb (tph->cb_cls,
     154             :            &hr);
     155           4 :   TALER_MERCHANT_template_patch_cancel (tph);
     156           4 : }
     157             : 
     158             : 
     159             : struct TALER_MERCHANT_TemplatePatchHandle *
     160           4 : TALER_MERCHANT_template_patch (
     161             :   struct GNUNET_CURL_Context *ctx,
     162             :   const char *backend_url,
     163             :   const char *template_id,
     164             :   const char *template_description,
     165             :   const char *otp_id,
     166             :   json_t *template_contract,
     167             :   TALER_MERCHANT_TemplatePatchCallback cb,
     168             :   void *cb_cls)
     169             : {
     170             :   struct TALER_MERCHANT_TemplatePatchHandle *tph;
     171             :   json_t *req_obj;
     172             : 
     173           4 :   req_obj = GNUNET_JSON_PACK (
     174             :     GNUNET_JSON_pack_string ("template_description",
     175             :                              template_description),
     176             :     GNUNET_JSON_pack_allow_null (
     177             :       GNUNET_JSON_pack_string ("otp_id",
     178             :                                otp_id)),
     179             :     GNUNET_JSON_pack_object_incref ("template_contract",
     180             :                                     (json_t *) template_contract));
     181           4 :   tph = GNUNET_new (struct TALER_MERCHANT_TemplatePatchHandle);
     182           4 :   tph->ctx = ctx;
     183           4 :   tph->cb = cb;
     184           4 :   tph->cb_cls = cb_cls;
     185             :   {
     186             :     char *path;
     187             : 
     188           4 :     GNUNET_asprintf (&path,
     189             :                      "private/templates/%s",
     190             :                      template_id);
     191           4 :     tph->url = TALER_url_join (backend_url,
     192             :                                path,
     193             :                                NULL);
     194           4 :     GNUNET_free (path);
     195             :   }
     196           4 :   if (NULL == tph->url)
     197             :   {
     198           0 :     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
     199             :                 "Could not construct request URL.\n");
     200           0 :     json_decref (req_obj);
     201           0 :     GNUNET_free (tph);
     202           0 :     return NULL;
     203             :   }
     204             :   {
     205             :     CURL *eh;
     206             : 
     207           4 :     eh = TALER_MERCHANT_curl_easy_get_ (tph->url);
     208           4 :     if (GNUNET_OK !=
     209           4 :         TALER_curl_easy_post (&tph->post_ctx,
     210             :                               eh,
     211             :                               req_obj))
     212             :     {
     213           0 :       GNUNET_break (0);
     214           0 :       curl_easy_cleanup (eh);
     215           0 :       json_decref (req_obj);
     216           0 :       GNUNET_free (tph);
     217           0 :       return NULL;
     218             :     }
     219           4 :     json_decref (req_obj);
     220           4 :     GNUNET_assert (CURLE_OK ==
     221             :                    curl_easy_setopt (eh,
     222             :                                      CURLOPT_CUSTOMREQUEST,
     223             :                                      MHD_HTTP_METHOD_PATCH));
     224           8 :     tph->job = GNUNET_CURL_job_add2 (ctx,
     225             :                                      eh,
     226           4 :                                      tph->post_ctx.headers,
     227             :                                      &handle_patch_template_finished,
     228             :                                      tph);
     229             :   }
     230           4 :   return tph;
     231             : }
     232             : 
     233             : 
     234             : void
     235           4 : TALER_MERCHANT_template_patch_cancel (
     236             :   struct TALER_MERCHANT_TemplatePatchHandle *tph)
     237             : {
     238           4 :   if (NULL != tph->job)
     239             :   {
     240           0 :     GNUNET_CURL_job_cancel (tph->job);
     241           0 :     tph->job = NULL;
     242             :   }
     243           4 :   TALER_curl_easy_post_finished (&tph->post_ctx);
     244           4 :   GNUNET_free (tph->url);
     245           4 :   GNUNET_free (tph);
     246           4 : }
     247             : 
     248             : 
     249             : /* end of merchant_api_patch_template.c */

Generated by: LCOV version 1.16