- minor renamings
[oweals/gnunet.git] / src / hostlist / hostlist-client.c
index 7f285f6cfba3c94921787d08840be9ecdf9849a1..8271ecc0cdc911d51fc437b53471d95255da58e8 100644 (file)
@@ -33,8 +33,7 @@
 #include "gnunet_transport_service.h"
 #include "gnunet-daemon-hostlist.h"
 #include <curl/curl.h>
-#include "gnunet_common.h"
-#include "gnunet_bio_lib.h"
+#include "gnunet_util_lib.h"
 
 
 /**
@@ -298,7 +297,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;
@@ -370,10 +369,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;
   }
 
@@ -391,10 +388,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;
   }
@@ -420,6 +415,7 @@ get_bootstrap_server ()
   return ret;
 }
 
+
 /**
  * Method deciding if a preconfigured or advertisied hostlist is used on a 50:50 ratio
  * @return uri to use, NULL if there is no URL available
@@ -470,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)
 
 
 /**
@@ -483,6 +479,7 @@ save_hostlist_file (int shutdown);
 
 /**
  * add val2 to val1 with overflow check
+ *
  * @param val1 value 1
  * @param val2 value 2
  * @return result
@@ -499,12 +496,13 @@ 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
  * @param val2 value 2
  * @return result
@@ -514,14 +512,15 @@ 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
- * @return GNUNET_YES if existing in linked list, GNUNET_NO if not
+ * @return #GNUNET_YES if existing in linked list, #GNUNET_NO if not
  */
 static int
 linked_list_contains (const char *uri)
@@ -647,6 +646,7 @@ update_hostlist ()
     stat_use_bootstrap = GNUNET_YES;
 }
 
+
 /**
  * Clean up the state from the task that downloaded the
  * hostlist and schedule the next task.
@@ -796,7 +796,7 @@ task_download (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
     clean_up ();
     return;
   }
-  if (GNUNET_TIME_absolute_get_remaining (end_time).rel_value == 0)
+  if (0 == GNUNET_TIME_absolute_get_remaining (end_time).rel_value_us)
   {
     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                 _("Timeout trying to download hostlist from `%s'\n"),
@@ -832,9 +832,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
           {
@@ -927,6 +927,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);
@@ -998,6 +1000,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
@@ -1023,29 +1026,29 @@ task_check (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
         GNUNET_SCHEDULER_add_now (&task_download_dispatcher, NULL);
 
   delay = hostlist_delay;
-  if (hostlist_delay.rel_value == 0)
+  if (0 == hostlist_delay.rel_value_us)
     hostlist_delay = GNUNET_TIME_UNIT_SECONDS;
   else
     hostlist_delay = GNUNET_TIME_relative_multiply (hostlist_delay, 2);
-  if (hostlist_delay.rel_value >
-      GNUNET_TIME_UNIT_HOURS.rel_value * (1 + stat_connection_count))
+  if (hostlist_delay.rel_value_us >
+      GNUNET_TIME_UNIT_HOURS.rel_value_us * (1 + stat_connection_count))
     hostlist_delay =
         GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS,
                                        (1 + stat_connection_count));
   GNUNET_STATISTICS_set (stats,
                          gettext_noop
                          ("# milliseconds between hostlist downloads"),
-                         hostlist_delay.rel_value, GNUNET_YES);
+                         hostlist_delay.rel_value_us / 1000LL,
+                        GNUNET_YES);
   if (0 == once)
   {
     delay = GNUNET_TIME_UNIT_ZERO;
     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);
 }
 
@@ -1081,12 +1084,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);
@@ -1098,13 +1100,9 @@ task_hostlist_saving (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  *
  * @param cls closure
  * @param peer peer identity this notification is about
- * @param atsi performance data
- * @param atsi_count number of records in 'atsi'
  */
 static void
-handler_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
-                 const struct GNUNET_ATS_Information *atsi,
-                 unsigned int atsi_count)
+handler_connect (void *cls, const struct GNUNET_PeerIdentity *peer)
 {
   GNUNET_assert (stat_connection_count < UINT_MAX);
   stat_connection_count++;
@@ -1135,16 +1133,12 @@ handler_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
  * @param cls closure (always NULL)
  * @param peer the peer sending the message
  * @param message the actual message
- * @param atsi performance data
- * @param atsi_count number of records in 'atsi'
- * @return GNUNET_OK to keep the connection open,
- *         GNUNET_SYSERR to close it (signal serious error)
+ * @return #GNUNET_OK to keep the connection open,
+ *         #GNUNET_SYSERR to close it (signal serious error)
  */
 static int
 handler_advertisement (void *cls, const struct GNUNET_PeerIdentity *peer,
-                       const struct GNUNET_MessageHeader *message,
-                       const struct GNUNET_ATS_Information *atsi,
-                       unsigned int atsi_count)
+                       const struct GNUNET_MessageHeader *message)
 {
   size_t size;
   size_t uri_size;
@@ -1194,7 +1188,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;
 
@@ -1205,8 +1198,9 @@ handler_advertisement (void *cls, const struct GNUNET_PeerIdentity *peer,
                                     &task_testing_intervall_reset, NULL);
 
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-              "Testing new hostlist advertisements is locked for the next %u ms\n",
-              TESTING_INTERVAL.rel_value);
+              "Testing new hostlist advertisements is locked for the next %s\n",
+              GNUNET_STRINGS_relative_time_to_string (TESTING_INTERVAL,
+                                                     GNUNET_YES));
 
   ti_download_dispatcher_task =
       GNUNET_SCHEDULER_add_now (&task_download_dispatcher, NULL);
@@ -1215,14 +1209,13 @@ handler_advertisement (void *cls, const struct GNUNET_PeerIdentity *peer,
 }
 
 
-
 /**
  * Continuation called by the statistics code once
  * we go the stat.  Initiates hostlist download scheduling.
  *
  * @param cls closure
- * @param success GNUNET_OK if statistics were
- *        successfully obtained, GNUNET_SYSERR if not.
+ * @param success #GNUNET_OK if statistics were
+ *        successfully obtained, #GNUNET_SYSERR if not.
  */
 static void
 primary_task (void *cls, int success)
@@ -1235,17 +1228,27 @@ primary_task (void *cls, int success)
 }
 
 
+/**
+ * We've received the previous delay value from statistics.  Remember it.
+ *
+ * @param cls NULL, unused
+ * @param subsystem should be "hostlist", unused
+ * @param name will be "milliseconds between hostlist downloads", unused
+ * @param value previous delay value, in milliseconds (!)
+ * @param is_persistent unused, will be GNUNET_YES
+ */
 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;
+  hostlist_delay.rel_value_us = value * 1000LL;
+  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
  */
@@ -1256,8 +1259,6 @@ load_hostlist_file ()
   char *uri;
   char *emsg;
   struct Hostlist *hostlist;
-
-  uri = NULL;
   uint32_t times_used;
   uint32_t hellos_returned;
   uint64_t quality;
@@ -1265,23 +1266,23 @@ load_hostlist_file ()
   uint64_t created;
   uint32_t counter;
 
+  uri = NULL;
   if (GNUNET_OK !=
       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;
   }
 
   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-              _("Loading saved hostlist entries from file `%s' \n"), filename);
+              _("Loading saved hostlist entries from file `%s' \n"),
+             filename);
   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;
   }
@@ -1311,8 +1312,8 @@ load_hostlist_file ()
     hostlist->hostlist_uri = (const char *) &hostlist[1];
     memcpy (&hostlist[1], uri, strlen (uri) + 1);
     hostlist->quality = quality;
-    hostlist->time_creation.abs_value = created;
-    hostlist->time_last_usage.abs_value = last_used;
+    hostlist->time_creation.abs_value_us = created;
+    hostlist->time_last_usage.abs_value_us = last_used;
     GNUNET_CONTAINER_DLL_insert (linked_list_head, linked_list_tail, hostlist);
     linked_list_size++;
     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
@@ -1334,7 +1335,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);
@@ -1358,10 +1359,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))
@@ -1397,9 +1396,9 @@ save_hostlist_file (int shutdown)
           (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pos->times_used)) ||
           (GNUNET_OK != GNUNET_BIO_write_int64 (wh, pos->quality)) ||
           (GNUNET_OK !=
-           GNUNET_BIO_write_int64 (wh, pos->time_last_usage.abs_value)) ||
+           GNUNET_BIO_write_int64 (wh, pos->time_last_usage.abs_value_us)) ||
           (GNUNET_OK !=
-           GNUNET_BIO_write_int64 (wh, pos->time_creation.abs_value)) ||
+           GNUNET_BIO_write_int64 (wh, pos->time_creation.abs_value_us)) ||
           (GNUNET_OK != GNUNET_BIO_write_int32 (wh, pos->hello_count)))
       {
         GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
@@ -1424,6 +1423,7 @@ save_hostlist_file (int shutdown)
   GNUNET_free (filename);
 }
 
+
 /**
  * Start downloading hostlists from hostlist servers as necessary.
  */
@@ -1470,9 +1470,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);