docu
[oweals/gnunet.git] / src / transport / plugin_transport_http_client.c
index 3dce0775dcc7e4776f1c91837e1a19c53f22f27e..351687a07f30116aca240728a38f75275d3f7577 100644 (file)
@@ -48,6 +48,7 @@
 #include <curl/curl.h>
 
 
+
 /**
  * Encapsulation of all of the state of the plugin.
  */
@@ -84,12 +85,6 @@ struct HTTP_Message
    */
   size_t size;
 
-  /**
-   * HTTP overhead required to send this message
-   * FIXME: to implement
-   */
-  size_t overhead;
-
   /**
    * Continuation function to call once the transmission buffer
    * has again space available.  NULL if there is no
@@ -103,6 +98,31 @@ struct HTTP_Message
   void *transmit_cont_cls;
 };
 
+
+/**
+ * Session handle for connections.
+ */
+struct Session;
+
+/**
+ * A connection handle
+ * 
+ */
+struct ConnectionHandle
+{
+  /**
+   * The curl easy handle 
+   */
+  CURL *easyhandle;
+  
+  /**
+   * The related session 
+   */
+  struct Session *s;
+};
+
+
+
 /**
  * Session handle for connections.
  */
@@ -149,16 +169,13 @@ struct Session
    */
   struct HTTP_Client_Plugin *plugin;
 
-  /**
-   * Was session given to transport service?
-   */
- // int session_passed;
-
   /**
    * Client send handle
    */
   void *client_put;
 
+  struct ConnectionHandle put;
+  struct ConnectionHandle get;
 
   /**
    * Is the client PUT handle currently paused
@@ -225,7 +242,7 @@ struct Session
   * Absolute time when to receive data again
   * Used for receive throttling
   */
- struct GNUNET_TIME_Absolute next_receive;
 struct GNUNET_TIME_Absolute next_receive;
 };
 
 
@@ -338,9 +355,17 @@ client_stop_session_timeout (struct Session *s);
 static int
 client_schedule (struct HTTP_Client_Plugin *plugin, int now);
 
+
+/**
+ * Connect a HTTP put connection 
+ *
+ * @param s the session to connect
+ * @return GNUNET_SYSERR for hard failure, GNUNET_OK for success
+ */
 static int
 client_connect_put (struct Session *s);
 
+
 /**
  * Does a session s exists?
  *
@@ -364,28 +389,24 @@ client_exist_session (struct HTTP_Client_Plugin *plugin, struct Session *s)
   return GNUNET_NO;
 }
 
-static void
-client_remark_outbound_overhead (void *cls, size_t size)
-{
-  //FIXME use this overhead
-  GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-http_client",
-                   "Overhead: %u\n", size);
-}
 
 /**
- * Function to log curl debug messages with GNUNET_log
+ * Loggging function
  *
- * @param curl handle
- * @param type curl_infotype
- * @param data data
- * @param size size
- * @param cls  closure
- * @return 0
+ * @param curl the curl easy handle
+ * @param type message type
+ * @param data data to log, NOT a 0-terminated string
+ * @param size data length
+ * @param cls the closure
+ * @return always 0
  */
 static int
-client_log (CURL * curl, curl_infotype type, char *data, size_t size, void *cls)
+client_log (CURL *curl, curl_infotype type, 
+           const char *data, size_t size, void *cls)
 {
-  char *ttype = "UNSPECIFIED";
+  struct ConnectionHandle *ch = cls;
+  const char *ttype = "UNSPECIFIED";
+
   if ((type == CURLINFO_TEXT) || (type == CURLINFO_HEADER_IN) || (type == CURLINFO_HEADER_OUT))
   {
     char text[size + 2];
@@ -399,13 +420,18 @@ client_log (CURL * curl, curl_infotype type, char *data, size_t size, void *cls)
         break;
       case CURLINFO_HEADER_OUT:
         ttype = "HEADER_OUT";
-        client_remark_outbound_overhead (cls, size);
+        /* Overhead*/
+
+        GNUNET_assert (NULL != ch);
+        GNUNET_assert (NULL != ch->easyhandle);
+        GNUNET_assert (NULL != ch->s);
+        ch->s->overhead += size;
         break;
       default:
         ttype = "UNSPECIFIED";
         break;
     }
-#if VERBOSE_CURL
+
     memcpy (text, data, size);
     if (text[size - 1] == '\n')
       text[size] = '\0';
@@ -416,18 +442,16 @@ client_log (CURL * curl, curl_infotype type, char *data, size_t size, void *cls)
     }
 #if BUILD_HTTPS
     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-https_client",
-                     "Connection %p %s: %s", cls, ttype, text);
+                     "Connection %p %s: %s", ch->easyhandle, ttype, text);
 #else
     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-http_client",
-                     "Connection %p %s: %s", cls, ttype, text);
+                     "Connection %p %s: %s", ch->easyhandle, ttype, text);
 #endif
   }
-#endif
   return 0;
 }
 
 
-
 /**
  * Function that can be used by the transport service to transmit
  * a message using the plugin.   Note that in the case of a
@@ -457,11 +481,12 @@ client_log (CURL * curl, curl_infotype type, char *data, size_t size, void *cls)
  */
 static ssize_t
 http_client_plugin_send (void *cls,
-                  struct Session *s,
-                  const char *msgbuf, size_t msgbuf_size,
-                  unsigned int priority,
-                  struct GNUNET_TIME_Relative to,
-                  GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
+                         struct Session *s,
+                         const char *msgbuf, size_t msgbuf_size,
+                         unsigned int priority,
+                         struct GNUNET_TIME_Relative to,
+                         GNUNET_TRANSPORT_TransmitContinuation cont,
+                         void *cont_cls)
 {
   struct HTTP_Client_Plugin *plugin = cls;
   struct HTTP_Message *msg;
@@ -569,7 +594,8 @@ client_delete_session (struct Session *s)
     GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, pos);
     if (pos->transmit_cont != NULL)
       pos->transmit_cont (pos->transmit_cont_cls, &s->target, GNUNET_SYSERR,
-                          pos->size, pos->pos + pos->overhead);
+                          pos->size, pos->pos + s->overhead);
+    s->overhead = 0;
     GNUNET_free (pos);
   }
 
@@ -655,7 +681,8 @@ client_disconnect (struct Session *s)
     t = msg->next;
     if (NULL != msg->transmit_cont)
       msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_SYSERR,
-                          msg->size, msg->pos + msg->overhead);
+                          msg->size, msg->pos + s->overhead);
+    s->overhead = 0;
     GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, msg);
     GNUNET_free (msg);
     msg = t;
@@ -720,7 +747,13 @@ http_client_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *targ
 
 }
 
-
+/**
+ * Check if a sessions exists for an specific address
+ * 
+ * @param plugin the plugin
+ * @param address the address
+ * @return the session or NULL
+ */
 static struct Session *
 client_lookup_session (struct HTTP_Client_Plugin *plugin,
                        const struct GNUNET_HELLO_Address *address)
@@ -809,7 +842,8 @@ client_send_cb (void *stream, size_t size, size_t nmemb, void *cls)
     GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, msg);
     if (NULL != msg->transmit_cont)
       msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_OK,
-                          msg->size, msg->size + msg->overhead);
+                          msg->size, msg->size + s->overhead);
+    s->overhead = 0;
     GNUNET_free (msg);
   }
 
@@ -985,7 +1019,7 @@ client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 /**
  * Function setting up file descriptors and scheduling task to run
  *
- * @param  plugin plugin as closure
+ * @param plugin the plugin as closure
  * @param now schedule task in 1ms, regardless of what curl may say
  * @return GNUNET_SYSERR for hard failure, GNUNET_OK for ok
  */
@@ -1133,6 +1167,8 @@ client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
             s->put_tmp_disconnecting = GNUNET_NO;
             s->put_tmp_disconnected = GNUNET_YES;
             s->client_put = NULL;
+            s->put.easyhandle = NULL;
+            s->put.s = NULL;
 
             /*
              * Handling a rare case:
@@ -1142,7 +1178,11 @@ client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
             if (GNUNET_YES == s->put_reconnect_required)
             {
                 s->put_reconnect_required = GNUNET_NO;
-                client_connect_put(s);
+                if (GNUNET_SYSERR == client_connect_put(s))
+                {
+                    GNUNET_break (s->client_put == NULL);
+                    GNUNET_break (s->put_tmp_disconnected == GNUNET_NO);
+                }
             }
         }
         if (easy_h == s->client_get)
@@ -1162,6 +1202,8 @@ client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
                 "Session %p/connection %p: GET connection to `%s' ended normal\n",
                 s, msg->easy_handle, GNUNET_i2s (&s->target));
             /* Disconnect other transmission direction and tell transport */
+            s->get.easyhandle = NULL;
+            s->get.s = NULL;
             client_disconnect (s);
         }
       }
@@ -1171,22 +1213,39 @@ client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
   client_schedule (plugin, GNUNET_NO);
 }
 
+
+/**
+ * Connect GET connection for a session
+ * 
+ * @param s the session to connect
+ * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
+ */
 static int
 client_connect_get (struct Session *s)
 {
   CURLMcode mret;
   /* create get connection */
   s->client_get = curl_easy_init ();
+  s->get.s = s;
+  s->get.easyhandle = s->client_get;
 #if VERBOSE_CURL
   curl_easy_setopt (s->client_get, CURLOPT_VERBOSE, 1L);
   curl_easy_setopt (s->client_get, CURLOPT_DEBUGFUNCTION, &client_log);
-  curl_easy_setopt (s->client_get, CURLOPT_DEBUGDATA, s->client_get);
+  curl_easy_setopt (s->client_get, CURLOPT_DEBUGDATA, &s->get);
 #endif
 #if BUILD_HTTPS
   curl_easy_setopt (s->client_get, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
   curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYPEER, 0);
   curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYHOST, 0);
+  curl_easy_setopt (s->client_get, CURLOPT_PROTOCOLS, CURLPROTO_HTTPS);
+  curl_easy_setopt (s->client_get, CURLOPT_REDIR_PROTOCOLS, CURLPROTO_HTTPS);
+#else
+  curl_easy_setopt (s->client_get, CURLOPT_PROTOCOLS, CURLPROTO_HTTP);
+  curl_easy_setopt (s->client_get, CURLOPT_REDIR_PROTOCOLS, CURLPROTO_HTTP);
 #endif
+
+  curl_easy_setopt (s->client_get, CURLOPT_URL, s->url);
+  curl_easy_setopt (s->client_get, CURLOPT_URL, s->url);
   curl_easy_setopt (s->client_get, CURLOPT_URL, s->url);
   //curl_easy_setopt (s->client_get, CURLOPT_HEADERFUNCTION, &curl_get_header_cb);
   //curl_easy_setopt (s->client_get, CURLOPT_WRITEHEADER, ps);
@@ -1204,6 +1263,8 @@ client_connect_get (struct Session *s)
 #if CURL_TCP_NODELAY
   curl_easy_setopt (ps->recv_endpoint, CURLOPT_TCP_NODELAY, 1);
 #endif
+  curl_easy_setopt (s->client_get, CURLOPT_FOLLOWLOCATION, 0);
+
   mret = curl_multi_add_handle (s->plugin->curl_multi_handle, s->client_get);
   if (mret != CURLM_OK)
   {
@@ -1212,6 +1273,8 @@ client_connect_get (struct Session *s)
                        s, curl_multi_strerror (mret));
     curl_easy_cleanup (s->client_get);
     s->client_get = NULL;
+    s->get.s = NULL;
+    s->get.easyhandle = NULL;
     GNUNET_break (0);
     return GNUNET_SYSERR;
   }
@@ -1219,6 +1282,12 @@ client_connect_get (struct Session *s)
   return GNUNET_OK;
 }
 
+/**
+ * Connect a HTTP put connection 
+ *
+ * @param s the session to connect
+ * @return GNUNET_SYSERR for hard failure, GNUNET_OK for ok
+ */
 static int
 client_connect_put (struct Session *s)
 {
@@ -1227,15 +1296,22 @@ client_connect_put (struct Session *s)
   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name,
                        "Session %p : Init PUT handle \n", s);
   s->client_put = curl_easy_init ();
+  s->put.s = s;
+  s->put.easyhandle = s->client_put;
 #if VERBOSE_CURL
   curl_easy_setopt (s->client_put, CURLOPT_VERBOSE, 1L);
   curl_easy_setopt (s->client_put, CURLOPT_DEBUGFUNCTION, &client_log);
-  curl_easy_setopt (s->client_put, CURLOPT_DEBUGDATA, s->client_put);
+  curl_easy_setopt (s->client_put, CURLOPT_DEBUGDATA, &s->put);
 #endif
 #if BUILD_HTTPS
   curl_easy_setopt (s->client_put, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
   curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYPEER, 0);
   curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYHOST, 0);
+  curl_easy_setopt (s->client_get, CURLOPT_PROTOCOLS, CURLPROTO_HTTPS);
+  curl_easy_setopt (s->client_get, CURLOPT_REDIR_PROTOCOLS, CURLPROTO_HTTPS);
+#else
+  curl_easy_setopt (s->client_get, CURLOPT_PROTOCOLS, CURLPROTO_HTTP);
+  curl_easy_setopt (s->client_get, CURLOPT_REDIR_PROTOCOLS, CURLPROTO_HTTP);
 #endif
   curl_easy_setopt (s->client_put, CURLOPT_URL, s->url);
   curl_easy_setopt (s->client_put, CURLOPT_UPLOAD, 1L);
@@ -1263,11 +1339,22 @@ client_connect_put (struct Session *s)
                     s, curl_multi_strerror (mret));
     curl_easy_cleanup (s->client_put);
     s->client_put = NULL;
+    s->put.easyhandle = NULL;
+    s->put.s = NULL;
+    s->put_tmp_disconnected = GNUNET_YES;
     return GNUNET_SYSERR;
   }
+  s->put_tmp_disconnected = GNUNET_NO;
   return GNUNET_OK;
 }
 
+
+/**
+ * Connect both PUT and GET connection for a session
+ * 
+ * @param s the session to connect
+ * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
+ */
 static int
 client_connect (struct Session *s)
 {
@@ -1378,11 +1465,12 @@ http_client_plugin_get_session (void *cls,
       {
           salen = sizeof (struct sockaddr_in);
       }
-      else if (AF_INET == sa->sa_family)
+      else if (AF_INET6 == sa->sa_family)
       {
           salen = sizeof (struct sockaddr_in6);
       }
       ats = plugin->env->get_address_type (plugin->env->cls, sa, salen);
+      //fprintf (stderr, "Address %s is in %s\n", GNUNET_a2s (sa,salen), GNUNET_ATS_print_network_type(ntohl(ats.value)));
       GNUNET_free (sa);
   }
   else if (GNUNET_NO == res)