docu
[oweals/gnunet.git] / src / hostlist / hostlist-client.c
index 5d3f037b31556fb6e522ae9f86af73ce41c5dcce..4ec76ec9fe72338965ef952f79d606c2823bbeab 100644 (file)
@@ -36,8 +36,6 @@
 #include "gnunet_common.h"
 #include "gnunet_bio_lib.h"
 
-#define DEBUG_HOSTLIST_CLIENT GNUNET_EXTRA_LOGGING
-
 
 /**
  * Number of connections that we must have to NOT download
@@ -208,6 +206,11 @@ static unsigned int linked_list_size;
  */
 static struct Hostlist *hostlist_to_test;
 
+/**
+ * Handle for our statistics GET operation.
+ */
+static struct GNUNET_STATISTICS_GetHandle *sget;
+
 /**
  * Set to GNUNET_YES if the current URL had some problems.
  */
@@ -295,7 +298,7 @@ callback_download (void *ptr, size_t size, size_t nmemb, void *ctx)
     left -= cpy;
     if (download_pos < sizeof (struct GNUNET_MessageHeader))
     {
-      GNUNET_assert (left == 0);
+      GNUNET_assert (0 == left);
       break;
     }
     msg = (const struct GNUNET_MessageHeader *) download_buffer;
@@ -320,11 +323,9 @@ callback_download (void *ptr, size_t size, size_t nmemb, void *ctx)
     }
     if (GNUNET_HELLO_size ((const struct GNUNET_HELLO_Message *) msg) == msize)
     {
-#if DEBUG_HOSTLIST_CLIENT
       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                   "Received valid `%s' message from hostlist server.\n",
                   "HELLO");
-#endif
       GNUNET_STATISTICS_update (stats,
                                 gettext_noop
                                 ("# valid HELLOs downloaded from hostlist servers"),
@@ -369,10 +370,8 @@ get_bootstrap_server ()
       GNUNET_CONFIGURATION_get_value_string (cfg, "HOSTLIST", "SERVERS",
                                              &servers))
   {
-    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                _
-                ("No `%s' specified in `%s' configuration, will not bootstrap.\n"),
-                "SERVERS", "HOSTLIST");
+    GNUNET_log_config_missing (GNUNET_ERROR_TYPE_WARNING,
+                              "hostlist", "SERVERS");
     return NULL;
   }
 
@@ -390,10 +389,8 @@ get_bootstrap_server ()
   }
   if (urls == 0)
   {
-    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                _
-                ("No `%s' specified in `%s' configuration, will not bootstrap.\n"),
-                "SERVERS", "HOSTLIST");
+    GNUNET_log_config_missing (GNUNET_ERROR_TYPE_WARNING,
+                              "hostlist", "SERVERS");
     GNUNET_free (servers);
     return NULL;
   }
@@ -469,7 +466,7 @@ download_get_url ()
 }
 
 
-#define CURL_EASY_SETOPT(c, a, b) do { ret = curl_easy_setopt(c, a, b); if (ret != CURLE_OK) GNUNET_log(GNUNET_ERROR_TYPE_WARNING, _("%s failed at %s:%d: `%s'\n"), "curl_easy_setopt", __FILE__, __LINE__, curl_easy_strerror(ret)); } while (0)
+#define CURL_EASY_SETOPT(c, a, b) do { ret = curl_easy_setopt (c, a, b); if (CURLE_OK != ret) GNUNET_log(GNUNET_ERROR_TYPE_WARNING, _("%s failed at %s:%d: `%s'\n"), "curl_easy_setopt", __FILE__, __LINE__, curl_easy_strerror (ret)); } while (0)
 
 
 /**
@@ -498,10 +495,10 @@ checked_add (uint64_t val1, uint64_t val2)
   temp = val1 + val2;
   if (temp < val1)
     return maxv;
-  else
-    return temp;
+  return temp;
 }
 
+
 /**
  * Subtract val2 from val1 with underflow check
  * @param val1 value 1
@@ -513,10 +510,10 @@ checked_sub (uint64_t val1, uint64_t val2)
 {
   if (val1 <= val2)
     return 0;
-  else
-    return (val1 - val2);
+  return (val1 - val2);
 }
 
+
 /**
  * Method to check if  a URI is in hostlist linked list
  * @param uri uri to check
@@ -646,6 +643,7 @@ update_hostlist ()
     stat_use_bootstrap = GNUNET_YES;
 }
 
+
 /**
  * Clean up the state from the task that downloaded the
  * hostlist and schedule the next task.
@@ -760,10 +758,8 @@ download_prepare ()
   gws = GNUNET_NETWORK_fdset_create ();
   GNUNET_NETWORK_fdset_copy_native (grs, &rs, max + 1);
   GNUNET_NETWORK_fdset_copy_native (gws, &ws, max + 1);
-#if DEBUG_HOSTLIST_CLIENT
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
               "Scheduling task for hostlist download using cURL\n");
-#endif
   ti_download =
       GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
                                    rtime, grs, gws,
@@ -790,11 +786,9 @@ task_download (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
   ti_download = GNUNET_SCHEDULER_NO_TASK;
   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
   {
-#if DEBUG_HOSTLIST_CLIENT
     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                 "Shutdown requested while trying to download hostlist from `%s'\n",
                 current_url);
-#endif
     update_hostlist ();
     clean_up ();
     return;
@@ -808,11 +802,8 @@ task_download (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
     clean_up ();
     return;
   }
-#if DEBUG_HOSTLIST_CLIENT
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
               "Ready for processing hostlist client request\n");
-#endif
-
   do
   {
     running = 0;
@@ -838,9 +829,9 @@ task_download (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
         case CURLMSG_DONE:
           if ((msg->data.result != CURLE_OK) &&
               (msg->data.result != CURLE_GOT_NOTHING))
-            GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-                        _("%s failed for `%s' at %s:%d: `%s'\n"),
-                        "curl_multi_perform", current_url, __FILE__, __LINE__,
+            GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+                        _("Download of hostlist from `%s' failed: `%s'\n"),
+                        current_url,
                         curl_easy_strerror (msg->data.result));
           else
           {
@@ -933,6 +924,8 @@ download_hostlist ()
     return;
   }
   CURL_EASY_SETOPT (curl, CURLOPT_FOLLOWLOCATION, 1);
+  CURL_EASY_SETOPT (curl, CURLOPT_REDIR_PROTOCOLS, CURLPROTO_HTTP | CURLPROTO_HTTPS);
+  CURL_EASY_SETOPT (curl, CURLOPT_PROTOCOLS, CURLPROTO_HTTP | CURLPROTO_HTTPS);
   CURL_EASY_SETOPT (curl, CURLOPT_MAXREDIRS, 4);
   /* no need to abort if the above failed */
   CURL_EASY_SETOPT (curl, CURLOPT_URL, current_url);
@@ -1004,6 +997,7 @@ task_download_dispatcher (void *cls,
   }
 }
 
+
 /**
  * Task that checks if we should try to download a hostlist.
  * If so, we initiate the download, otherwise we schedule
@@ -1018,18 +1012,16 @@ task_check (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
   ti_check_download = GNUNET_SCHEDULER_NO_TASK;
   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
     return;
-
-  if (stat_connection_count < MIN_CONNECTIONS)
-  {
-    ti_download_dispatcher_task =
-        GNUNET_SCHEDULER_add_now (&task_download_dispatcher, NULL);
-  }
-
   if (stats == NULL)
   {
     curl_global_cleanup ();
     return;                     /* in shutdown */
   }
+  if ( (stat_connection_count < MIN_CONNECTIONS) &&
+       (GNUNET_SCHEDULER_NO_TASK == ti_download_dispatcher_task) )
+    ti_download_dispatcher_task =
+        GNUNET_SCHEDULER_add_now (&task_download_dispatcher, NULL);
+
   delay = hostlist_delay;
   if (hostlist_delay.rel_value == 0)
     hostlist_delay = GNUNET_TIME_UNIT_SECONDS;
@@ -1050,10 +1042,9 @@ task_check (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
     once = 1;
   }
   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-              _
-              ("Have %u/%u connections.  Will consider downloading hostlist in %llums\n"),
+              _("Have %u/%u connections.  Will consider downloading hostlist in %s\n"),
               stat_connection_count, MIN_CONNECTIONS,
-              (unsigned long long) delay.rel_value);
+              GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
   ti_check_download = GNUNET_SCHEDULER_add_delayed (delay, &task_check, NULL);
 }
 
@@ -1089,12 +1080,11 @@ task_hostlist_saving (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
   ti_saving_task = GNUNET_SCHEDULER_NO_TASK;
   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
     return;
-  GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Scheduled saving of hostlists\n"));
   save_hostlist_file (GNUNET_NO);
 
-  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-              _("Hostlists will be saved to file again in %llums\n"),
-              (unsigned long long) SAVING_INTERVALL.rel_value);
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "Hostlists will be saved to file again in %s\n",
+             GNUNET_STRINGS_relative_time_to_string(SAVING_INTERVALL, GNUNET_YES));
   ti_saving_task =
       GNUNET_SCHEDULER_add_delayed (SAVING_INTERVALL, &task_hostlist_saving,
                                     NULL);
@@ -1202,7 +1192,6 @@ handler_advertisement (void *cls, const struct GNUNET_PeerIdentity *peer,
   hostlist->hostlist_uri = (const char *) &hostlist[1];
   memcpy (&hostlist[1], uri, uri_size);
   hostlist->time_creation = GNUNET_TIME_absolute_get ();
-  hostlist->time_last_usage = GNUNET_TIME_absolute_get_zero ();
   hostlist->quality = HOSTLIST_INITIAL;
   hostlist_to_test = hostlist;
 
@@ -1223,7 +1212,6 @@ handler_advertisement (void *cls, const struct GNUNET_PeerIdentity *peer,
 }
 
 
-
 /**
  * Continuation called by the statistics code once
  * we go the stat.  Initiates hostlist download scheduling.
@@ -1235,12 +1223,10 @@ handler_advertisement (void *cls, const struct GNUNET_PeerIdentity *peer,
 static void
 primary_task (void *cls, int success)
 {
-  if (stats == NULL)
-    return;                     /* in shutdown */
-#if DEBUG_HOSTLIST_CLIENT
+  sget = NULL;
+  GNUNET_assert (stats != NULL);
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
               "Statistics request done, scheduling hostlist download\n");
-#endif
   ti_check_download = GNUNET_SCHEDULER_add_now (&task_check, NULL);
 }
 
@@ -1249,13 +1235,14 @@ static int
 process_stat (void *cls, const char *subsystem, const char *name,
               uint64_t value, int is_persistent)
 {
-  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-              _("Initial time between hostlist downloads is %llums\n"),
-              (unsigned long long) value);
   hostlist_delay.rel_value = value;
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "Initial time between hostlist downloads is %s\n",
+              GNUNET_STRINGS_relative_time_to_string (hostlist_delay, GNUNET_YES));
   return GNUNET_OK;
 }
 
+
 /**
  * Method to load persistent hostlist file during hostlist client startup
  */
@@ -1279,10 +1266,8 @@ load_hostlist_file ()
       GNUNET_CONFIGURATION_get_value_filename (cfg, "HOSTLIST", "HOSTLISTFILE",
                                                &filename))
   {
-    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                _
-                ("No `%s' specified in `%s' configuration, cannot load hostlists from file.\n"),
-                "HOSTLISTFILE", "HOSTLIST");
+    GNUNET_log_config_missing (GNUNET_ERROR_TYPE_WARNING,
+                              "hostlist", "HOSTLISTFILE");
     return;
   }
 
@@ -1291,7 +1276,7 @@ load_hostlist_file ()
   if (GNUNET_NO == GNUNET_DISK_file_test (filename))
   {
     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-                _("Hostlist file `%s' is not existing\n"), filename);
+                _("Hostlist file `%s' does not exist\n"), filename);
     GNUNET_free (filename);
     return;
   }
@@ -1344,7 +1329,7 @@ load_hostlist_file ()
 
   GNUNET_free_non_null (uri);
   emsg = NULL;
-  GNUNET_BIO_read_close (rh, &emsg);
+  (void) GNUNET_BIO_read_close (rh, &emsg);
   if (emsg != NULL)
     GNUNET_free (emsg);
   GNUNET_free (filename);
@@ -1368,10 +1353,8 @@ save_hostlist_file (int shutdown)
       GNUNET_CONFIGURATION_get_value_filename (cfg, "HOSTLIST", "HOSTLISTFILE",
                                                &filename))
   {
-    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                _
-                ("No `%s' specified in `%s' configuration, cannot save hostlists to file.\n"),
-                "HOSTLISTFILE", "HOSTLIST");
+    GNUNET_log_config_missing (GNUNET_ERROR_TYPE_WARNING,
+                              "hostlist", "HOSTLISTFILE");
     return;
   }
   if (GNUNET_SYSERR == GNUNET_DISK_directory_create_for_file (filename))
@@ -1434,6 +1417,7 @@ save_hostlist_file (int shutdown)
   GNUNET_free (filename);
 }
 
+
 /**
  * Start downloading hostlists from hostlist servers as necessary.
  */
@@ -1447,6 +1431,7 @@ GNUNET_HOSTLIST_client_start (const struct GNUNET_CONFIGURATION_Handle *c,
   char *filename;
   int result;
 
+  GNUNET_assert (NULL != st);
   if (0 != curl_global_init (CURL_GLOBAL_WIN32))
   {
     GNUNET_break (0);
@@ -1479,9 +1464,9 @@ GNUNET_HOSTLIST_client_start (const struct GNUNET_CONFIGURATION_Handle *c,
     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
                 _("Learning is enabled on this peer\n"));
     load_hostlist_file ();
-    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-                _("Hostlists will be saved to file again in  %llums\n"),
-                (unsigned long long) SAVING_INTERVALL.rel_value);
+    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+                "Hostlists will be saved to file again in %s\n",
+               GNUNET_STRINGS_relative_time_to_string (SAVING_INTERVALL, GNUNET_YES));
     ti_saving_task =
         GNUNET_SCHEDULER_add_delayed (SAVING_INTERVALL, &task_hostlist_saving,
                                       NULL);
@@ -1510,11 +1495,11 @@ GNUNET_HOSTLIST_client_start (const struct GNUNET_CONFIGURATION_Handle *c,
     }
     GNUNET_free (filename);
   }
-  GNUNET_STATISTICS_get (stats, "hostlist",
-                         gettext_noop
-                         ("# milliseconds between hostlist downloads"),
-                         GNUNET_TIME_UNIT_MINUTES, &primary_task, &process_stat,
-                         NULL);
+  sget = GNUNET_STATISTICS_get (stats, "hostlist",
+                               gettext_noop
+                               ("# milliseconds between hostlist downloads"),
+                               GNUNET_TIME_UNIT_MINUTES, &primary_task, &process_stat,
+                               NULL);
   return GNUNET_OK;
 }
 
@@ -1526,32 +1511,39 @@ void
 GNUNET_HOSTLIST_client_stop ()
 {
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Hostlist client shutdown\n");
-#if DEBUG_HOSTLIST_CLIENT
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Hostlist client shutdown\n");
-#endif
+  if (NULL != sget)
+  {
+    GNUNET_STATISTICS_get_cancel (sget);
+    sget = NULL;
+  }
+  stats = NULL;
   if (GNUNET_YES == stat_learning)
     save_hostlist_file (GNUNET_YES);
-
   if (ti_saving_task != GNUNET_SCHEDULER_NO_TASK)
   {
     GNUNET_SCHEDULER_cancel (ti_saving_task);
+    ti_saving_task = GNUNET_SCHEDULER_NO_TASK;
   }
 
   if (ti_download_dispatcher_task != GNUNET_SCHEDULER_NO_TASK)
-  {
+    {
     GNUNET_SCHEDULER_cancel (ti_download_dispatcher_task);
+    ti_download_dispatcher_task = GNUNET_SCHEDULER_NO_TASK;
   }
   if (ti_testing_intervall_task != GNUNET_SCHEDULER_NO_TASK)
   {
     GNUNET_SCHEDULER_cancel (ti_testing_intervall_task);
+    ti_testing_intervall_task = GNUNET_SCHEDULER_NO_TASK;
   }
   if (ti_download != GNUNET_SCHEDULER_NO_TASK)
   {
     GNUNET_SCHEDULER_cancel (ti_download);
+    ti_download = GNUNET_SCHEDULER_NO_TASK;
   }
   if (ti_check_download != GNUNET_SCHEDULER_NO_TASK)
   {
     GNUNET_SCHEDULER_cancel (ti_check_download);
+    ti_check_download = GNUNET_SCHEDULER_NO_TASK;
     curl_global_cleanup ();
   }
   if (transport != NULL)
@@ -1559,7 +1551,6 @@ GNUNET_HOSTLIST_client_stop ()
     GNUNET_TRANSPORT_disconnect (transport);
     transport = NULL;
   }
-  GNUNET_assert (NULL == transport);
   GNUNET_free_non_null (proxy);
   proxy = NULL;
   cfg = NULL;