guix-env: some update.
[oweals/gnunet.git] / src / peerinfo / peerinfo_api_notify.c
index ab0d13f66616c067ea1363f7e15689da585a0e35..ce226d96e432b775a5a1431fe2b04c499f4c9146 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2001, 2002, 2004, 2005, 2007, 2009, 2010 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2001, 2002, 2004, 2005, 2007, 2009, 2010 GNUnet e.V.
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -14,8 +14,8 @@
 
      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
  * @author Christian Grothoff
  */
 #include "platform.h"
-#include "gnunet_client_lib.h"
+#include "gnunet_util_lib.h"
 #include "gnunet_peerinfo_service.h"
 #include "gnunet_protocols.h"
-#include "gnunet_time_lib.h"
 #include "peerinfo.h"
 
+#define LOG(kind,...) GNUNET_log_from (kind, "peerinfo-api",__VA_ARGS__)
+
 /**
  * Context for the info handler.
  */
@@ -39,7 +40,7 @@ struct GNUNET_PEERINFO_NotifyContext
   /**
    * Our connection to the PEERINFO service.
    */
-  struct GNUNET_CLIENT_Connection *client;
+  struct GNUNET_MQ_Handle *mq;
 
   /**
    * Function to call with information.
@@ -47,167 +48,182 @@ struct GNUNET_PEERINFO_NotifyContext
   GNUNET_PEERINFO_Processor callback;
 
   /**
-   * Closure for callback.
+   * Closure for @e callback.
    */
   void *callback_cls;
 
   /**
-   * Handle to our initial request for message transmission to
-   * the peerinfo service.
+   * Configuration.
    */
-  struct GNUNET_CLIENT_TransmitHandle *init;
+  const struct GNUNET_CONFIGURATION_Handle *cfg;
 
   /**
-   * Configuration.
+   * Tasked used for delayed re-connection attempt.
    */
-  const struct GNUNET_CONFIGURATION_Handle *cfg;
+  struct GNUNET_SCHEDULER_Task *task;
 
+  /**
+   * Include friend only HELLOs in callbacks
+   */
+  int include_friend_only;
 };
 
 
 /**
- * Send a request to the peerinfo service to start being
- * notified about all changes to peer information.
+ * Task to re-try connecting to peerinfo.
  *
- * @param nc our context
+ * @param cls the `struct GNUNET_PEERINFO_NotifyContext *`
  */
 static void
-request_notifications (struct GNUNET_PEERINFO_NotifyContext *nc);
+reconnect (void *cls);
 
 
 /**
- * Read notifications from the client handle and pass them
- * to the callback.
+ * We encountered an error, reconnect to the service.
  *
- * @param nc our context
+ * @param nc context to reconnect
  */
 static void
-receive_notifications (struct GNUNET_PEERINFO_NotifyContext *nc);
+do_reconnect (struct GNUNET_PEERINFO_NotifyContext *nc)
+{
+  GNUNET_MQ_destroy (nc->mq);
+  nc->mq = NULL;
+  nc->task = GNUNET_SCHEDULER_add_now (&reconnect,
+                                       nc);
+}
 
 
 /**
- * Receive a peerinfo information message, process it and
- * go for more.
+ * We got a disconnect after asking regex to do the announcement.
+ * Retry.
  *
- * @param cls closure
- * @param msg message received, NULL on timeout or fatal error
+ * @param cls the `struct GNUNET_PEERINFO_NotifyContext` to retry
+ * @param error error code
  */
 static void
-process_notification (void *cls,
-                     const struct
-                     GNUNET_MessageHeader * msg)
+mq_error_handler (void *cls,
+                  enum GNUNET_MQ_Error error)
 {
   struct GNUNET_PEERINFO_NotifyContext *nc = cls;
-  const struct InfoMessage *im;
-  const struct GNUNET_HELLO_Message *hello;
-  uint16_t ms;
 
-  if (msg == NULL)
-    {
-      GNUNET_CLIENT_disconnect (nc->client, GNUNET_NO);
-      nc->client = GNUNET_CLIENT_connect ("peerinfo", nc->cfg);
-      request_notifications (nc);
-      return;
-    }
-  ms = ntohs (msg->size);
-  if ((ms < sizeof (struct InfoMessage)) ||
-      (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_PEERINFO_INFO))
+  do_reconnect (nc);
+}
+
+
+/**
+ * Check that a peerinfo information message is well-formed.
+ *
+ * @param cls closure
+ * @param im message received
+ * @return #GNUNET_OK if the message is well-formed
+ */
+static int
+check_notification (void *cls,
+                    const struct InfoMessage *im)
+{
+  uint16_t ms = ntohs (im->header.size) - sizeof (*im);
+
+  if (ms >= sizeof (struct GNUNET_MessageHeader))
+  {
+    const struct GNUNET_HELLO_Message *hello;
+
+    hello = (const struct GNUNET_HELLO_Message *) &im[1];
+    if (ms != GNUNET_HELLO_size (hello))
     {
       GNUNET_break (0);
-      GNUNET_CLIENT_disconnect (nc->client, GNUNET_NO);
-      nc->client = GNUNET_CLIENT_connect ("peerinfo", nc->cfg);
-      request_notifications (nc);
-      return;
-    }
-  im = (const struct InfoMessage *) msg;
-  hello = NULL;
-  if (ms > sizeof (struct InfoMessage) + sizeof (struct GNUNET_MessageHeader))
-    {
-      hello = (const struct GNUNET_HELLO_Message *) &im[1];
-      if (ms != sizeof (struct InfoMessage) + GNUNET_HELLO_size (hello))
-        {
-          GNUNET_break (0);
-         GNUNET_CLIENT_disconnect (nc->client, GNUNET_NO);
-         nc->client = GNUNET_CLIENT_connect ("peerinfo", nc->cfg);
-         request_notifications (nc);
-          return;
-        }
+      return GNUNET_SYSERR;
     }
-#if DEBUG_PEERINFO
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-             "Received information about peer `%s' from peerinfo database\n",
-             GNUNET_i2s (&im->peer));
-#endif
-  nc->callback (nc->callback_cls, &im->peer, hello, NULL);
-  receive_notifications (nc);
+    return GNUNET_OK;
+  }
+  if (0 != ms)
+  {
+    GNUNET_break (0);
+    return GNUNET_SYSERR;
+  }
+  return GNUNET_OK;  /* odd... */
 }
 
 
 /**
- * Read notifications from the client handle and pass them
- * to the callback.
+ * Receive a peerinfo information message, process it.
  *
- * @param nc our context
+ * @param cls closure
+ * @param im message received
  */
 static void
-receive_notifications (struct GNUNET_PEERINFO_NotifyContext *nc)
+handle_notification (void *cls,
+                     const struct InfoMessage *im)
 {
-  GNUNET_CLIENT_receive (nc->client,
-                        &process_notification,
-                        nc,
-                        GNUNET_TIME_UNIT_FOREVER_REL);
+  struct GNUNET_PEERINFO_NotifyContext *nc = cls;
+  const struct GNUNET_HELLO_Message *hello;
+  uint16_t ms = ntohs (im->header.size) - sizeof (struct InfoMessage);
+
+  if (0 == ms)
+    return;
+  hello = (const struct GNUNET_HELLO_Message *) &im[1];
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Received information about peer `%s' from peerinfo database\n",
+       GNUNET_i2s (&im->peer));
+  nc->callback (nc->callback_cls,
+                &im->peer,
+                hello,
+                NULL);
 }
 
 
 /**
- * Transmit our init-notify request, start receiving.
+ * Type of a function to call when we receive a message from the
+ * service.  Call the iterator with the result and (if applicable)
+ * continue to receive more messages or trigger processing the next
+ * event (if applicable).
  *
- * @param cls closure (our 'struct GNUNET_PEERINFO_NotifyContext')
- * @param size number of bytes available in buf
- * @param buf where the callee should write the message
- * @return number of bytes written to buf
+ * @param cls closure
+ * @param msg message received, NULL on timeout or fatal error
  */
-static size_t 
-transmit_notify_request (void *cls,
-                        size_t size, 
-                        void *buf)
+static void
+handle_end_iteration (void *cls,
+                      const struct GNUNET_MessageHeader *msg)
 {
-  struct GNUNET_PEERINFO_NotifyContext *nc = cls;
-  struct GNUNET_MessageHeader hdr;
-
-  nc->init = NULL;
-  if (buf == NULL)
-    {
-      GNUNET_CLIENT_disconnect (nc->client, GNUNET_NO);
-      nc->client = GNUNET_CLIENT_connect ("peerinfo", nc->cfg);
-      request_notifications (nc);
-      return 0;
-    }
-  GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader));
-  hdr.size = htons (sizeof (struct GNUNET_MessageHeader));
-  hdr.type = htons (GNUNET_MESSAGE_TYPE_PEERINFO_NOTIFY);
-  memcpy (buf, &hdr, sizeof (struct GNUNET_MessageHeader));
-  receive_notifications (nc);
-  return sizeof (struct GNUNET_MessageHeader);
+  /* these are ignored by the notify API */
 }
 
 
 /**
- * Send a request to the peerinfo service to start being
- * notified about all changes to peer information.
+ * Task to re-try connecting to peerinfo.
  *
- * @param nc our context
+ * @param cls the `struct GNUNET_PEERINFO_NotifyContext *`
  */
 static void
-request_notifications (struct GNUNET_PEERINFO_NotifyContext *nc)
+reconnect (void *cls)
 {
-  GNUNET_assert (NULL == nc->init);
-  nc->init =GNUNET_CLIENT_notify_transmit_ready (nc->client,
-                                                sizeof (struct GNUNET_MessageHeader),
-                                                GNUNET_TIME_UNIT_FOREVER_REL,
-                                                GNUNET_YES,
-                                                &transmit_notify_request,
-                                                nc);
+  struct GNUNET_PEERINFO_NotifyContext *nc = cls;
+  struct GNUNET_MQ_MessageHandler handlers[] = {
+    GNUNET_MQ_hd_var_size (notification,
+                           GNUNET_MESSAGE_TYPE_PEERINFO_INFO,
+                           struct InfoMessage,
+                           nc),
+    GNUNET_MQ_hd_fixed_size (end_iteration,
+                             GNUNET_MESSAGE_TYPE_PEERINFO_INFO_END,
+                             struct GNUNET_MessageHeader,
+                             nc),
+    GNUNET_MQ_handler_end ()
+  };
+  struct GNUNET_MQ_Envelope *env;
+  struct NotifyMessage *nm;
+
+  nc->task = NULL;
+  nc->mq = GNUNET_CLIENT_connect (nc->cfg,
+                                  "peerinfo",
+                                  handlers,
+                                  &mq_error_handler,
+                                  nc);
+  if (NULL == nc->mq)
+    return;
+  env = GNUNET_MQ_msg (nm,
+                       GNUNET_MESSAGE_TYPE_PEERINFO_NOTIFY);
+  nm->include_friend_only = htonl (nc->include_friend_only);
+  GNUNET_MQ_send (nc->mq,
+                  env);
 }
 
 
@@ -216,32 +232,37 @@ request_notifications (struct GNUNET_PEERINFO_NotifyContext *nc)
  * changes.  Initially calls the given function for all known
  * peers and then only signals changes.
  *
+ * If @a include_friend_only is set to #GNUNET_YES peerinfo will include HELLO
+ * messages which are intended for friend to friend mode and which do not
+ * have to be gossiped. Otherwise these messages are skipped.
+ *
  * @param cfg configuration to use
+ * @param include_friend_only include HELLO messages for friends only
  * @param callback the method to call for each peer
- * @param callback_cls closure for callback
+ * @param callback_cls closure for @a callback
  * @return NULL on error
  */
 struct GNUNET_PEERINFO_NotifyContext *
 GNUNET_PEERINFO_notify (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                       GNUNET_PEERINFO_Processor callback,
-                       void *callback_cls)
+                        int include_friend_only,
+                        GNUNET_PEERINFO_Processor callback,
+                        void *callback_cls)
 {
   struct GNUNET_PEERINFO_NotifyContext *nc;
-  struct GNUNET_CLIENT_Connection *client;
-
-  client = GNUNET_CLIENT_connect ("peerinfo", cfg);
-  if (client == NULL)
-    {      
-      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                  _("Could not connect to `%s' service.\n"), "peerinfo");
-      return NULL;
-    }
-  nc = GNUNET_malloc (sizeof (struct GNUNET_PEERINFO_NotifyContext));
+
+  nc = GNUNET_new (struct GNUNET_PEERINFO_NotifyContext);
   nc->cfg = cfg;
-  nc->client = client;
   nc->callback = callback;
-  nc->callback_cls = callback_cls; 
-  request_notifications (nc);
+  nc->callback_cls = callback_cls;
+  nc->include_friend_only = include_friend_only;
+  reconnect (nc);
+  if (NULL == nc->mq)
+  {
+    LOG (GNUNET_ERROR_TYPE_WARNING,
+         "Could not connect to PEERINFO service.\n");
+    GNUNET_free (nc);
+    return NULL;
+  }
   return nc;
 }
 
@@ -254,12 +275,16 @@ GNUNET_PEERINFO_notify (const struct GNUNET_CONFIGURATION_Handle *cfg,
 void
 GNUNET_PEERINFO_notify_cancel (struct GNUNET_PEERINFO_NotifyContext *nc)
 {
-  if (NULL != nc->init)
-    {
-      GNUNET_CLIENT_notify_transmit_ready_cancel (nc->init);
-      nc->init = NULL;
-    }
-  GNUNET_CLIENT_disconnect (nc->client, GNUNET_NO);
+  if (NULL != nc->mq)
+  {
+    GNUNET_MQ_destroy (nc->mq);
+    nc->mq = NULL;
+  }
+  if (NULL != nc->task)
+  {
+    GNUNET_SCHEDULER_cancel (nc->task);
+    nc->task = NULL;
+  }
   GNUNET_free (nc);
 }