summaryrefslogtreecommitdiff
path: root/src/include/taler_wire_lib.h
blob: 3c85109192cf3b6383f38cc0991079996a48df5c (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
/*
  This file is part of TALER
  Copyright (C) 2016,2018 Taler Systems SA

  TALER is free software; you can redistribute it and/or modify it under the
  terms of the GNU 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 include/taler_wire_lib.h
 * @brief Interface for loading and unloading wire plugins
 * @author Christian Grothoff <christian@grothoff.org>
 */
#ifndef TALER_WIRE_H
#define TALER_WIRE_H

#include <gnunet/gnunet_util_lib.h>
#include "taler_wire_plugin.h"

/**
 * Different account types supported by payto://.
 */
enum TALER_PaytoAccountType
{

  /**
   * Used to indicate an uninitialized struct.
   */
  TALER_PAC_NONE = 0,

  /**
   * Account type of a bank running the x-taler-bank protocol.
   */
  TALER_PAC_X_TALER_BANK,

  /**
   * Account identified by IBAN number.
   */
  TALER_PAC_IBAN
};

/**
 * Information about an account extracted from a payto://-URL.
 */
struct TALER_Account
{

  /**
   * How this the account represented.
   */
  enum TALER_PaytoAccountType type;

  /**
   * Internals depending on @e type.
   */
  union
  {

    /**
     * Taler bank address from x-taler-bank.  Set if
     * @e type is #TALER_AC_X_TALER_BANK.
     */
    struct
    {

      /**
       * Hostname of the bank (possibly including port).
       */
      char *hostname;

      /**
       * Bank account number.
       */
      unsigned long long no;

      /**
       * Base URL of the bank hosting the account above.
       */
      char *bank_base_url;
    } x_taler_bank;

    /**
     * Taler bank address from iban.  Set if
     * @e type is #TALER_AC_IBAN.
     */
    struct
    {

      /**
       * IBAN number.
       */
      char *number;

    } iban;

  } details;
};


/**
 * Release memory allocated in @a acc.
 *
 * @param acc account to free, the pointer itself is NOT free'd.
 */
void
TALER_WIRE_account_free (struct TALER_Account *acc);


/**
 * Parse @a payto_url and store the result in @a acc
 *
 * @param payto_url URL to parse
 * @param acc[in,out] account to initialize, free using #TALER_WIRE_account_free() later
 * @return #TALER_EC_NONE if @a payto_url is well-formed
 */
enum TALER_ErrorCode
TALER_WIRE_payto_to_account (const char *payto_url,
                             struct TALER_Account *acc);


/**
 * Obtain the payment method from a @a payto_url
 *
 * @param payto_url the URL to parse
 * @return NULL on error (malformed @a payto_url)
 */
char *
TALER_WIRE_payto_get_method (const char *payto_url);


/**
 * Get the plugin name from the payment method.
 *
 * @param method the method implemented by the plugin (for
 *  simplicity, we assume 1 method is implemented by 1 plugin).
 * @return the plugin name, NULL if not found.
 */
const char *
TALER_WIRE_get_plugin_from_method (const char *method);


/**
 * Load a WIRE plugin.
 *
 * @param cfg configuration to use
 * @param plugin_name name of the plugin to load
 * @return #GNUNET_OK on success
 */
struct TALER_WIRE_Plugin *
TALER_WIRE_plugin_load (const struct GNUNET_CONFIGURATION_Handle *cfg,
                        const char *plugin_name);


/**
 * Unload a WIRE plugin.
 *
 * @param plugin the plugin to unload
 */
void
TALER_WIRE_plugin_unload (struct TALER_WIRE_Plugin *plugin);


#endif