more information why nat tests fail
[oweals/gnunet.git] / src / peerinfo / gnunet-service-peerinfo.c
index 2f1e7a3d9c23a5b50495a37ab744568ed9be18e3..486cb24ba24aa72166ce0dceed5b959761e71fdb 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2001, 2002, 2004, 2005, 2007, 2009, 2010, 2012 Christian Grothoff (and other contributing authors)
+     (C) 2001-2014 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -26,9 +26,6 @@
  * structure of data/hosts/).
  *
  * @author Christian Grothoff
- *
- * TODO:
- * - notify clients when addresses in HELLO expire (#1933)
  */
 
 #include "platform.h"
@@ -83,11 +80,12 @@ struct TransmitContext
   struct GNUNET_SERVER_TransmitContext *tc;
 
   /**
-   * Include friend only HELLOs GNUNET_YES or _NO
+   * Include friend only HELLOs #GNUNET_YES or #GNUNET_NO
    */
   int friend_only;
 };
 
+
 /**
  * Result of reading a file
  */
@@ -110,25 +108,25 @@ struct ReadHostFileContext
  */
 struct NotificationContext
 {
-       /**
-        * Next in DLL
-        */
-       struct NotificationContext *prev;
-
-       /**
-        * Previous in DLL
-        */
-       struct NotificationContext *next;
-
-       /**
-        * Server client
-        */
-       struct GNUNET_SERVER_Client *client;
-
-       /**
-        * Interested in friend only HELLO?
-        */
-       int include_friend_only;
+  /**
+   * Next in DLL
+   */
+  struct NotificationContext *prev;
+
+  /**
+   * Previous in DLL
+   */
+  struct NotificationContext *next;
+
+  /**
+   * Server client
+   */
+  struct GNUNET_SERVER_Client *client;
+
+  /**
+   * Interested in friend only HELLO?
+   */
+  int include_friend_only;
 };
 
 
@@ -173,7 +171,8 @@ static struct NotificationContext *nc_tail;
  * @return generated notification message
  */
 static struct InfoMessage *
-make_info_message (const struct HostEntry *he, int include_friend_only)
+make_info_message (const struct HostEntry *he,
+                   int include_friend_only)
 {
   struct InfoMessage *im;
   struct GNUNET_HELLO_Message *src;
@@ -201,10 +200,11 @@ make_info_message (const struct HostEntry *he, int include_friend_only)
  * @param cls pointer to the current time
  * @param address the address
  * @param expiration expiration time for the address
- * @return GNUNET_NO if expiration smaller than the current time
+ * @return #GNUNET_NO if expiration smaller than the current time
  */
 static int
-discard_expired (void *cls, const struct GNUNET_HELLO_Address *address,
+discard_expired (void *cls,
+                 const struct GNUNET_HELLO_Address *address,
                  struct GNUNET_TIME_Absolute expiration)
 {
   const struct GNUNET_TIME_Absolute *now = cls;
@@ -226,10 +226,11 @@ discard_expired (void *cls, const struct GNUNET_HELLO_Address *address,
  * @param cls pointer to the counter
  * @param address the address
  * @param expiration expiration time for the address
- * @return GNUNET_OK (always)
+ * @return #GNUNET_OK (always)
  */
 static int
-count_addresses (void *cls, const struct GNUNET_HELLO_Address *address,
+count_addresses (void *cls,
+                 const struct GNUNET_HELLO_Address *address,
                  struct GNUNET_TIME_Absolute expiration)
 {
   unsigned int *cnt = cls;
@@ -312,25 +313,24 @@ update_hello (const struct GNUNET_PeerIdentity *peer,
 
 /**
  * Try to read the HELLOs in the given filename and discard expired
- * addresses.  Removes the file if one the HELLO is mal-formed.  If all
+ * addresses.  Removes the file if one the HELLO is malformed.  If all
  * addresses are expired, the HELLO is also removed (but the HELLO
  * with the public key is still returned if it was found and valid).
- *
- * The file can contain multiple HELLO messages, but onlu a public and a friend only
- * HELLO should be included
+ * The file can contain multiple HELLO messages.
  *
  * @param fn name of the file
- * @param unlink_garbage if GNUNET_YES, try to remove useless files
+ * @param unlink_garbage if #GNUNET_YES, try to remove useless files
  * @param r ReadHostFileContext to store the resutl
  */
 static void
-read_host_file (const char *fn, int unlink_garbage, struct ReadHostFileContext *r)
+read_host_file (const char *fn,
+                int unlink_garbage,
+                struct ReadHostFileContext *r)
 {
   char buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1] GNUNET_ALIGN;
   unsigned int size_total;
   struct GNUNET_TIME_Absolute now;
   unsigned int left;
-
   const struct GNUNET_HELLO_Message *hello;
   struct GNUNET_HELLO_Message *hello_clean;
   unsigned read_pos;
@@ -340,12 +340,12 @@ read_host_file (const char *fn, int unlink_garbage, struct ReadHostFileContext *
   r->hello = NULL;
 
   if (GNUNET_YES != GNUNET_DISK_file_test (fn))
-  {
     return;
-  }
-
   size_total = GNUNET_DISK_fn_read (fn, buffer, sizeof (buffer));
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Read %u bytes from `%s'\n", size_total, fn);
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "Read %u bytes from `%s'\n",
+              size_total,
+              fn);
   if (size_total < sizeof (struct GNUNET_MessageHeader))
   {
     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
@@ -354,7 +354,9 @@ read_host_file (const char *fn, int unlink_garbage, struct ReadHostFileContext *
     if ( (GNUNET_YES == unlink_garbage) &&
         (0 != UNLINK (fn)) &&
         (ENOENT != errno) )
-      GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
+      GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
+                                "unlink",
+                                fn);
     return;
   }
 
@@ -366,18 +368,33 @@ read_host_file (const char *fn, int unlink_garbage, struct ReadHostFileContext *
     if (0 == size_hello)
       {
        GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-                   _("Failed to parse HELLO in file `%s': %s %u \n"),
-                   fn, "HELLO is invalid and has size of ", size_hello);
+                   _("Failed to parse HELLO in file `%s'\n"),
+                   fn);
        if ((GNUNET_YES == unlink_garbage) &&
            (0 != UNLINK (fn)) &&
            (ENOENT != errno) )
-         GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
+         GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
+                                    "unlink",
+                                    fn);
        return;
       }
 
     now = GNUNET_TIME_absolute_get ();
     hello_clean = GNUNET_HELLO_iterate_addresses (hello, GNUNET_YES,
                                                  &discard_expired, &now);
+    if (NULL == hello_clean)
+    {
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Failed to parse HELLO in file `%s'\n"),
+                  fn);
+      if ((GNUNET_YES == unlink_garbage) &&
+          (0 != UNLINK (fn)) &&
+          (ENOENT != errno) )
+        GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
+                                  "unlink",
+                                  fn);
+      return;
+    }
     left = 0;
     (void) GNUNET_HELLO_iterate_addresses (hello_clean, GNUNET_NO,
                                           &count_addresses, &left);
@@ -416,13 +433,15 @@ read_host_file (const char *fn, int unlink_garbage, struct ReadHostFileContext *
   if (0 == left)
   {
     /* no addresses left, remove from disk */
-    if ((GNUNET_YES == unlink_garbage) && (0 != UNLINK (fn)))
-      GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
+    if ( (GNUNET_YES == unlink_garbage) &&
+         (0 != UNLINK (fn)) )
+      GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
+                                "unlink",
+                                fn);
   }
-
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Found `%s' and `%s' HELLO message in file\n",
-             (NULL != r->hello) ? "public" : "NO public",
+             (NULL != r->hello) ? "public" : "NON-public",
              (NULL != r->friend_only_hello) ? "friend only" : "NO friend only");
 }
 
@@ -495,8 +514,8 @@ remove_garbage (const char *fullname)
 struct DirScanContext
 {
   /**
-   * GNUNET_YES if we should remove files that are broken,
-   * GNUNET_NO if the directory we are iterating over should
+   * #GNUNET_YES if we should remove files that are broken,
+   * #GNUNET_NO if the directory we are iterating over should
    * be treated as read-only by us.
    */
   int remove_files;
@@ -534,18 +553,13 @@ hosts_directory_scan_callback (void *cls, const char *fullname)
 
   filename = strrchr (fullname, DIR_SEPARATOR);
   if ((NULL == filename) || (1 > strlen (filename)))
-       filename = fullname;
+    filename = fullname;
   else
     filename ++;
 
   read_host_file (fullname, dsc->remove_files, &r);
   if ( (NULL == r.hello) && (NULL == r.friend_only_hello))
-  {
-    if (GNUNET_YES == dsc->remove_files)
-      remove_garbage (fullname);
     return GNUNET_OK;
-  }
-
   if (NULL != r.friend_only_hello)
   {
     if (GNUNET_OK != GNUNET_HELLO_get_id (r.friend_only_hello, &id_friend))
@@ -829,7 +843,7 @@ update_hello (const struct GNUNET_PeerIdentity *peer,
  * @param cls NULL to hit all hosts, otherwise specifies a particular target
  * @param key hostID
  * @param value information to transmit
- * @return GNUNET_YES (continue to iterate)
+ * @return #GNUNET_YES (continue to iterate)
  */
 static int
 add_to_tc (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
@@ -886,7 +900,7 @@ add_to_tc (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
  *
  * @param cls pointer to current time (struct GNUNET_TIME_Absolute)
  * @param fn filename to test to see if the HELLO expired
- * @return GNUNET_OK (continue iteration)
+ * @return #GNUNET_OK (continue iteration)
  */
 static int
 discard_hosts_helper (void *cls, const char *fn)
@@ -1057,6 +1071,7 @@ handle_get_all (void *cls, struct GNUNET_SERVER_Client *client,
   lapm = (const struct ListAllPeersMessage *) message;
   tcx.friend_only = ntohl (lapm->include_friend_only);
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "`%s' message received\n", "GET_ALL");
+  GNUNET_SERVER_disable_receive_done_warning (client);
   tcx.tc = GNUNET_SERVER_transmit_context_create (client);
   GNUNET_CONTAINER_multipeermap_iterate (hostmap, &add_to_tc, &tcx);
   GNUNET_SERVER_transmit_context_append_data (tcx.tc, NULL, 0,
@@ -1070,10 +1085,10 @@ handle_get_all (void *cls, struct GNUNET_SERVER_Client *client,
  * Pass the given client the information we have in the respective
  * host entry; the client is already in the notification context.
  *
- * @param cls the 'struct GNUNET_SERVER_Client' to notify
+ * @param cls the `struct GNUNET_SERVER_Client` to notify
  * @param key key for the value (unused)
- * @param value the 'struct HostEntry' to notify the client about
- * @return GNUNET_YES (always, continue to iterate)
+ * @param value the `struct HostEntry` to notify the client about
+ * @return #GNUNET_YES (always, continue to iterate)
  */
 static int
 do_notify_entry (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
@@ -1122,7 +1137,7 @@ handle_notify (void *cls, struct GNUNET_SERVER_Client *client,
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "`%s' message received\n",
              "NOTIFY");
-  nc = GNUNET_malloc (sizeof (struct NotificationContext));
+  nc = GNUNET_new (struct NotificationContext);
   nc->client = client;
   nc->include_friend_only = ntohl (nm->include_friend_only);
 
@@ -1160,11 +1175,13 @@ disconnect_cb (void *cls,struct GNUNET_SERVER_Client *client)
  *
  * @param cls NULL
  * @param key key of the host entry
- * @param value the 'struct HostEntry' to free
- * @return GNUNET_YES (continue to iterate)
+ * @param value the `struct HostEntry` to free
+ * @return #GNUNET_YES (continue to iterate)
  */
 static int
-free_host_entry (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
+free_host_entry (void *cls,
+                 const struct GNUNET_PeerIdentity *key,
+                 void *value)
 {
   struct HostEntry *he = value;
 
@@ -1182,7 +1199,8 @@ free_host_entry (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
  * @param tc scheduler task context, unused
  */
 static void
-shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+shutdown_task (void *cls,
+               const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct NotificationContext *cur;
   struct NotificationContext *next;
@@ -1238,6 +1256,8 @@ run (void *cls, struct GNUNET_SERVER_Handle *server,
   notify_list = GNUNET_SERVER_notification_context_create (server, 0);
   noio = GNUNET_CONFIGURATION_get_value_yesno (cfg, "peerinfo", "NO_IO");
   use_included = GNUNET_CONFIGURATION_get_value_yesno (cfg, "peerinfo", "USE_INCLUDED_HELLOS");
+  if (GNUNET_SYSERR == use_included)
+    use_included = GNUNET_NO;
   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
                                 NULL);
   if (GNUNET_YES != noio)
@@ -1260,22 +1280,22 @@ run (void *cls, struct GNUNET_SERVER_Handle *server,
                                        &cron_clean_data_hosts, NULL);
     if (GNUNET_YES == use_included)
     {
-       ip = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_DATADIR);
-       GNUNET_asprintf (&peerdir,
-                    "%shellos",
-                    ip);
-       GNUNET_free (ip);
-
-                       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-                       _("Importing HELLOs from `%s'\n"),
-                       peerdir);
-                       dsc.matched = 0;
-                       dsc.remove_files = GNUNET_NO;
-
-                       GNUNET_DISK_directory_scan (peerdir,
-                                       &hosts_directory_scan_callback, &dsc);
-
-                       GNUNET_free (peerdir);
+      ip = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_DATADIR);
+      GNUNET_asprintf (&peerdir, "%shellos", ip);
+      GNUNET_free(ip);
+
+      GNUNET_log(GNUNET_ERROR_TYPE_INFO, _("Importing HELLOs from `%s'\n"),
+          peerdir);
+      dsc.matched = 0;
+      dsc.remove_files = GNUNET_NO;
+
+      GNUNET_DISK_directory_scan (peerdir, &hosts_directory_scan_callback,
+          &dsc);
+      GNUNET_free (peerdir);
+    }
+    else
+    {
+      GNUNET_log(GNUNET_ERROR_TYPE_INFO, _("Skipping import of included HELLOs\n"));
     }
   }
   GNUNET_SERVER_add_handlers (server, handlers);