fixing 1584
[oweals/gnunet.git] / src / fs / fs_search.c
index 8db9f115d4ad8ddfc7d2d22e63207927cdc4c075..a6418f786ba7237053b18c736d639b8625b0ecba 100644 (file)
@@ -4,7 +4,7 @@
 
      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
@@ -24,8 +24,6 @@
  * @author Christian Grothoff
  *
  * TODO:
- * - remove *directory* with search results upon completion
- * - centralize code that sprintf's the 'pbuf[32]' strings
  * - add support for pushing "already seen" information
  *   to FS service for bloomfilter (can wait)
  */
@@ -38,8 +36,6 @@
 
 #define DEBUG_SEARCH GNUNET_NO
 
-
-
 /**
  * Fill in all of the generic fields for a search event and
  * call the callback.
@@ -57,7 +53,7 @@ GNUNET_FS_search_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
   pi->value.search.cctx
     = sc->client_info;
   pi->value.search.pctx
-    = (sc->parent == NULL) ? NULL : sc->parent->client_info;
+    = (sc->psearch_result == NULL) ? NULL : sc->psearch_result->client_info;
   pi->value.search.query 
     = sc->uri;
   pi->value.search.duration = GNUNET_TIME_absolute_get_duration (sc->start_time);
@@ -111,6 +107,7 @@ notify_client_chk_result (struct GNUNET_FS_SearchContext *sc,
   pi.value.search.specifics.result.meta = sr->meta;
   pi.value.search.specifics.result.uri = sr->uri;
   pi.value.search.specifics.result.result = sr;
+  pi.value.search.specifics.result.applicability_rank = sr->optional_support;
   sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
 }
 
@@ -466,7 +463,7 @@ process_ksk_result (struct GNUNET_FS_SearchContext *sc,
  * @param anonymity desired level of anonymity
  * @param options options for the search
  * @param cctx client context
- * @param parent parent search (for namespace update searches)
+ * @param psearch parent search result (for namespace update searches)
  * @return context that can be used to control the search
  */
 static struct GNUNET_FS_SearchContext *
@@ -475,7 +472,7 @@ search_start (struct GNUNET_FS_Handle *h,
              uint32_t anonymity,
              enum GNUNET_FS_SearchOptions options,
              void *cctx,
-             struct GNUNET_FS_SearchContext *parent);
+             struct GNUNET_FS_SearchResult *psearch);
 
 
 /**
@@ -527,15 +524,13 @@ process_sks_result (struct GNUNET_FS_SearchContext *sc,
   uu.type = sks;
   uu.data.sks.namespace = sc->uri->data.sks.namespace;
   uu.data.sks.identifier = GNUNET_strdup (id_update);
-  /* FIXME: should attach update search
-     to the individual result, not
-     the entire SKS search! */
-  search_start (sc->h,
-               &uu,
-               sc->anonymity,
-               sc->options,
-               NULL,
-               sc);
+  (void) search_start (sc->h,
+                      &uu,
+                      sc->anonymity,
+                      sc->options,
+                      NULL,
+                      sr);
+  GNUNET_free (uu.data.sks.identifier);
 }
 
 
@@ -579,11 +574,15 @@ process_kblock (struct GNUNET_FS_SearchContext *sc,
     }
   /* decrypt */
   GNUNET_CRYPTO_hash_to_aes_key (&sc->requests[i].key, &skey, &iv);
-  GNUNET_CRYPTO_aes_decrypt (&kb[1],
-                            size - sizeof (struct KBlock),
-                            &skey,
-                            &iv,
-                            pt);
+  if (-1 == GNUNET_CRYPTO_aes_decrypt (&kb[1],
+                                      size - sizeof (struct KBlock),
+                                      &skey,
+                                      &iv,
+                                      pt))
+    {
+      GNUNET_break (0);
+      return;
+    }
   /* parse */
   eos = memchr (pt, 0, sizeof (pt));
   if (NULL == eos)
@@ -659,11 +658,15 @@ process_nblock (struct GNUNET_FS_SearchContext *sc,
     }
   /* decrypt */
   GNUNET_CRYPTO_hash_to_aes_key (&sc->requests[i].key, &skey, &iv);
-  GNUNET_CRYPTO_aes_decrypt (&nb[1],
-                            size - sizeof (struct NBlock),
-                            &skey,
-                            &iv,
-                            pt);
+  if (-1 == GNUNET_CRYPTO_aes_decrypt (&nb[1],
+                                      size - sizeof (struct NBlock),
+                                      &skey,
+                                      &iv,
+                                      pt))
+    {
+      GNUNET_break (0);
+      return;
+    }
   /* parse */
   eos = memchr (pt, 0, sizeof (pt));
   if (NULL == eos)
@@ -741,11 +744,15 @@ process_sblock (struct GNUNET_FS_SearchContext *sc,
                      strlen (identifier), 
                      &key);
   GNUNET_CRYPTO_hash_to_aes_key (&key, &skey, &iv);
-  GNUNET_CRYPTO_aes_decrypt (&sb[1],
-                            len,
-                            &skey,
-                            &iv,
-                            pt);
+  if (-1 == GNUNET_CRYPTO_aes_decrypt (&sb[1],
+                                      len,
+                                      &skey,
+                                      &iv,
+                                      pt))
+    {
+      GNUNET_break (0);
+      return;
+    }
   /* parse */
   off = GNUNET_STRINGS_buffer_tokenize (pt,
                                        len, 
@@ -956,6 +963,9 @@ transmit_search_request (void *cls,
          sm[i].type = htonl (GNUNET_BLOCK_TYPE_ANY);
          sm[i].anonymity_level = htonl (sc->anonymity);
          sm[i].query = sc->requests[i].query;
+         /* FIXME: should transmit hash codes of all already-known results here! 
+            (and if they do not fit, add another message with the same 
+            header and additional already-seen results!) */
        }
     }
   else
@@ -984,6 +994,9 @@ transmit_search_request (void *cls,
       GNUNET_CRYPTO_hash_xor (&idh,
                              &sm->target,
                              &sm->query);
+      /* FIXME: should transmit hash codes of all already-known results here!
+        (and if they do not fit, add another message with the same 
+        header and additional already-seen results!) */      
    }
   GNUNET_CLIENT_receive (sc->client,
                         &receive_results,
@@ -1063,7 +1076,7 @@ try_reconnect (struct GNUNET_FS_SearchContext *sc)
  * @param anonymity desired level of anonymity
  * @param options options for the search
  * @param cctx initial value for the client context
- * @param parent parent search (for namespace update searches)
+ * @param psearch parent search result (for namespace update searches)
  * @return context that can be used to control the search
  */
 static struct GNUNET_FS_SearchContext *
@@ -1072,7 +1085,7 @@ search_start (struct GNUNET_FS_Handle *h,
              uint32_t anonymity,
              enum GNUNET_FS_SearchOptions options,
              void *cctx,
-             struct GNUNET_FS_SearchContext *parent)
+             struct GNUNET_FS_SearchResult *psearch)
 {
   struct GNUNET_FS_SearchContext *sc;
   struct GNUNET_FS_ProgressInfo pi;
@@ -1083,13 +1096,13 @@ search_start (struct GNUNET_FS_Handle *h,
   sc->uri = GNUNET_FS_uri_dup (uri);
   sc->anonymity = anonymity;
   sc->start_time = GNUNET_TIME_absolute_get ();
-  sc->parent = parent;
+  if (psearch != NULL)
+    {
+      sc->psearch_result = psearch;  
+      psearch->update_search = sc;
+    }
   sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16);
   sc->client_info = cctx;
-  if (NULL != parent)
-    GNUNET_CONTAINER_DLL_insert (parent->child_head,
-                                parent->child_tail,
-                                sc);
   if (GNUNET_OK !=
       GNUNET_FS_search_start_searching_ (sc))
     {
@@ -1148,6 +1161,7 @@ GNUNET_FS_search_start_searching_ (struct GNUNET_FS_SearchContext *sc)
          keyword = &sc->uri->data.ksk.keywords[i][1];
          GNUNET_CRYPTO_hash (keyword, strlen (keyword), &hc);
          pk = GNUNET_CRYPTO_rsa_key_create_from_hash (&hc);
+         GNUNET_assert (pk != NULL);
          GNUNET_CRYPTO_rsa_key_get_public (pk, &pub);
          GNUNET_CRYPTO_rsa_key_free (pk);
          GNUNET_CRYPTO_hash (&pub,
@@ -1177,6 +1191,61 @@ GNUNET_FS_search_start_searching_ (struct GNUNET_FS_SearchContext *sc)
 }
 
 
+/**
+ * Freeze probes for the given search result.
+ *
+ * @param cls the global FS handle
+ * @param key the key for the search result (unused)
+ * @param value the search result to free
+ * @return GNUNET_OK
+ */
+static int
+search_result_freeze_probes (void *cls,
+                            const GNUNET_HashCode * key,
+                            void *value)
+{
+  struct GNUNET_FS_SearchContext *sc = cls;
+  struct GNUNET_FS_Handle *h = sc->h;
+  struct GNUNET_FS_SearchResult *sr = value;
+
+  if (sr->probe_ctx != NULL)
+    {
+      GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);    
+      sr->probe_ctx = NULL;
+    }
+  if (sr->probe_cancel_task != GNUNET_SCHEDULER_NO_TASK)
+    {
+      GNUNET_SCHEDULER_cancel (h->sched,
+                              sr->probe_cancel_task);  
+      sr->probe_cancel_task = GNUNET_SCHEDULER_NO_TASK;
+    }
+  if (sr->update_search != NULL)
+    GNUNET_FS_search_pause (sr->update_search);
+  return GNUNET_OK;
+}
+
+
+/**
+ * Resume probes for the given search result.
+ *
+ * @param cls the global FS handle
+ * @param key the key for the search result (unused)
+ * @param value the search result to free
+ * @return GNUNET_OK
+ */
+static int
+search_result_resume_probes (void *cls,
+                            const GNUNET_HashCode * key,
+                            void *value)
+{
+  struct GNUNET_FS_SearchResult *sr = value;
+
+  GNUNET_FS_search_start_probe_ (sr);
+  if (sr->update_search != NULL)
+    GNUNET_FS_search_continue (sr->update_search);
+  return GNUNET_OK;
+}
+
 
 /**
  * Signal suspend and free the given search result.
@@ -1198,6 +1267,8 @@ search_result_suspend (void *cls,
 
   if (sr->download != NULL)
     GNUNET_FS_download_signal_suspend_ (sr->download);
+  if (sr->update_search != NULL)
+    GNUNET_FS_search_signal_suspend_ (sr->update_search);
   pi.status = GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND;
   pi.value.search.specifics.result_suspend.cctx = sr->client_info;
   pi.value.search.specifics.result_suspend.meta = sr->meta;
@@ -1223,24 +1294,14 @@ search_result_suspend (void *cls,
  *
  * @param cls the 'struct GNUNET_FS_SearchContext' to signal for
  */
-static void
-search_signal_suspend (void *cls)
+void
+GNUNET_FS_search_signal_suspend_ (void *cls)
 {
   struct GNUNET_FS_SearchContext *sc = cls;
-  struct GNUNET_FS_SearchContext *parent = cls;
   struct GNUNET_FS_ProgressInfo pi;
   unsigned int i;
 
   GNUNET_FS_end_top (sc->h, sc->top);
-  if (NULL != (parent = sc->parent))
-    {
-      GNUNET_CONTAINER_DLL_remove (parent->child_head,
-                                  parent->child_tail,
-                                  sc);
-      sc->parent = NULL;
-    }
-  while (NULL != sc->child_head)
-    search_signal_suspend (sc->child_head);
   GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
                                         &search_result_suspend,
                                         sc);
@@ -1262,6 +1323,7 @@ search_signal_suspend (void *cls)
   GNUNET_free_non_null (sc->requests);
   GNUNET_free_non_null (sc->emsg);
   GNUNET_FS_uri_destroy (sc->uri);
+  GNUNET_free_non_null (sc->serialization);
   GNUNET_free (sc);
 }
 
@@ -1286,7 +1348,9 @@ GNUNET_FS_search_start (struct GNUNET_FS_Handle *h,
 {
   struct GNUNET_FS_SearchContext *ret;
   ret = search_start (h, uri, anonymity, options, cctx, NULL);
-  ret->top = GNUNET_FS_make_top (h, &search_signal_suspend, ret);
+  if (ret == NULL)
+    return NULL;
+  ret->top = GNUNET_FS_make_top (h, &GNUNET_FS_search_signal_suspend_, ret);
   return ret;
 }
 
@@ -1309,7 +1373,9 @@ GNUNET_FS_search_pause (struct GNUNET_FS_SearchContext *sc)
     GNUNET_CLIENT_disconnect (sc->client, GNUNET_NO);
   sc->client = NULL;
   GNUNET_FS_search_sync_ (sc);
-  // FIXME: should this freeze all active probes?
+  GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
+                                        &search_result_freeze_probes,
+                                        sc);
   pi.status = GNUNET_FS_STATUS_SEARCH_PAUSED;
   sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
 }
@@ -1331,6 +1397,9 @@ GNUNET_FS_search_continue (struct GNUNET_FS_SearchContext *sc)
   GNUNET_FS_search_sync_ (sc);
   pi.status = GNUNET_FS_STATUS_SEARCH_CONTINUED;
   sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
+  GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
+                                        &search_result_resume_probes,
+                                        sc);
 }
 
 
@@ -1349,38 +1418,41 @@ search_result_free (void *cls,
 {
   struct GNUNET_FS_SearchContext *sc = cls;
   struct GNUNET_FS_Handle *h = sc->h;
-  char pbuf[32];
   struct GNUNET_FS_SearchResult *sr = value;
   struct GNUNET_FS_ProgressInfo pi;
 
   if (NULL != sr->download)
     {
       sr->download->search = NULL;
+      sr->download->top = GNUNET_FS_make_top (sr->download->h,
+                                             &GNUNET_FS_download_signal_suspend_,
+                                             sr->download);
+      if (NULL != sr->download->serialization)
+       {
+         GNUNET_FS_remove_sync_file_ (sc->h,
+                                      GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD,
+                                      sr->download->serialization);
+         GNUNET_free (sr->download->serialization);
+         sr->download->serialization = NULL;
+       }
       pi.status = GNUNET_FS_STATUS_DOWNLOAD_LOST_PARENT;
       GNUNET_FS_download_make_status_ (&pi,
-                                      sr->download);
-      /* FIXME: promote download to top-level! */
+                                      sr->download);      
+      GNUNET_FS_download_sync_ (sr->download);
       sr->download = NULL;     
     }
+  if (NULL != sr->update_search)
+    {
+      GNUNET_FS_search_stop (sr->update_search);
+      GNUNET_assert (sr->update_search == NULL);
+    }
   pi.status = GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED;
   pi.value.search.specifics.result_stopped.cctx = sr->client_info;
   pi.value.search.specifics.result_stopped.meta = sr->meta;
   pi.value.search.specifics.result_stopped.uri = sr->uri;
   sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
   GNUNET_break (NULL == sr->client_info);
-  if (sr->serialization != NULL)
-    {
-      GNUNET_snprintf (pbuf,
-                      sizeof (pbuf),
-                      "%s%s%s",
-                      "search-results",
-                      DIR_SEPARATOR_STR,
-                      sc->serialization);
-      GNUNET_FS_remove_sync_file_ (sc->h,
-                                  pbuf,
-                                  sr->serialization);
-      GNUNET_free (sr->serialization);
-    }
+  GNUNET_free_non_null (sr->serialization);
   GNUNET_FS_uri_destroy (sr->uri);
   GNUNET_CONTAINER_meta_data_destroy (sr->meta);
   if (sr->probe_ctx != NULL)
@@ -1403,30 +1475,28 @@ GNUNET_FS_search_stop (struct GNUNET_FS_SearchContext *sc)
 {
   struct GNUNET_FS_ProgressInfo pi;
   unsigned int i;
-  struct GNUNET_FS_SearchContext *parent;
-  int had_result;
 
   if (sc->top != NULL)
     GNUNET_FS_end_top (sc->h, sc->top);
-  if (sc->serialization != NULL)
-    GNUNET_FS_remove_sync_file_ (sc->h,
-                                (sc->parent != NULL) ? "search-children" : "search",
-                                sc->serialization);
-  if (NULL != (parent = sc->parent))
-    {
-      GNUNET_CONTAINER_DLL_remove (parent->child_head,
-                                  parent->child_tail,
-                                  sc);
-      sc->parent = NULL;
-    }
-  while (NULL != sc->child_head)
-    GNUNET_FS_search_stop (sc->child_head);
-  had_result = (0 != GNUNET_CONTAINER_multihashmap_size (sc->master_result_map)) ? GNUNET_YES : GNUNET_NO;
+  if (sc->psearch_result != NULL)
+    sc->psearch_result->update_search = NULL;
   GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
                                         &search_result_free,
                                         sc);
-  if (had_result)
-    GNUNET_FS_remove_sync_dir_ (sc->h, "search-results", sc->serialization);
+  if (sc->serialization != NULL)
+    {
+      GNUNET_FS_remove_sync_file_ (sc->h,
+                                  (sc->psearch_result != NULL)  
+                                  ? GNUNET_FS_SYNC_PATH_CHILD_SEARCH 
+                                  : GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
+                                  sc->serialization);
+      GNUNET_FS_remove_sync_dir_ (sc->h,
+                                 (sc->psearch_result != NULL)  
+                                 ? GNUNET_FS_SYNC_PATH_CHILD_SEARCH 
+                                 : GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
+                                 sc->serialization);
+      GNUNET_free (sc->serialization);
+    }
   pi.status = GNUNET_FS_STATUS_SEARCH_STOPPED;
   sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
   GNUNET_break (NULL == sc->client_info);