Merge branch 'master' of ssh://gnunet.org/gnunet
[oweals/gnunet.git] / src / fs / fs_list_indexed.c
index 1a404a078051e25012304084cea09f547fed47d0..eec125a10c744312f3afd4e0e439e704a31cb675 100644 (file)
@@ -1,10 +1,10 @@
 /*
      This file is part of GNUnet.
-     (C) 2003, 2004, 2006, 2009 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2003, 2004, 2006, 2009 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
-     by the Free Software Foundation; either version 2, or (at your
+     by the Free Software Foundation; either version 3, or (at your
      option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
@@ -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.
 */
 
 /**
 #include "gnunet_constants.h"
 #include "gnunet_fs_service.h"
 #include "gnunet_protocols.h"
-#include "fs.h"
+#include "fs_api.h"
 
 
 /**
- * Context for "GNUNET_FS_get_indexed_files".
+ * Context for #GNUNET_FS_get_indexed_files().
  */
-struct GetIndexedContext
+struct GNUNET_FS_GetIndexedContext
 {
-  /**
-   * Handle to global FS context.
-   */
-  struct GNUNET_FS_Handle *h;
 
   /**
    * Connection to the FS service.
    */
-  struct GNUNET_CLIENT_Connection *client;
+  struct GNUNET_MQ_Handle *mq;
 
   /**
    * Function to call for each indexed file.
@@ -52,17 +48,17 @@ struct GetIndexedContext
   GNUNET_FS_IndexedFileProcessor iterator;
 
   /**
-   * Closure for iterator.
+   * Closure for @e iterator.
    */
   void *iterator_cls;
 
   /**
    * Continuation to trigger at the end.
    */
-  GNUNET_SCHEDULER_Task cont;
+  GNUNET_SCHEDULER_TaskCallback cont;
 
   /**
-   * Closure for cont.
+   * Closure for @e cont.
    */
   void *cont_cls;
 };
@@ -72,129 +68,91 @@ struct GetIndexedContext
  * Function called on each response from the FS
  * service with information about indexed files.
  *
- * @param cls closure (of type "struct GetIndexedContext*")
+ * @param cls closure (of type `struct GNUNET_FS_GetIndexedContext *`)
  * @param msg message with indexing information
  */
 static void
+handle_index_info_end (void *cls,
+                       const struct GNUNET_MessageHeader *msg)
+{
+  struct GNUNET_FS_GetIndexedContext *gic = cls;
+
+  (void) gic->iterator (gic->iterator_cls,
+                        NULL,
+                        NULL);
+  GNUNET_FS_get_indexed_files_cancel (gic);
+}
+
+
+/**
+ * Check validity of response from the FS
+ * service with information about indexed files.
+ *
+ * @param cls closure (of type `struct GNUNET_FS_GetIndexedContext *`)
+ * @param iim message with indexing information
+ */
+static int
+check_index_info (void *cls,
+                  const struct IndexInfoMessage *iim)
+{
+  uint16_t msize = ntohs (iim->header.size) - sizeof (*iim);
+  const char *filename;
+
+  filename = (const char *) &iim[1];
+  if (filename[msize - 1] != '\0')
+  {
+    GNUNET_break (0);
+    return GNUNET_SYSERR;
+  }
+  return GNUNET_OK;
+}
+
+
+/**
+ * Function called on each response from the FS
+ * service with information about indexed files.
+ *
+ * @param cls closure (of type `struct GNUNET_FS_GetIndexedContext *`)
+ * @param iim message with indexing information
+ */
+static void
 handle_index_info (void *cls,
-                  const struct GNUNET_MessageHeader *msg)
+                   const struct IndexInfoMessage *iim)
 {
-  struct GetIndexedContext *gic = cls;
-  const struct IndexInfoMessage *iim;
-  uint16_t msize;
+  struct GNUNET_FS_GetIndexedContext *gic = cls;
   const char *filename;
 
-  if (NULL == msg)
-    {
-      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                 _("Failed to receive response for `%s' request from `%s' service.\n"),
-                 "GET_INDEXED",
-                 "fs");
-      GNUNET_SCHEDULER_add_continuation (gic->h->sched,
-                                        GNUNET_NO,
-                                        gic->cont,
-                                        gic->cont_cls,
-                                        GNUNET_SCHEDULER_REASON_TIMEOUT);
-      GNUNET_CLIENT_disconnect (gic->client);
-      GNUNET_free (gic);
-      return;
-    }
-  if (ntohs (msg->type) == GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_END)
-    {
-      /* normal end-of-list */
-      GNUNET_SCHEDULER_add_continuation (gic->h->sched,
-                                        GNUNET_NO,
-                                        gic->cont,
-                                        gic->cont_cls,
-                                        GNUNET_SCHEDULER_REASON_PREREQ_DONE);
-      GNUNET_CLIENT_disconnect (gic->client);
-      GNUNET_free (gic);
-      return;
-    }
-  msize = ntohs (msg->size);
-  iim = (const struct IndexInfoMessage*) msg;
-  filename = (const char*) &iim[1];
-  if ( (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_ENTRY) ||
-       (msize <= sizeof (struct IndexInfoMessage)) ||
-       (filename[msize-sizeof (struct IndexInfoMessage) -1] != '\0') )
-    {
-      /* bogus reply */
-      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                 _("Failed to receive valid response for `%s' request from `%s' service.\n"),
-                 "GET_INDEXED",
-                 "fs");
-      GNUNET_SCHEDULER_add_continuation (gic->h->sched,
-                                        GNUNET_NO,
-                                        gic->cont,
-                                        gic->cont_cls,
-                                        GNUNET_SCHEDULER_REASON_TIMEOUT);
-      GNUNET_CLIENT_disconnect (gic->client);
-      GNUNET_free (gic);
-      return;
-    }
+  filename = (const char *) &iim[1];
   if (GNUNET_OK !=
       gic->iterator (gic->iterator_cls,
-                    filename,
-                    &iim->file_id))
-    {
-      GNUNET_SCHEDULER_add_continuation (gic->h->sched,
-                                        GNUNET_NO,
-                                        gic->cont,
-                                        gic->cont_cls,
-                                        GNUNET_SCHEDULER_REASON_PREREQ_DONE);
-      GNUNET_CLIENT_disconnect (gic->client);
-      GNUNET_free (gic);
-      return;
-    }
-  /* get more */
-  GNUNET_CLIENT_receive (gic->client,
-                        &handle_index_info,
-                        gic,
-                        GNUNET_CONSTANTS_SERVICE_TIMEOUT);  
+                     filename,
+                     &iim->file_id))
+  {
+    GNUNET_FS_get_indexed_files_cancel (gic);
+    return;
+  }
 }
 
 
 /**
- * Transmit the request to get a list of all 
- * indexed files to the "FS" service.
+ * Generic error handler, called with the appropriate error code and
+ * the same closure specified at the creation of the message queue.
+ * Not every message queue implementation supports an error handler.
  *
- * @param cls closure (of type "struct GetIndexedContext*")
- * @param size number of bytes availabe in buf
- * @param buf where to write the message, NULL on error
- * @return number of bytes written to buf
+ * @param cls closure with the `struct GNUNET_FS_GetIndexedContent *`
+ * @param error error code
  */
-static size_t
-transmit_get_indexed (void *cls,
-                     size_t size,
-                     void *buf)
+static void
+mq_error_handler (void *cls,
+                  enum GNUNET_MQ_Error error)
 {
-  struct GetIndexedContext *gic = cls;
-  struct GNUNET_MessageHeader *hdr;
-
-  if (NULL == buf)
-    {
-      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                 _("Failed to transmit `%s' request to `%s' service.\n"),
-                 "GET_INDEXED",
-                 "fs");
-      GNUNET_SCHEDULER_add_continuation (gic->h->sched,
-                                        GNUNET_NO,
-                                        gic->cont,
-                                        gic->cont_cls,
-                                        GNUNET_SCHEDULER_REASON_TIMEOUT);
-      GNUNET_CLIENT_disconnect (gic->client);
-      GNUNET_free (gic);
-      return 0;
-    }
-  GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader));
-  hdr = buf;
-  hdr->size = htons (sizeof (struct GNUNET_MessageHeader));
-  hdr->type = htons (GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET);
-  GNUNET_CLIENT_receive (gic->client,
-                        &handle_index_info,
-                        gic,
-                        GNUNET_CONSTANTS_SERVICE_TIMEOUT);
-  return sizeof (struct GNUNET_MessageHeader);
+  struct GNUNET_FS_GetIndexedContext *gic = cls;
+
+  GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+              _("Failed to receive response from `%s' service.\n"),
+              "fs");
+  (void) gic->iterator (gic->iterator_cls, NULL, NULL);
+  GNUNET_FS_get_indexed_files_cancel (gic);
 }
 
 
@@ -204,49 +162,63 @@ transmit_get_indexed (void *cls,
  * @param h handle to the file sharing subsystem
  * @param iterator function to call on each indexed file
  * @param iterator_cls closure for iterator
- * @param cont continuation to call when done;
- *             reason should be "TIMEOUT" (on
- *             error) or  "PREREQ_DONE" (on success)
- * @param cont_cls closure for cont
+ * @return NULL on error ('iter' is not called)
  */
-void 
+struct GNUNET_FS_GetIndexedContext *
 GNUNET_FS_get_indexed_files (struct GNUNET_FS_Handle *h,
-                            GNUNET_FS_IndexedFileProcessor iterator,
-                            void *iterator_cls,
-                            GNUNET_SCHEDULER_Task cont,
-                            void *cont_cls)
+                             GNUNET_FS_IndexedFileProcessor iterator,
+                             void *iterator_cls)
 {
-  struct GNUNET_CLIENT_Connection *client;
-  struct GetIndexedContext *gic;
-
-  client = GNUNET_CLIENT_connect (h->sched,
-                                 "fs",
-                                 h->cfg);
-  if (NULL == client)
-    {
-      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
-                 _("Failed to not connect to `%s' service.\n"),
-                 "fs");
-      GNUNET_SCHEDULER_add_continuation (h->sched,
-                                        GNUNET_NO,
-                                        cont,
-                                        cont_cls,
-                                        GNUNET_SCHEDULER_REASON_TIMEOUT);
-      return;
-    }
-
-  gic = GNUNET_malloc (sizeof (struct GetIndexedContext));
-  gic->h = h;
-  gic->client = client;
+  struct GNUNET_FS_GetIndexedContext *gic
+    = GNUNET_new (struct GNUNET_FS_GetIndexedContext);
+  struct GNUNET_MQ_MessageHandler handlers[] = {
+    GNUNET_MQ_hd_fixed_size (index_info_end,
+                             GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_END,
+                             struct GNUNET_MessageHeader,
+                             gic),
+    GNUNET_MQ_hd_var_size (index_info,
+                           GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_ENTRY,
+                           struct IndexInfoMessage,
+                           gic),
+    GNUNET_MQ_handler_end ()
+  };
+  struct GNUNET_MQ_Envelope *env;
+  struct GNUNET_MessageHeader *msg;
+
+  gic->mq = GNUNET_CLIENT_connect (h->cfg,
+                                   "fs",
+                                   handlers,
+                                   &mq_error_handler,
+                                   h);
+  if (NULL == gic->mq)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+                _("Failed to not connect to `%s' service.\n"),
+                "fs");
+    GNUNET_free (gic);
+    return NULL;
+  }
   gic->iterator = iterator;
   gic->iterator_cls = iterator_cls;
-  gic->cont = cont;
-  gic->cont_cls = cont_cls;
-  GNUNET_CLIENT_notify_transmit_ready (client,
-                                      sizeof (struct GNUNET_MessageHeader),
-                                      GNUNET_CONSTANTS_SERVICE_TIMEOUT,
-                                      &transmit_get_indexed,
-                                      gic);
+  env = GNUNET_MQ_msg (msg,
+                       GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET);
+  GNUNET_MQ_send (gic->mq,
+                  env);
+  return gic;
 }
 
+
+/**
+ * Cancel iteration over all indexed files.
+ *
+ * @param gic operation to cancel
+ */
+void
+GNUNET_FS_get_indexed_files_cancel (struct GNUNET_FS_GetIndexedContext *gic)
+{
+  GNUNET_MQ_destroy (gic->mq);
+  GNUNET_free (gic);
+}
+
+
 /* end of fs_list_indexed.c */