adding skeletons for plugins

5 files changed, 512 insertions, 4 deletions

diff --git a/src/Makefile.am b/src/Makefile.am
index 0d1d4572f..986dcc5d3 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -7,10 +7,10 @@ if WALLET_ONLY
 SUBDIRS = include util
 else
 
-SUBDIRS = include util $(PQ_DIR) mintdb mint mint-tools
+SUBDIRS = include util $(PQ_DIR) wire mintdb mint mint-tools
 if HAVE_LIBCURL
  SUBDIRS += mint-lib
-else 
+else
 if HAVE_LIBGNURL
  SUBDIRS += mint-lib
 endif
diff --git a/src/include/taler_wire_plugin.h b/src/include/taler_wire_plugin.h
index fd86ca289..00bcc42e9 100644
--- a/src/include/taler_wire_plugin.h
+++ b/src/include/taler_wire_plugin.h
@@ -22,6 +22,8 @@
 #define TALER_WIRE_PLUGIN_H
 
 #include <gnunet/gnunet_util_lib.h>
+#include <jansson.h>
+#include "taler_util.h"
 
 
 /**
@@ -103,7 +105,7 @@ struct TALER_WIRE_Plugin
    * @return #GNUNET_YES if correctly formatted; #GNUNET_NO if not
    */
   int
-  wire_validate (const json_t *wire);
+  (*wire_validate) (const json_t *wire);
 
 
   /**
@@ -151,7 +153,7 @@ struct TALER_WIRE_Plugin
   (*execute_wire_transfer) (void *cls,
                             const char *buf,
                             size_t buf_size,
-                            TALER_WIRE_ConfirmatinCallback cc,
+                            TALER_WIRE_ConfirmationCallback cc,
                             void *cc_cls);
 
 
diff --git a/src/wire/Makefile.am b/src/wire/Makefile.am
new file mode 100644
index 000000000..a27a59c78
--- /dev/null
+++ b/src/wire/Makefile.am
@@ -0,0 +1,36 @@
+# This Makefile.am is in the public domain
+AM_CPPFLAGS = -I$(top_srcdir)/src/include
+
+if USE_COVERAGE
+  AM_CFLAGS = --coverage -O0
+  XLIB = -lgcov
+endif
+
+plugindir = $(libdir)/taler
+
+plugin_LTLIBRARIES = \
+  libtaler_plugin_wire_test.la
+
+noinst_LTLIBRARIES = \
+  libtaler_plugin_wire_template.la
+
+
+libtaler_plugin_wire_test_la_SOURCES = \
+  plugin_wire_test.c
+libtaler_plugin_wire_test_la_LIBADD = \
+  $(LTLIBINTL)
+libtaler_plugin_wire_test_la_LDFLAGS = \
+  $(TALER_PLUGIN_LDFLAGS) \
+  $(top_builddir)/src/util/libtalerutil.la \
+  -lgnunetutil $(XLIB)
+
+
+
+libtaler_plugin_wire_template_la_SOURCES = \
+  plugin_wire_template.c
+libtaler_plugin_wire_template_la_LIBADD = \
+  $(LTLIBINTL)
+libtaler_plugin_wire_template_la_LDFLAGS = \
+  $(TALER_PLUGIN_LDFLAGS) \
+  $(top_builddir)/src/util/libtalerutil.la \
+  -lgnunetutil $(XLIB)
diff --git a/src/wire/plugin_wire_template.c b/src/wire/plugin_wire_template.c
new file mode 100644
index 000000000..8abcca8c9
--- /dev/null
+++ b/src/wire/plugin_wire_template.c
@@ -0,0 +1,235 @@
+/*
+  This file is part of TALER
+  Copyright (C) 2016 GNUnet e.V.
+
+  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, If not, see <http://www.gnu.org/licenses/>
+*/
+
+/**
+ * @file plugin_wire_template.c
+ * @brief template for wire plugins; replace "template" with real plugin name!
+ * @author Florian Dold
+ * @author Christian Grothoff
+ * @author Sree Harsha Totakura
+ */
+#include "platform.h"
+#include "taler_wire_plugin.h"
+
+
+/**
+ * Type of the "cls" argument given to each of the functions in
+ * our API.
+ */
+struct TemplateClosure
+{
+
+  /**
+   * URI of the bank for sending funds to the bank.
+   */
+  char *bank_uri;
+
+  /**
+   * Which currency do we support?
+   */
+  char *currency;
+
+};
+
+
+/**
+ * Round amount DOWN to the amount that can be transferred via the wire
+ * method.  For example, Taler may support 0.000001 EUR as a unit of
+ * payment, but SEPA only supports 0.01 EUR.  This function would
+ * round 0.125 EUR to 0.12 EUR in this case.
+ *
+ * @param cls the @e cls of this struct with the plugin-specific state
+ * @param[in,out] amount amount to round down
+ * @return #GNUNET_OK on success, #GNUNET_NO if rounding was unnecessary,
+ *         #GNUNET_SYSERR if the amount or currency was invalid
+ */
+static int
+template_amount_round (void *cls,
+                       struct TALER_Amount *amount)
+{
+  GNUNET_break (0);
+  return GNUNET_SYSERR;
+}
+
+
+/**
+ * Check if the given wire format JSON object is correctly formatted
+ *
+ * @param wire the JSON wire format object
+ * @return #GNUNET_YES if correctly formatted; #GNUNET_NO if not
+ */
+static int
+template_wire_validate (const json_t *wire)
+{
+  GNUNET_break (0);
+  return GNUNET_SYSERR;
+}
+
+
+/**
+ * Prepare for exeuction of a wire transfer.
+ *
+ * @param cls the @e cls of this struct with the plugin-specific state
+ * @param wire valid wire account information
+ * @param amount amount to transfer, already rounded
+ * @param wtid wire transfer identifier to use
+ * @param ptc function to call with the prepared data to persist
+ * @param ptc_cls closure for @a ptc
+ * @return NULL on failure
+ */
+static struct TALER_WIRE_PrepareHandle *
+template_prepare_wire_transfer (void *cls,
+                                const json_t *wire,
+                                const struct TALER_Amount *amount,
+                                const void *wtid,
+                                TALER_WIRE_PrepareTransactionCallback ptc,
+                                void *ptc_cls)
+{
+  GNUNET_break (0);
+  return NULL;
+}
+
+
+/**
+ * Abort preparation of a wire transfer. For example,
+ * because we are shutting down.
+ *
+ * @param cls the @e cls of this struct with the plugin-specific state
+ * @param pth preparation to cancel
+ */
+static void
+template_prepare_wire_transfer_cancel (void *cls,
+                                       struct TALER_WIRE_PrepareHandle *pth)
+{
+  GNUNET_break (0);
+}
+
+
+/**
+ * Execute a wire transfer.
+ *
+ * @param cls the @e cls of this struct with the plugin-specific state
+ * @param buf buffer with the prepared execution details
+ * @param buf_size number of bytes in @a buf
+ * @param cc function to call upon success
+ * @param cc_cls closure for @a cc
+ * @return NULL on error
+ */
+static struct TALER_WIRE_ExecuteHandle *
+template_execute_wire_transfer (void *cls,
+                                const char *buf,
+                                size_t buf_size,
+                                TALER_WIRE_ConfirmationCallback cc,
+                                void *cc_cls)
+{
+  GNUNET_break (0);
+  return NULL;
+}
+
+
+/**
+ * Abort execution of a wire transfer. For example, because we are
+ * shutting down.  Note that if an execution is aborted, it may or
+ * may not still succeed. The caller MUST run @e
+ * execute_wire_transfer again for the same request as soon as
+ * possilbe, to ensure that the request either ultimately succeeds
+ * or ultimately fails. Until this has been done, the transaction is
+ * in limbo (i.e. may or may not have been committed).
+ *
+ * @param cls the @e cls of this struct with the plugin-specific state
+ * @param eh execution to cancel
+ */
+static void
+template_execute_wire_transfer_cancel (void *cls,
+                                       struct TALER_WIRE_ExecuteHandle *eh)
+{
+  GNUNET_break (0);
+}
+
+
+/**
+ * Initialize template-wire subsystem.
+ *
+ * @param cls a configuration instance
+ * @return NULL on error, otherwise a `struct TALER_WIRE_Plugin`
+ */
+void *
+libtaler_plugin_wire_template_init (void *cls)
+{
+  struct GNUNET_CONFIGURATION_Handle *cfg = cls;
+  struct TemplateClosure *tc;
+  struct TALER_WIRE_Plugin *plugin;
+
+  tc = GNUNET_new (struct TemplateClosure);
+
+  if (GNUNET_OK !=
+      GNUNET_CONFIGURATION_get_value_string (cfg,
+                                             "wire-template",
+                                             "bank_uri",
+                                             &tc->bank_uri))
+  {
+    GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
+                               "wire-template",
+                               "bank_uri");
+    GNUNET_free (tc);
+    return NULL;
+  }
+  if (GNUNET_OK !=
+      GNUNET_CONFIGURATION_get_value_string (cfg,
+                                             "mint",
+                                             "CURRENCY",
+                                             &tc->currency))
+  {
+    GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
+                               "mint",
+                               "CURRENCY");
+    GNUNET_free (tc->bank_uri);
+    GNUNET_free (tc);
+    return NULL;
+  }
+
+  plugin = GNUNET_new (struct TALER_WIRE_Plugin);
+  plugin->cls = tc;
+  plugin->amount_round = &template_amount_round;
+  plugin->wire_validate = &template_wire_validate;
+  plugin->prepare_wire_transfer = &template_prepare_wire_transfer;
+  plugin->prepare_wire_transfer_cancel = &template_prepare_wire_transfer_cancel;
+  plugin->execute_wire_transfer = &template_execute_wire_transfer;
+  plugin->execute_wire_transfer_cancel = &template_execute_wire_transfer_cancel;
+  return plugin;
+}
+
+
+/**
+ * Shutdown Template wire subsystem.
+ *
+ * @param cls a `struct TALER_WIRE_Plugin`
+ * @return NULL (always)
+ */
+void *
+libtaler_plugin_wire_template_done (void *cls)
+{
+  struct TALER_WIRE_Plugin *plugin = cls;
+  struct TemplateClosure *tc = plugin->cls;
+
+  GNUNET_free (tc->bank_uri);
+  GNUNET_free (tc->currency);
+  GNUNET_free (tc);
+  GNUNET_free (plugin);
+  return NULL;
+}
+
+/* end of plugin_wire_template.c */
diff --git a/src/wire/plugin_wire_test.c b/src/wire/plugin_wire_test.c
new file mode 100644
index 000000000..72c87ef55
--- /dev/null
+++ b/src/wire/plugin_wire_test.c
@@ -0,0 +1,235 @@
+/*
+  This file is part of TALER
+  Copyright (C) 2016 GNUnet e.V.
+
+  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, If not, see <http://www.gnu.org/licenses/>
+*/
+
+/**
+ * @file plugin_wire_test.c
+ * @brief plugin for the "test" wire method
+ * @author Florian Dold
+ * @author Christian Grothoff
+ * @author Sree Harsha Totakura
+ */
+#include "platform.h"
+#include "taler_wire_plugin.h"
+
+
+/**
+ * Type of the "cls" argument given to each of the functions in
+ * our API.
+ */
+struct TestClosure
+{
+
+  /**
+   * URI of the bank for sending funds to the bank.
+   */
+  char *bank_uri;
+
+  /**
+   * Which currency do we support?
+   */
+  char *currency;
+
+};
+
+
+/**
+ * Round amount DOWN to the amount that can be transferred via the wire
+ * method.  For example, Taler may support 0.000001 EUR as a unit of
+ * payment, but SEPA only supports 0.01 EUR.  This function would
+ * round 0.125 EUR to 0.12 EUR in this case.
+ *
+ * @param cls the @e cls of this struct with the plugin-specific state
+ * @param[in,out] amount amount to round down
+ * @return #GNUNET_OK on success, #GNUNET_NO if rounding was unnecessary,
+ *         #GNUNET_SYSERR if the amount or currency was invalid
+ */
+static int
+test_amount_round (void *cls,
+                   struct TALER_Amount *amount)
+{
+  GNUNET_break (0);
+  return GNUNET_SYSERR;
+}
+
+
+/**
+ * Check if the given wire format JSON object is correctly formatted
+ *
+ * @param wire the JSON wire format object
+ * @return #GNUNET_YES if correctly formatted; #GNUNET_NO if not
+ */
+static int
+test_wire_validate (const json_t *wire)
+{
+  GNUNET_break (0);
+  return GNUNET_SYSERR;
+}
+
+
+/**
+ * Prepare for exeuction of a wire transfer.
+ *
+ * @param cls the @e cls of this struct with the plugin-specific state
+ * @param wire valid wire account information
+ * @param amount amount to transfer, already rounded
+ * @param wtid wire transfer identifier to use
+ * @param ptc function to call with the prepared data to persist
+ * @param ptc_cls closure for @a ptc
+ * @return NULL on failure
+ */
+static struct TALER_WIRE_PrepareHandle *
+test_prepare_wire_transfer (void *cls,
+                            const json_t *wire,
+                            const struct TALER_Amount *amount,
+                            const void *wtid,
+                            TALER_WIRE_PrepareTransactionCallback ptc,
+                            void *ptc_cls)
+{
+  GNUNET_break (0);
+  return NULL;
+}
+
+
+/**
+ * Abort preparation of a wire transfer. For example,
+ * because we are shutting down.
+ *
+ * @param cls the @e cls of this struct with the plugin-specific state
+ * @param pth preparation to cancel
+ */
+static void
+test_prepare_wire_transfer_cancel (void *cls,
+                                   struct TALER_WIRE_PrepareHandle *pth)
+{
+  GNUNET_break (0);
+}
+
+
+/**
+ * Execute a wire transfer.
+ *
+ * @param cls the @e cls of this struct with the plugin-specific state
+ * @param buf buffer with the prepared execution details
+ * @param buf_size number of bytes in @a buf
+ * @param cc function to call upon success
+ * @param cc_cls closure for @a cc
+ * @return NULL on error
+ */
+static struct TALER_WIRE_ExecuteHandle *
+test_execute_wire_transfer (void *cls,
+                            const char *buf,
+                            size_t buf_size,
+                            TALER_WIRE_ConfirmationCallback cc,
+                            void *cc_cls)
+{
+  GNUNET_break (0);
+  return NULL;
+}
+
+
+/**
+ * Abort execution of a wire transfer. For example, because we are
+ * shutting down.  Note that if an execution is aborted, it may or
+ * may not still succeed. The caller MUST run @e
+ * execute_wire_transfer again for the same request as soon as
+ * possilbe, to ensure that the request either ultimately succeeds
+ * or ultimately fails. Until this has been done, the transaction is
+ * in limbo (i.e. may or may not have been committed).
+ *
+ * @param cls the @e cls of this struct with the plugin-specific state
+ * @param eh execution to cancel
+ */
+static void
+test_execute_wire_transfer_cancel (void *cls,
+                                   struct TALER_WIRE_ExecuteHandle *eh)
+{
+  GNUNET_break (0);
+}
+
+
+/**
+ * Initialize test-wire subsystem.
+ *
+ * @param cls a configuration instance
+ * @return NULL on error, otherwise a `struct TALER_WIRE_Plugin`
+ */
+void *
+libtaler_plugin_wire_test_init (void *cls)
+{
+  struct GNUNET_CONFIGURATION_Handle *cfg = cls;
+  struct TestClosure *tc;
+  struct TALER_WIRE_Plugin *plugin;
+
+  tc = GNUNET_new (struct TestClosure);
+
+  if (GNUNET_OK !=
+      GNUNET_CONFIGURATION_get_value_string (cfg,
+                                             "wire-test",
+                                             "bank_uri",
+                                             &tc->bank_uri))
+    {
+    GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
+                               "wire-test",
+                               "bank_uri");
+    GNUNET_free (tc);
+    return NULL;
+  }
+  if (GNUNET_OK !=
+      GNUNET_CONFIGURATION_get_value_string (cfg,
+                                             "mint",
+                                             "CURRENCY",
+                                             &tc->currency))
+  {
+    GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
+                               "mint",
+                               "CURRENCY");
+    GNUNET_free (tc->bank_uri);
+    GNUNET_free (tc);
+    return NULL;
+  }
+
+  plugin = GNUNET_new (struct TALER_WIRE_Plugin);
+  plugin->cls = tc;
+  plugin->amount_round = &test_amount_round;
+  plugin->wire_validate = &test_wire_validate;
+  plugin->prepare_wire_transfer = &test_prepare_wire_transfer;
+  plugin->prepare_wire_transfer_cancel = &test_prepare_wire_transfer_cancel;
+  plugin->execute_wire_transfer = &test_execute_wire_transfer;
+  plugin->execute_wire_transfer_cancel = &test_execute_wire_transfer_cancel;
+  return plugin;
+}
+
+
+/**
+ * Shutdown Test wire subsystem.
+ *
+ * @param cls a `struct TALER_WIRE_Plugin`
+ * @return NULL (always)
+ */
+void *
+libtaler_plugin_wire_test_done (void *cls)
+{
+  struct TALER_WIRE_Plugin *plugin = cls;
+  struct TestClosure *tc = plugin->cls;
+
+  GNUNET_free (tc->bank_uri);
+  GNUNET_free (tc->currency);
+  GNUNET_free (tc);
+  GNUNET_free (plugin);
+  return NULL;
+}
+
+/* end of plugin_wire_test.c */