fix unload
[oweals/gnunet.git] / src / transport / plugin_transport_http_client.c
index fc954498cb1c0650b89391e2dd91d0ccf95a5731..eda1f59becb0177e28ecb5d1f1c36657bcb03ca0 100644 (file)
 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_http_client_done
 #endif
 
-
-#define HTTP_NOT_VALIDATED_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
+#define VERBOSE_CURL GNUNET_NO
 
 #include "platform.h"
 #include "gnunet_protocols.h"
-#include "gnunet_connection_lib.h"
+#include "gnunet_common.h"
 #include "gnunet_server_lib.h"
-#include "gnunet_service_lib.h"
-#include "gnunet_statistics_service.h"
-#include "gnunet_transport_service.h"
 #include "gnunet_transport_plugin.h"
 #include "plugin_transport_http_common.h"
 #include <curl/curl.h>
@@ -147,7 +143,7 @@ struct Session
   /**
    * Was session given to transport service?
    */
-  int session_passed;
// int session_passed;
 
   /**
    * Client send handle
@@ -191,6 +187,7 @@ struct Session
  struct GNUNET_TIME_Absolute next_receive;
 };
 
+
 /**
  * Encapsulation of all of the state of the plugin.
  */
@@ -259,29 +256,37 @@ struct HTTP_Client_Plugin
   GNUNET_SCHEDULER_TaskIdentifier client_perform_task;
 };
 
+
 /**
  * Encapsulation of all of the state of the plugin.
  */
 struct HTTP_Client_Plugin *p;
 
+
 /**
- * Start session timeout
+ * Start session timeout for a session
+ * @param s the session
  */
 static void
 client_start_session_timeout (struct Session *s);
 
+
 /**
- * Increment session timeout due to activity
+ * Increment session timeout due to activity for a session
+ * @param s the session
  */
 static void
 client_reschedule_session_timeout (struct Session *s);
 
+
 /**
- * Cancel timeout
+ * Cancel timeout for a session
+ * @param s the session
  */
 static void
 client_stop_session_timeout (struct Session *s);
 
+
 /**
  * Function setting up file descriptors and scheduling task to run
  *
@@ -293,7 +298,14 @@ static int
 client_schedule (struct HTTP_Client_Plugin *plugin, int now);
 
 
-int
+/**
+ * Does a session s exists?
+ *
+ * @param plugin the plugin
+ * @param s desired session
+ * @return GNUNET_YES or GNUNET_NO
+ */
+static int
 client_exist_session (struct HTTP_Client_Plugin *plugin, struct Session *s)
 {
   struct Session * head;
@@ -309,6 +321,60 @@ client_exist_session (struct HTTP_Client_Plugin *plugin, struct Session *s)
   return GNUNET_NO;
 }
 
+#if VERBOSE_CURL
+/**
+ * Function to log curl debug messages with GNUNET_log
+ *
+ * @param curl handle
+ * @param type curl_infotype
+ * @param data data
+ * @param size size
+ * @param cls  closure
+ * @return 0
+ */
+static int
+client_log (CURL * curl, curl_infotype type, char *data, size_t size, void *cls)
+{
+  char *ttype;
+  if ((type == CURLINFO_TEXT) || (type == CURLINFO_HEADER_IN) || (type == CURLINFO_HEADER_OUT))
+  {
+    char text[size + 2];
+
+    switch (type) {
+      case CURLINFO_TEXT:
+        ttype = "TEXT";
+        break;
+      case CURLINFO_HEADER_IN:
+        ttype = "HEADER_IN";
+        break;
+      case CURLINFO_HEADER_OUT:
+        ttype = "HEADER_OUT";
+        break;
+      default:
+        break;
+    }
+
+    memcpy (text, data, size);
+    if (text[size - 1] == '\n')
+      text[size] = '\0';
+    else
+    {
+      text[size] = '\n';
+      text[size + 1] = '\0';
+    }
+#if BUILD_HTTPS
+    GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-https_client",
+                     "Connection %p %s: %s", cls, ttype, text);
+#else
+    GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-http_client",
+                     "Connection %p %s: %s", cls, ttype, text);
+#endif
+  }
+  return 0;
+}
+#endif
+
+
 /**
  * Function that can be used by the transport service to transmit
  * a message using the plugin.   Note that in the case of a
@@ -346,7 +412,6 @@ http_client_plugin_send (void *cls,
 {
   struct HTTP_Client_Plugin *plugin = cls;
   struct HTTP_Message *msg;
-  size_t res = -1;
 
   GNUNET_assert (plugin != NULL);
   GNUNET_assert (session != NULL);
@@ -384,22 +449,27 @@ http_client_plugin_send (void *cls,
   }
   client_schedule (session->plugin, GNUNET_YES);
   client_reschedule_session_timeout (session);
-
-  return res;
+  return msgbuf_size;
 }
 
 
-void
+/**
+ * Delete session s
+ *
+ * @param s the session to delete
+ */
+static void
 client_delete_session (struct Session *s)
 {
   struct HTTP_Client_Plugin *plugin = s->plugin;
-  struct HTTP_Message *pos = s->msg_head;
-  struct HTTP_Message *next = NULL;
+  struct HTTP_Message *pos;
+  struct HTTP_Message *next;
 
   client_stop_session_timeout (s);
 
   GNUNET_CONTAINER_DLL_remove (plugin->head, plugin->tail, s);
 
+  next = s->msg_head;
   while (NULL != (pos = next))
   {
     next = pos->next;
@@ -435,7 +505,7 @@ client_disconnect (struct Session *s)
   int res = GNUNET_OK;
   CURLMcode mret;
 
-  if (GNUNET_YES != client_exist_session(plugin, s))
+  if (GNUNET_YES != client_exist_session (plugin, s))
   {
     GNUNET_break (0);
     return GNUNET_SYSERR;
@@ -444,7 +514,7 @@ client_disconnect (struct Session *s)
   if (s->client_put != NULL)
   {
     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
-                     "Session %p/connection %p: disconnecting PUT connectionto peer `%s'\n",
+                     "Session %p/connection %p: disconnecting PUT connection to peer `%s'\n",
                      s, s->client_put, GNUNET_i2s (&s->target));
 
     /* remove curl handle from multi handle */
@@ -554,6 +624,7 @@ http_client_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *targ
 
 }
 
+
 static struct Session *
 client_lookup_session (struct HTTP_Client_Plugin *plugin,
                        const struct GNUNET_HELLO_Address *address)
@@ -568,6 +639,7 @@ client_lookup_session (struct HTTP_Client_Plugin *plugin,
   return NULL;
 }
 
+
 /**
  * Callback method used with libcurl
  * Method is called when libcurl needs to read data during sending
@@ -622,6 +694,12 @@ client_send_cb (void *stream, size_t size, size_t nmemb, void *cls)
 }
 
 
+/**
+ * Wake up a curl handle which was suspended
+ *
+ * @param cls the session
+ * @param tc task context
+ */
 static void
 client_wake_up (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
@@ -642,7 +720,14 @@ client_wake_up (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 }
 
 
-
+/**
+ * Callback for message stream tokenixer
+ *
+ * @param cls the session
+ * @param client not used
+ * @param message the message received
+ * @return always GNUNET_OK
+ */
 static int
 client_receive_mst_cb (void *cls, void *client,
                        const struct GNUNET_MessageHeader *message)
@@ -699,8 +784,6 @@ client_receive_mst_cb (void *cls, void *client,
 static size_t
 client_receive (void *stream, size_t size, size_t nmemb, void *cls)
 {
-  return 0;
-
   struct Session *s = cls;
   struct GNUNET_TIME_Absolute now;
   size_t len = size * nmemb;
@@ -734,6 +817,7 @@ client_receive (void *stream, size_t size, size_t nmemb, void *cls)
 
 }
 
+
 /**
  * Task performing curl operations
  *
@@ -743,6 +827,7 @@ client_receive (void *stream, size_t size, size_t nmemb, void *cls)
 static void
 client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 
+
 /**
  * Function setting up file descriptors and scheduling task to run
  *
@@ -812,7 +897,6 @@ client_schedule (struct HTTP_Client_Plugin *plugin, int now)
 }
 
 
-
 /**
  * Task performing curl operations
  *
@@ -884,7 +968,6 @@ client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
   client_schedule (plugin, GNUNET_NO);
 }
 
-
 static int
 client_connect (struct Session *s)
 {
@@ -931,11 +1014,11 @@ client_connect (struct Session *s)
   curl_easy_setopt (s->client_get, CURLOPT_READDATA, s);
   curl_easy_setopt (s->client_get, CURLOPT_WRITEFUNCTION, client_receive);
   curl_easy_setopt (s->client_get, CURLOPT_WRITEDATA, s);
-  curl_easy_setopt (s->client_get, CURLOPT_TIMEOUT_MS,
-                    (long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
+  /* No timeout by default, timeout done with session timeout */
+  curl_easy_setopt (s->client_get, CURLOPT_TIMEOUT, 0);
   curl_easy_setopt (s->client_get, CURLOPT_PRIVATE, s);
   curl_easy_setopt (s->client_get, CURLOPT_CONNECTTIMEOUT_MS,
-                    (long) HTTP_NOT_VALIDATED_TIMEOUT.rel_value);
+                    (long) HTTP_CLIENT_NOT_VALIDATED_TIMEOUT.rel_value);
   curl_easy_setopt (s->client_get, CURLOPT_BUFFERSIZE,
                     2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
 #if CURL_TCP_NODELAY
@@ -955,18 +1038,23 @@ client_connect (struct Session *s)
   curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYHOST, 0);
 #endif
   curl_easy_setopt (s->client_put, CURLOPT_URL, url);
-  curl_easy_setopt (s->client_put, CURLOPT_PUT, 1L);
-  //curl_easy_setopt (s->client_put, CURLOPT_HEADERFUNCTION, &curl_put_header_cb);
+  curl_easy_setopt (s->client_put, CURLOPT_UPLOAD, 1L);
+  /*
+  struct curl_slist *m_headerlist;
+  m_headerlist = NULL;
+  m_headerlist = curl_slist_append(m_headerlist, "Transfer-Encoding: chunked");
+  curl_easy_setopt(s->client_put, CURLOPT_HTTPHEADER, m_headerlist);*/
+  //curl_easy_setopt (s->client_put, CURLOPT_HEADERFUNCTION, &client_curl_header);
   //curl_easy_setopt (s->client_put, CURLOPT_WRITEHEADER, ps);
   curl_easy_setopt (s->client_put, CURLOPT_READFUNCTION, client_send_cb);
   curl_easy_setopt (s->client_put, CURLOPT_READDATA, s);
   curl_easy_setopt (s->client_put, CURLOPT_WRITEFUNCTION, client_receive);
   curl_easy_setopt (s->client_put, CURLOPT_WRITEDATA, s);
-  curl_easy_setopt (s->client_put, CURLOPT_TIMEOUT_MS,
-                    (long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
+  /* No timeout by default, timeout done with session timeout */
+  curl_easy_setopt (s->client_put, CURLOPT_TIMEOUT, 0);
   curl_easy_setopt (s->client_put, CURLOPT_PRIVATE, s);
   curl_easy_setopt (s->client_put, CURLOPT_CONNECTTIMEOUT_MS,
-                    (long) HTTP_NOT_VALIDATED_TIMEOUT.rel_value);
+                    (long) HTTP_CLIENT_NOT_VALIDATED_TIMEOUT.rel_value);
   curl_easy_setopt (s->client_put, CURLOPT_BUFFERSIZE,
                     2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
 #if CURL_TCP_NODELAY
@@ -1028,12 +1116,15 @@ http_client_plugin_get_session (void *cls,
 {
   struct HTTP_Client_Plugin *plugin = cls;
   struct Session * s = NULL;
+  struct sockaddr *sa;
+  struct GNUNET_ATS_Information ats;
+  size_t salen = 0;
+  int res;
 
   GNUNET_assert (plugin != NULL);
   GNUNET_assert (address != NULL);
   GNUNET_assert (address->address != NULL);
 
-
   /* find existing session */
   s = client_lookup_session (plugin, address);
   if (s != NULL)
@@ -1049,14 +1140,46 @@ http_client_plugin_get_session (void *cls,
     return NULL;
   }
 
+  ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
+  ats.value = htonl (GNUNET_ATS_NET_UNSPECIFIED);
+  sa = http_common_socket_from_address (address->address, address->address_length, &res);
+
+  if (GNUNET_SYSERR == res)
+  {
+      return NULL;
+  }
+  else if (GNUNET_YES == res)
+  {
+      GNUNET_assert (NULL != sa);
+      if (AF_INET == sa->sa_family)
+      {
+          salen = sizeof (struct sockaddr_in);
+      }
+      else if (AF_INET == sa->sa_family)
+      {
+          salen = sizeof (struct sockaddr_in6);
+      }
+      ats = plugin->env->get_address_type (plugin->env->cls, sa, salen);
+      GNUNET_free (sa);
+  }
+  else if (GNUNET_NO == res)
+  {
+      ats.value = htonl (GNUNET_ATS_COST_WAN);
+  }
+
+  if (GNUNET_ATS_NET_UNSPECIFIED == ntohl(ats.value))
+  {
+      GNUNET_break (0);
+      return NULL;
+  }
+
   s = GNUNET_malloc (sizeof (struct Session));
   memcpy (&s->target, &address->peer, sizeof (struct GNUNET_PeerIdentity));
   s->plugin = plugin;
   s->addr = GNUNET_malloc (address->address_length);
   memcpy (s->addr, address->address, address->address_length);
   s->addrlen = address->address_length;
-  //s->ats_address_network_type = ats.value;
-  GNUNET_break (0);
+  s->ats_address_network_type = ats.value;
 
   client_start_session_timeout (s);
 
@@ -1076,6 +1199,13 @@ http_client_plugin_get_session (void *cls,
   return s;
 }
 
+
+/**
+ * Setup http_client plugin
+ *
+ * @param plugin the plugin handle
+ * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ */
 static int
 client_start (struct HTTP_Client_Plugin *plugin)
 {
@@ -1104,32 +1234,38 @@ client_session_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc
   s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
   GNUNET_log (TIMEOUT_LOG,
               "Session %p was idle for %llu ms, disconnecting\n",
-              s, (unsigned long long) TIMEOUT.rel_value);
+              s, (unsigned long long) CLIENT_SESSION_TIMEOUT.rel_value);
 
   /* call session destroy function */
   GNUNET_assert (GNUNET_OK == client_disconnect (s));
 }
 
+
 /**
-* Start session timeout
-*/
+ * Start session timeout for session s
+ *
+ * @param s the session
+ */
 static void
 client_start_session_timeout (struct Session *s)
 {
 
  GNUNET_assert (NULL != s);
  GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == s->timeout_task);
- s->timeout_task =  GNUNET_SCHEDULER_add_delayed (TIMEOUT,
+ s->timeout_task =  GNUNET_SCHEDULER_add_delayed (CLIENT_SESSION_TIMEOUT,
                                                   &client_session_timeout,
                                                   s);
  GNUNET_log (TIMEOUT_LOG,
              "Timeout for session %p set to %llu ms\n",
-             s,  (unsigned long long) TIMEOUT.rel_value);
+             s,  (unsigned long long) CLIENT_SESSION_TIMEOUT.rel_value);
 }
 
+
 /**
-* Increment session timeout due to activity
-*/
+ * Increment session timeout due to activity for session s
+ *
+ * param s the session
+ */
 static void
 client_reschedule_session_timeout (struct Session *s)
 {
@@ -1138,17 +1274,20 @@ client_reschedule_session_timeout (struct Session *s)
  GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != s->timeout_task);
 
  GNUNET_SCHEDULER_cancel (s->timeout_task);
- s->timeout_task =  GNUNET_SCHEDULER_add_delayed (TIMEOUT,
+ s->timeout_task =  GNUNET_SCHEDULER_add_delayed (CLIENT_SESSION_TIMEOUT,
                                                   &client_session_timeout,
                                                   s);
  GNUNET_log (TIMEOUT_LOG,
              "Timeout rescheduled for session %p set to %llu ms\n",
-             s, (unsigned long long) TIMEOUT.rel_value);
+             s, (unsigned long long) CLIENT_SESSION_TIMEOUT.rel_value);
 }
 
+
 /**
-* Cancel timeout
-*/
+ * Cancel timeout due to activity for session s
+ *
+ * param s the session
+ */
 static void
 client_stop_session_timeout (struct Session *s)
 {
@@ -1184,8 +1323,12 @@ http_client_plugin_address_suggested (void *cls, const void *addr, size_t addrle
   return GNUNET_NO;
 }
 
+
 /**
  * Exit point from the plugin.
+ *
+ * @param cls api as closure
+ * @return NULL
  */
 void *
 LIBGNUNET_PLUGIN_TRANSPORT_DONE (void *cls)
@@ -1195,24 +1338,31 @@ LIBGNUNET_PLUGIN_TRANSPORT_DONE (void *cls)
   struct Session *pos;
   struct Session *next;
 
+  if (NULL == api->cls)
+  {
+    /* Stub shutdown */
+    GNUNET_free (api);
+    return NULL;
+  }
+
   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
                    _("Shutting down plugin `%s'\n"),
                    plugin->name);
 
+
   next = plugin->head;
   while (NULL != (pos = next))
   {
       next = pos->next;
-      GNUNET_CONTAINER_DLL_remove( plugin->head, plugin->tail, pos);
       client_disconnect (pos);
   }
-
-  if (NULL == api->cls)
+  if (GNUNET_SCHEDULER_NO_TASK != plugin->client_perform_task)
   {
-    GNUNET_free (api);
-    return NULL;
+      GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
+      plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
   }
 
+
   if (NULL != plugin->curl_multi_handle)
   {
     curl_multi_cleanup (plugin->curl_multi_handle);
@@ -1230,6 +1380,12 @@ LIBGNUNET_PLUGIN_TRANSPORT_DONE (void *cls)
 }
 
 
+/**
+ * Configure plugin
+ *
+ * @param plugin the plugin handle
+ * @return GNUNET_OK on success, GNUNET_SYSERR on failure
+ */
 static int
 client_configure_plugin (struct HTTP_Client_Plugin *plugin)
 {