aboutsummaryrefslogtreecommitdiff
path: root/src/backend/taler-merchant-httpd_tip-query.c
blob: d4a86a7a3b3b27e166b30e2c62ba13800d8748ef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
/*
  This file is part of TALER
  (C) 2018 Taler Systems SA

  TALER is free software; you can redistribute it and/or modify it under the
  terms of the GNU Affero 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 MERCHANTABILITY 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 backend/taler-merchant-httpd_tip-query.c
 * @brief implement API for authorizing tips to be paid to visitors
 * @author Christian Grothoff
 * @author Florian Dold
 */
#include "platform.h"
#include <jansson.h>
#include <taler/taler_util.h>
#include <taler/taler_json_lib.h>
#include "taler-merchant-httpd.h"
#include "taler-merchant-httpd_mhd.h"
#include "taler-merchant-httpd_parsing.h"
#include "taler-merchant-httpd_exchanges.h"
#include "taler-merchant-httpd_responses.h"
#include "taler-merchant-httpd_tip-query.h"
#include "taler-merchant-httpd_tip-reserve-helper.h"


/**
 * Maximum number of retries for database operations.
 */
#define MAX_RETRIES 5


struct TipQueryContext
{
  /**
   * This field MUST be first.
   * FIXME: Explain why!
   */
  struct TM_HandlerContext hc;

  /**
   * Merchant instance to use.
   */
  const char *instance;

  /**
   * GNUNET_YES if the tip query has already been processed
   * and we can queue the response.
   */
  int processed;

  /**
   * Context for checking the tipping reserve's status.
   */
  struct CheckTipReserve ctr;

};


/**
 * Custom cleanup routine for a `struct TipQueryContext`.
 *
 * @param hc the `struct TMH_JsonParseContext` to clean up.
 */
static void
cleanup_tqc (struct TM_HandlerContext *hc)
{
  struct TipQueryContext *tqc = (struct TipQueryContext *) hc;

  TMH_check_tip_reserve_cleanup (&tqc->ctr);
  GNUNET_free (tqc);
}


/**
 * We've been resumed after processing the reserve data from the
 * exchange without error. Generate the final response.
 *
 * @param tqc context for which to generate the response.
 */
static int
generate_final_response (struct TipQueryContext *tqc)
{
  struct GNUNET_CRYPTO_EddsaPublicKey reserve_pub;
  struct TALER_Amount amount_available;

  GNUNET_CRYPTO_eddsa_key_get_public (&tqc->ctr.reserve_priv.eddsa_priv,
                                      &reserve_pub);
  if (GNUNET_SYSERR ==
      TALER_amount_subtract (&amount_available,
                             &tqc->ctr.amount_deposited,
                             &tqc->ctr.amount_withdrawn))
  {
    GNUNET_break_op (0);
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "amount overflow, deposited %s but withdrawn %s\n",
                TALER_amount_to_string (&tqc->ctr.amount_deposited),
                TALER_amount_to_string (&tqc->ctr.amount_withdrawn));
    return TMH_RESPONSE_reply_internal_error (tqc->ctr.connection,
                                              TALER_EC_TIP_QUERY_RESERVE_HISTORY_ARITHMETIC_ISSUE_INCONSISTENT,
                                              "Exchange returned invalid reserve history (amount overflow)");
  }
  return TMH_RESPONSE_reply_json_pack (tqc->ctr.connection,
                                       MHD_HTTP_OK,
                                       "{s:o, s:o, s:o, s:o, s:o}",
                                       "reserve_pub",
                                       GNUNET_JSON_from_data_auto (
                                         &reserve_pub),
                                       "reserve_expiration",
                                       GNUNET_JSON_from_time_abs (
                                         tqc->ctr.reserve_expiration),
                                       "amount_authorized",
                                       TALER_JSON_from_amount (
                                         &tqc->ctr.amount_authorized),
                                       "amount_picked_up",
                                       TALER_JSON_from_amount (
                                         &tqc->ctr.amount_withdrawn),
                                       "amount_available",
                                       TALER_JSON_from_amount (
                                         &amount_available));
}


/**
 * Handle a "/tip-query" request.
 *
 * @param rh context of the handler
 * @param connection the MHD connection to handle
 * @param[in,out] connection_cls the connection's closure (can be updated)
 * @param upload_data upload data
 * @param[in,out] upload_data_size number of bytes (left) in @a upload_data
 * @param mi merchant backend instance, never NULL
 * @return MHD result code
 */
int
MH_handler_tip_query (struct TMH_RequestHandler *rh,
                      struct MHD_Connection *connection,
                      void **connection_cls,
                      const char *upload_data,
                      size_t *upload_data_size,
                      struct MerchantInstance *mi)
{
  struct TipQueryContext *tqc;

  if (NULL == *connection_cls)
  {
    tqc = GNUNET_new (struct TipQueryContext);
    tqc->hc.cc = &cleanup_tqc;
    tqc->ctr.connection = connection;
    *connection_cls = tqc;
  }
  else
  {
    tqc = *connection_cls;
  }

  if (0 != tqc->ctr.response_code)
  {
    int res;

    /* We are *done* processing the request, just queue the response (!) */
    if (UINT_MAX == tqc->ctr.response_code)
    {
      GNUNET_break (0);
      return MHD_NO; /* hard error */
    }
    res = MHD_queue_response (connection,
                              tqc->ctr.response_code,
                              tqc->ctr.response);
    MHD_destroy_response (tqc->ctr.response);
    tqc->ctr.response = NULL;
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Queueing response (%u) for /tip-query (%s).\n",
                (unsigned int) tqc->ctr.response_code,
                res ? "OK" : "FAILED");
    return res;
  }

  if (GNUNET_YES == tqc->processed)
  {
    /* We've been here before, so TMH_check_tip_reserve() must have
       finished and left the result for us. Finish processing. */
    return generate_final_response (tqc);
  }

  if (NULL == mi->tip_exchange)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                "Instance `%s' not configured for tipping\n",
                mi->id);
    return TMH_RESPONSE_reply_not_found (connection,
                                         TALER_EC_TIP_AUTHORIZE_INSTANCE_DOES_NOT_TIP,
                                         "exchange for tipping not configured for the instance");
  }
  tqc->ctr.reserve_priv = mi->tip_reserve;

  {
    int qs;
    for (unsigned int i = 0; i<MAX_RETRIES; i++)
    {
      db->preflight (db->cls);
      qs = db->get_authorized_tip_amount (db->cls,
                                          &tqc->ctr.reserve_priv,
                                          &tqc->ctr.amount_authorized);
      if (GNUNET_DB_STATUS_SOFT_ERROR != qs)
        break;
    }
    if (0 > qs)
    {
      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                  "Database hard error on get_authorized_tip_amount\n");
      return TMH_RESPONSE_reply_internal_error (connection,
                                                TALER_EC_TIP_QUERY_DB_ERROR,
                                                "Merchant database error");
    }
    if (GNUNET_DB_STATUS_SUCCESS_NO_RESULTS == qs)
    {
      /* we'll set amount_authorized to zero later once
         we know the currency */
      tqc->ctr.none_authorized = GNUNET_YES;
    }
  }

  tqc->processed = GNUNET_YES;
  TMH_check_tip_reserve (&tqc->ctr,
                         mi->tip_exchange);
  return MHD_YES;
}


/* end of taler-merchant-httpd_tip-query.c */