-doxygen
[oweals/gnunet.git] / src / transport / gnunet-service-transport_plugins.c
index f3e7ccaa46b9e0e4beb1dd157ff612b0378eaa37..83c062ec3715c7f94f1ec28bc5fb61af62bfe6eb 100644 (file)
@@ -87,12 +87,18 @@ static struct TransportPlugin *plugins_tail;
  *
  * @param recv_cb function to call when data is received
  * @param address_cb function to call when our public addresses changed
+ * @param session_start_cb function to call when a session was created
  * @param session_end_cb function to call when a session was terminated
+ * @param address_type_cb function to call when a address type is requested
+ * @param metric_update_cb function to call when address metrics change
  */
 void
 GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
                   GNUNET_TRANSPORT_AddressNotification address_cb,
-                  GNUNET_TRANSPORT_SessionEnd session_end_cb)
+                  GNUNET_TRANSPORT_SessionStart session_start_cb,
+                  GNUNET_TRANSPORT_SessionEnd session_end_cb,
+                  GNUNET_TRANSPORT_AddressToType address_type_cb,
+                  GNUNET_TRANSPORT_UpdateAddressMetrics metric_update_cb)
 {
   struct TransportPlugin *plug;
   struct TransportPlugin *next;
@@ -100,6 +106,7 @@ GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
   char *libname;
   char *plugs;
   char *pos;
+  int fail;
 
   if (GNUNET_OK !=
       GNUNET_CONFIGURATION_get_value_number (GST_cfg, "TRANSPORT",
@@ -129,7 +136,10 @@ GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
     plug->env.cls = plug->short_name;
     plug->env.receive = recv_cb;
     plug->env.notify_address = address_cb;
+    plug->env.session_start = session_start_cb;
     plug->env.session_end = session_end_cb;
+    plug->env.get_address_type = address_type_cb;
+    plug->env.update_address_metrics = metric_update_cb;
     plug->env.max_connections = tneigh;
     plug->env.stats = GST_stats;
     GNUNET_CONTAINER_DLL_insert (plugins_head, plugins_tail, plug);
@@ -144,7 +154,84 @@ GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
     if (plug->api == NULL)
     {
       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-                  _("Failed to load transport plugin for `%s'\n"), pos);
+                  _("Failed to load transport plugin for `%s'\n"),
+                  plug->lib_name);
+      GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
+      GNUNET_free (plug->short_name);
+      GNUNET_free (plug->lib_name);
+      GNUNET_free (plug);
+      continue;
+    }
+    fail = GNUNET_NO;
+    if (NULL == plug->api->address_pretty_printer)
+    {
+       fail = GNUNET_YES;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Missing function `%s' in transport plugin for `%s'\n"),
+                  "address_pretty_printer",
+                  plug->lib_name);
+    }
+    if (NULL == plug->api->address_to_string)
+    {
+       fail = GNUNET_YES;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Missing function `%s' in transport plugin for `%s'\n"),
+                  "address_to_string",
+                  plug->lib_name);
+    }
+    if (NULL == plug->api->string_to_address)
+    {
+       fail = GNUNET_YES;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Missing function `%s' in transport plugin for `%s'\n"),
+                  "string_to_address",
+                  plug->lib_name);
+    }
+    if (NULL == plug->api->check_address)
+    {
+       fail = GNUNET_YES;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Missing function `%s' in transport plugin for `%s'\n"),
+                  "check_address",
+                  plug->lib_name);
+    }
+    if (NULL == plug->api->get_session)
+    {
+       fail = GNUNET_YES;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Missing function `%s' in transport plugin for `%s'\n"),
+                  "get_session",
+                  plug->lib_name);
+    }
+    if (NULL == plug->api->get_network)
+    {
+       fail = GNUNET_YES;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Missing function `%s' in transport plugin for `%s'\n"),
+                  "get_network",
+                  plug->lib_name);
+    }
+    if (NULL == plug->api->send)
+    {
+       fail = GNUNET_YES;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Missing function `%s' in transport plugin for `%s'\n"),
+                  "send",
+                  plug->lib_name);
+    }
+    if (NULL == plug->api->disconnect)
+    {
+       fail = GNUNET_YES;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Missing function `%s' in transport plugin for `%s'\n"),
+                  "disconnect",
+                  plug->lib_name);
+    }
+    if (GNUNET_YES == fail)
+    {
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Did not load plugin `%s' due to missing functions\n"),
+                  plug->lib_name);
       GNUNET_CONTAINER_DLL_remove (plugins_head, plugins_tail, plug);
       GNUNET_free (plug->short_name);
       GNUNET_free (plug->lib_name);
@@ -192,6 +279,39 @@ GST_plugins_find (const char *name)
 }
 
 
+/**
+ * Obtain the plugin API based on a the stripped plugin name after the underscore.
+ *
+ * Example: GST_plugins_printer_find (http_client) will return all plugins
+ * starting with the prefix "http":
+ * http_client or server if loaded
+ *
+ * @param name name of the plugin
+ * @return the plugin's API, NULL if the plugin is not loaded
+ */
+struct GNUNET_TRANSPORT_PluginFunctions *
+GST_plugins_printer_find (const char *name)
+{
+  struct TransportPlugin *head = plugins_head;
+
+  char *stripped = GNUNET_strdup (name);
+  char *sep = strchr (stripped, '_');
+  if (NULL != sep)
+    sep[0] = '\0';
+
+  while (head != NULL)
+  {
+    if (head->short_name == strstr (head->short_name, stripped))
+        break;
+    head = head->next;
+  }
+  GNUNET_free (stripped);
+  if (NULL == head)
+    return NULL;
+  return head->api;
+}
+
+
 /**
  * Convert a given address to a human-readable format.  Note that the
  * return value will be overwritten on the next call to this function.
@@ -203,13 +323,29 @@ const char *
 GST_plugins_a2s (const struct GNUNET_HELLO_Address *address)
 {
   struct GNUNET_TRANSPORT_PluginFunctions *api;
+  static char unable_to_show[1024];
+  static const char *s;
 
   if (address == NULL)
-    return "<inbound>";
-  api = GST_plugins_find (address->transport_name);
-  if ((api == NULL) || (address->address_length == 0) || (address->address == NULL))
-    return NULL;
-  return api->address_to_string (NULL, address->address, address->address_length);
+  {
+       GNUNET_break (0); /* a HELLO address cannot be NULL */
+    return "<invalid>";
+  }
+  if (0 == address->address_length)
+    return TRANSPORT_SESSION_INBOUND_STRING; /* Addresse with length 0 are inbound, address->address itself may be NULL */
+  api = GST_plugins_printer_find (address->transport_name);
+  if (NULL == api)
+    return "<plugin unknown>";
+  if (0 == address->address_length)
+  {
+    GNUNET_snprintf (unable_to_show, sizeof (unable_to_show),
+                     "<unable to stringify %u-byte long address of %s transport>",
+                     (unsigned int) address->address_length,
+                     address->transport_name);
+    return unable_to_show;
+  }
+  return (NULL != (s = api->address_to_string (NULL, address->address,
+                                 address->address_length)) ? s : "<invalid>");
 }