src/fs/fs_search.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001-2013 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Tem ple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20 /**
  21  * @file fs/fs_search.c
  22  * @brief Helper functions for searching.
  23  * @author Christian Grothoff
  24  */
  25 #include "platform.h"
  26 #include "gnunet_constants.h"
  27 #include "gnunet_fs_service.h"
  28 #include "gnunet_protocols.h"
  29 #include "fs_api.h"
  30 #include "fs_publish_ublock.h"
  31
  32
  33 /**
  34  * Number of availability trials we perform per search result.
  35  */
  36 #define AVAILABILITY_TRIALS_MAX 8
  37
  38 /**
  39  * Fill in all of the generic fields for a search event and
  40  * call the callback.
  41  *
  42  * @param pi structure to fill in
  43  * @param h file-sharing handle
  44  * @param sc overall search context
  45  * @return value returned by the callback
  46  */
  47 void *
  48 GNUNET_FS_search_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
  49                                struct GNUNET_FS_Handle *h,
  50                                struct GNUNET_FS_SearchContext *sc)
  51 {
  52   void *ret;
  53
  54   pi->value.search.sc = sc;
  55   pi->value.search.cctx = (NULL != sc) ? sc->client_info : NULL;
  56   pi->value.search.pctx =
  57     ((NULL == sc) || (NULL == sc->psearch_result))
  58     ? NULL
  59     : sc->psearch_result->client_info;
  60   pi->value.search.query = (NULL != sc) ? sc->uri : NULL;
  61   pi->value.search.duration = (NULL != sc)
  62     ? GNUNET_TIME_absolute_get_duration (sc->start_time)
  63     : GNUNET_TIME_UNIT_ZERO;
  64   pi->value.search.anonymity = (NULL != sc) ? sc->anonymity : 0;
  65   pi->fsh = h;
  66   ret = h->upcb (h->upcb_cls, pi);
  67   return ret;
  68 }
  69
  70
  71 /**
  72  * Check if the given result is identical to the given URI.
  73  *
  74  * @param cls points to the URI we check against
  75  * @param key not used
  76  * @param value a `struct GNUNET_FS_SearchResult` who's URI we
  77  *        should compare with
  78  * @return #GNUNET_SYSERR if the result is present,
  79  *         #GNUNET_OK otherwise
  80  */
  81 static int
  82 test_result_present (void *cls,
  83                      const struct GNUNET_HashCode * key,
  84                      void *value)
  85 {
  86   const struct GNUNET_FS_Uri *uri = cls;
  87   struct GNUNET_FS_SearchResult *sr = value;
  88
  89   if (GNUNET_FS_uri_test_equal (uri, sr->uri))
  90     return GNUNET_SYSERR;
  91   return GNUNET_OK;
  92 }
  93
  94
  95 /**
  96  * We've found a new CHK result.  Let the client
  97  * know about it.
  98  *
  99  * @param sc the search context
 100  * @param sr the specific result
 101  */
 102 static void
 103 notify_client_chk_result (struct GNUNET_FS_SearchContext *sc,
 104                           struct GNUNET_FS_SearchResult *sr)
 105 {
 106   struct GNUNET_FS_ProgressInfo pi;
 107
 108   pi.status = GNUNET_FS_STATUS_SEARCH_RESULT;
 109   pi.value.search.specifics.result.meta = sr->meta;
 110   pi.value.search.specifics.result.uri = sr->uri;
 111   pi.value.search.specifics.result.result = sr;
 112   pi.value.search.specifics.result.applicability_rank = sr->optional_support;
 113   sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
 114 }
 115
 116
 117 /**
 118  * We've found new information about an existing CHK result.  Let the
 119  * client know about it.
 120  *
 121  * @param sc the search context
 122  * @param sr the specific result
 123  */
 124 static void
 125 notify_client_chk_update (struct GNUNET_FS_SearchContext *sc,
 126                           struct GNUNET_FS_SearchResult *sr)
 127 {
 128   struct GNUNET_FS_ProgressInfo pi;
 129
 130   pi.status = GNUNET_FS_STATUS_SEARCH_UPDATE;
 131   pi.value.search.specifics.update.cctx = sr->client_info;
 132   pi.value.search.specifics.update.meta = sr->meta;
 133   pi.value.search.specifics.update.uri = sr->uri;
 134   pi.value.search.specifics.update.availability_rank =
 135       2 * sr->availability_success - sr->availability_trials;
 136   pi.value.search.specifics.update.availability_certainty =
 137       sr->availability_trials;
 138   pi.value.search.specifics.update.applicability_rank = sr->optional_support;
 139   pi.value.search.specifics.update.current_probe_time
 140     = GNUNET_TIME_absolute_get_duration (sr->probe_active_time);
 141   sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
 142 }
 143
 144
 145 /**
 146  * Context for "get_result_present".
 147  */
 148 struct GetResultContext
 149 {
 150   /**
 151    * The URI we're looking for.
 152    */
 153   const struct GNUNET_FS_Uri *uri;
 154
 155   /**
 156    * Where to store a pointer to the search
 157    * result struct if we found a match.
 158    */
 159   struct GNUNET_FS_SearchResult *sr;
 160 };
 161
 162
 163 /**
 164  * Check if the given result is identical to the given URI and if so
 165  * return it.
 166  *
 167  * @param cls a `struct GetResultContext`
 168  * @param key not used
 169  * @param value a `struct GNUNET_FS_SearchResult` who's URI we
 170  *        should compare with
 171  * @return #GNUNET_OK
 172  */
 173 static int
 174 get_result_present (void *cls, const struct GNUNET_HashCode * key, void *value)
 175 {
 176   struct GetResultContext *grc = cls;
 177   struct GNUNET_FS_SearchResult *sr = value;
 178
 179   if (GNUNET_FS_uri_test_equal (grc->uri, sr->uri))
 180     grc->sr = sr;
 181   return GNUNET_OK;
 182 }
 183
 184
 185 /**
 186  * Signal result of last probe to client and then schedule next
 187  * probe.
 188  *
 189  * @param sr search result to signal for
 190  */
 191 static void
 192 signal_probe_result (struct GNUNET_FS_SearchResult *sr)
 193 {
 194   struct GNUNET_FS_ProgressInfo pi;
 195
 196   pi.status = GNUNET_FS_STATUS_SEARCH_UPDATE;
 197   pi.value.search.specifics.update.cctx = sr->client_info;
 198   pi.value.search.specifics.update.meta = sr->meta;
 199   pi.value.search.specifics.update.uri = sr->uri;
 200   pi.value.search.specifics.update.availability_rank
 201     = 2 * sr->availability_success - sr->availability_trials;
 202   pi.value.search.specifics.update.availability_certainty
 203     = sr->availability_trials;
 204   pi.value.search.specifics.update.applicability_rank = sr->optional_support;
 205   pi.value.search.specifics.update.current_probe_time
 206     = GNUNET_TIME_absolute_get_duration (sr->probe_active_time);
 207   sr->client_info = GNUNET_FS_search_make_status_ (&pi, sr->h, sr->sc);
 208   GNUNET_FS_search_start_probe_ (sr);
 209 }
 210
 211
 212 /**
 213  * Handle the case where we have failed to receive a response for our probe.
 214  *
 215  * @param cls our `struct GNUNET_FS_SearchResult *`
 216  * @param tc scheduler context
 217  */
 218 static void
 219 probe_failure_handler (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 220 {
 221   struct GNUNET_FS_SearchResult *sr = cls;
 222
 223   sr->probe_cancel_task = GNUNET_SCHEDULER_NO_TASK;
 224   sr->availability_trials++;
 225   GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
 226   sr->probe_ctx = NULL;
 227   if (GNUNET_SCHEDULER_NO_TASK != sr->probe_ping_task)
 228   {
 229     GNUNET_SCHEDULER_cancel (sr->probe_ping_task);
 230     sr->probe_ping_task = GNUNET_SCHEDULER_NO_TASK;
 231   }
 232   GNUNET_FS_search_result_sync_ (sr);
 233   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 234               "Probe #%u for search result %p failed\n",
 235               sr->availability_trials,
 236               sr);
 237   signal_probe_result (sr);
 238 }
 239
 240
 241 /**
 242  * Handle the case where we have gotten a response for our probe.
 243  *
 244  * @param cls our `struct GNUNET_FS_SearchResult *`
 245  * @param tc scheduler context
 246  */
 247 static void
 248 probe_success_handler (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 249 {
 250   struct GNUNET_FS_SearchResult *sr = cls;
 251
 252   sr->probe_cancel_task = GNUNET_SCHEDULER_NO_TASK;
 253   sr->availability_trials++;
 254   sr->availability_success++;
 255   GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
 256   sr->probe_ctx = NULL;
 257   if (GNUNET_SCHEDULER_NO_TASK != sr->probe_ping_task)
 258   {
 259     GNUNET_SCHEDULER_cancel (sr->probe_ping_task);
 260     sr->probe_ping_task = GNUNET_SCHEDULER_NO_TASK;
 261   }
 262   GNUNET_FS_search_result_sync_ (sr);
 263   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 264               "Probe #%u for search result %p succeeded\n",
 265               sr->availability_trials,
 266               sr);
 267   signal_probe_result (sr);
 268 }
 269
 270
 271 /**
 272  * Notification of FS that a search probe has made progress.
 273  * This function is used INSTEAD of the client's event handler
 274  * for downloads where the #GNUNET_FS_DOWNLOAD_IS_PROBE flag is set.
 275  *
 276  * @param cls closure, always NULL (!), actual closure
 277  *        is in the client-context of the info struct
 278  * @param info details about the event, specifying the event type
 279  *        and various bits about the event
 280  * @return client-context (for the next progress call
 281  *         for this operation; should be set to NULL for
 282  *         SUSPEND and STOPPED events).  The value returned
 283  *         will be passed to future callbacks in the respective
 284  *         field in the `struct GNUNET_FS_ProgressInfo`.
 285  */
 286 void *
 287 GNUNET_FS_search_probe_progress_ (void *cls,
 288                                   const struct GNUNET_FS_ProgressInfo *info)
 289 {
 290   struct GNUNET_FS_SearchResult *sr = info->value.download.cctx;
 291   struct GNUNET_TIME_Relative dur;
 292
 293   switch (info->status)
 294   {
 295   case GNUNET_FS_STATUS_DOWNLOAD_START:
 296     /* ignore */
 297     break;
 298   case GNUNET_FS_STATUS_DOWNLOAD_RESUME:
 299     /* probes should never be resumed */
 300     GNUNET_assert (0);
 301     break;
 302   case GNUNET_FS_STATUS_DOWNLOAD_SUSPEND:
 303     /* probes should never be suspended */
 304     GNUNET_break (0);
 305     break;
 306   case GNUNET_FS_STATUS_DOWNLOAD_PROGRESS:
 307     /* ignore */
 308     break;
 309   case GNUNET_FS_STATUS_DOWNLOAD_ERROR:
 310     if (GNUNET_SCHEDULER_NO_TASK != sr->probe_cancel_task)
 311     {
 312       GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
 313       sr->probe_cancel_task = GNUNET_SCHEDULER_NO_TASK;
 314     }
 315     sr->probe_cancel_task =
 316         GNUNET_SCHEDULER_add_delayed (sr->remaining_probe_time,
 317                                       &probe_failure_handler, sr);
 318     break;
 319   case GNUNET_FS_STATUS_DOWNLOAD_COMPLETED:
 320     if (GNUNET_SCHEDULER_NO_TASK != sr->probe_cancel_task)
 321     {
 322       GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
 323       sr->probe_cancel_task = GNUNET_SCHEDULER_NO_TASK;
 324     }
 325     sr->probe_cancel_task =
 326         GNUNET_SCHEDULER_add_now (&probe_success_handler, sr);
 327     break;
 328   case GNUNET_FS_STATUS_DOWNLOAD_STOPPED:
 329     if (GNUNET_SCHEDULER_NO_TASK != sr->probe_cancel_task)
 330     {
 331       GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
 332       sr->probe_cancel_task = GNUNET_SCHEDULER_NO_TASK;
 333     }
 334     sr = NULL;
 335     break;
 336   case GNUNET_FS_STATUS_DOWNLOAD_ACTIVE:
 337     if (GNUNET_SCHEDULER_NO_TASK == sr->probe_cancel_task)
 338     {
 339       sr->probe_active_time = GNUNET_TIME_absolute_get ();
 340       sr->probe_cancel_task =
 341         GNUNET_SCHEDULER_add_delayed (sr->remaining_probe_time,
 342                                       &probe_failure_handler, sr);
 343     }
 344     break;
 345   case GNUNET_FS_STATUS_DOWNLOAD_INACTIVE:
 346     if (GNUNET_SCHEDULER_NO_TASK != sr->probe_cancel_task)
 347     {
 348       GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
 349       sr->probe_cancel_task = GNUNET_SCHEDULER_NO_TASK;
 350     }
 351     dur = GNUNET_TIME_absolute_get_duration (sr->probe_active_time);
 352     sr->remaining_probe_time =
 353         GNUNET_TIME_relative_subtract (sr->remaining_probe_time, dur);
 354     if (0 == sr->remaining_probe_time.rel_value_us)
 355       sr->probe_cancel_task =
 356         GNUNET_SCHEDULER_add_now (&probe_failure_handler, sr);
 357     GNUNET_FS_search_result_sync_ (sr);
 358     break;
 359   default:
 360     GNUNET_break (0);
 361     return NULL;
 362   }
 363   return sr;
 364 }
 365
 366
 367 /**
 368  * Task run periodically to remind clients that a probe is active.
 369  *
 370  * @param cls the 'struct GNUNET_FS_SearchResult' that we are probing for
 371  * @param tc scheduler context
 372  */
 373 static void
 374 probe_ping_task (void *cls,
 375                  const struct GNUNET_SCHEDULER_TaskContext *tc)
 376 {
 377   struct GNUNET_FS_SearchResult *sr = cls;
 378
 379   signal_probe_result (sr);
 380   sr->probe_ping_task
 381     = GNUNET_SCHEDULER_add_delayed (GNUNET_FS_PROBE_UPDATE_FREQUENCY,
 382                                     &probe_ping_task,
 383                                     sr);
 384 }
 385
 386
 387 /**
 388  * Start download probes for the given search result.
 389  *
 390  * @param sr the search result
 391  */
 392 void
 393 GNUNET_FS_search_start_probe_ (struct GNUNET_FS_SearchResult *sr)
 394 {
 395   uint64_t off;
 396   uint64_t len;
 397
 398   if (NULL != sr->probe_ctx)
 399     return;
 400   if (NULL != sr->download)
 401     return;
 402   if (0 == (sr->h->flags & GNUNET_FS_FLAGS_DO_PROBES))
 403     return;
 404   if (sr->availability_trials > AVAILABILITY_TRIALS_MAX)
 405     return;
 406   if ( (GNUNET_FS_URI_CHK != sr->uri->type) && (GNUNET_FS_URI_LOC != sr->uri->type))
 407     return;
 408   len = GNUNET_FS_uri_chk_get_file_size (sr->uri);
 409   if (0 == len)
 410     return;
 411   if ((len <= DBLOCK_SIZE) && (sr->availability_success > 0))
 412     return;
 413   off = len / DBLOCK_SIZE;
 414   if (off > 0)
 415     off = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, off);
 416   off *= DBLOCK_SIZE;
 417   if (len - off < DBLOCK_SIZE)
 418     len = len - off;
 419   else
 420     len = DBLOCK_SIZE;
 421   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 422               "Starting probe #%u (at offset %llu) for search result %p\n",
 423               sr->availability_trials + 1,
 424               (unsigned long long) off,
 425               sr);
 426   sr->remaining_probe_time =
 427       GNUNET_TIME_relative_multiply (sr->h->avg_block_latency,
 428                                      2 * (1 + sr->availability_trials));
 429   sr->probe_ctx =
 430       GNUNET_FS_download_start (sr->h, sr->uri, sr->meta, NULL, NULL, off,
 431                                 len, sr->anonymity,
 432                                 GNUNET_FS_DOWNLOAD_NO_TEMPORARIES |
 433                                 GNUNET_FS_DOWNLOAD_IS_PROBE, sr, NULL);
 434   sr->probe_ping_task
 435     = GNUNET_SCHEDULER_add_now (&probe_ping_task,
 436                                 sr);
 437 }
 438
 439
 440 /**
 441  * Start download probes for the given search result.
 442  *
 443  * @param h file-sharing handle to use for the operation
 444  * @param uri URI to probe
 445  * @param meta meta data associated with the URI
 446  * @param client_info client info pointer to use for associated events
 447  * @param anonymity anonymity level to use for the probes
 448  * @return the search result handle to access the probe activity
 449  */
 450 struct GNUNET_FS_SearchResult *
 451 GNUNET_FS_probe (struct GNUNET_FS_Handle *h,
 452                  const struct GNUNET_FS_Uri *uri,
 453                  const struct GNUNET_CONTAINER_MetaData *meta,
 454                  void *client_info,
 455                  uint32_t anonymity)
 456 {
 457   struct GNUNET_FS_SearchResult *sr;
 458
 459   GNUNET_assert (NULL != h);
 460   sr = GNUNET_new (struct GNUNET_FS_SearchResult);
 461   sr->h = h;
 462   sr->uri = GNUNET_FS_uri_dup (uri);
 463   sr->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
 464   sr->client_info = client_info;
 465   sr->anonymity = anonymity;
 466   GNUNET_FS_search_start_probe_ (sr);
 467   return sr;
 468 }
 469
 470
 471 /**
 472  * Stop probing activity associated with a search result.
 473  *
 474  * @param sr search result
 475  */
 476 static void
 477 GNUNET_FS_search_stop_probe_ (struct GNUNET_FS_SearchResult *sr)
 478 {
 479   if (NULL != sr->probe_ctx)
 480   {
 481     GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
 482     sr->probe_ctx = NULL;
 483   }
 484   if (GNUNET_SCHEDULER_NO_TASK != sr->probe_ping_task)
 485   {
 486     GNUNET_SCHEDULER_cancel (sr->probe_ping_task);
 487     sr->probe_ping_task = GNUNET_SCHEDULER_NO_TASK;
 488   }
 489   if (GNUNET_SCHEDULER_NO_TASK != sr->probe_cancel_task)
 490   {
 491     GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
 492     sr->probe_cancel_task = GNUNET_SCHEDULER_NO_TASK;
 493   }
 494 }
 495
 496
 497 /**
 498  * Stop probe activity.  Must ONLY be used on values
 499  * returned from #GNUNET_FS_probe.
 500  *
 501  * @param sr search result to stop probing for (freed)
 502  * @return the value of the 'client_info' pointer
 503  */
 504 void *
 505 GNUNET_FS_probe_stop (struct GNUNET_FS_SearchResult *sr)
 506 {
 507   void *client_info;
 508
 509   GNUNET_assert (NULL == sr->sc);
 510   GNUNET_FS_search_stop_probe_ (sr);
 511   GNUNET_FS_uri_destroy (sr->uri);
 512   GNUNET_CONTAINER_meta_data_destroy (sr->meta);
 513   client_info = sr->client_info;
 514   GNUNET_free (sr);
 515   return client_info;
 516 }
 517
 518
 519 /**
 520  * We have received a KSK result.  Check how it fits in with the
 521  * overall query and notify the client accordingly.
 522  *
 523  * @param sc context for the overall query
 524  * @param ent entry for the specific keyword
 525  * @param uri the URI that was found
 526  * @param meta metadata associated with the URI
 527  *        under the @a ent keyword
 528  */
 529 static void
 530 process_ksk_result (struct GNUNET_FS_SearchContext *sc,
 531                     struct SearchRequestEntry *ent,
 532                     const struct GNUNET_FS_Uri *uri,
 533                     const struct GNUNET_CONTAINER_MetaData *meta)
 534 {
 535   struct GNUNET_HashCode key;
 536   struct GNUNET_FS_SearchResult *sr;
 537   struct GetResultContext grc;
 538   int is_new;
 539   unsigned int koff;
 540
 541   /* check if new */
 542   GNUNET_assert (NULL != sc);
 543   GNUNET_FS_uri_to_key (uri, &key);
 544   if (GNUNET_SYSERR ==
 545       GNUNET_CONTAINER_multihashmap_get_multiple (ent->results, &key,
 546                                                   &test_result_present,
 547                                                   (void *) uri))
 548     return;                     /* duplicate result */
 549   /* try to find search result in master map */
 550   grc.sr = NULL;
 551   grc.uri = uri;
 552   GNUNET_CONTAINER_multihashmap_get_multiple (sc->master_result_map, &key,
 553                                               &get_result_present, &grc);
 554   sr = grc.sr;
 555   is_new = (NULL == sr) || (sr->mandatory_missing > 0);
 556   if (NULL == sr)
 557   {
 558     sr = GNUNET_new (struct GNUNET_FS_SearchResult);
 559     sr->h = sc->h;
 560     sr->sc = sc;
 561     sr->anonymity = sc->anonymity;
 562     sr->uri = GNUNET_FS_uri_dup (uri);
 563     sr->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
 564     sr->mandatory_missing = sc->mandatory_count;
 565     sr->key = key;
 566     sr->keyword_bitmap = GNUNET_malloc ((sc->uri->data.ksk.keywordCount + 7) / 8); /* round up, count bits */
 567     GNUNET_CONTAINER_multihashmap_put (sc->master_result_map, &key, sr,
 568                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 569   }
 570   else
 571   {
 572     GNUNET_CONTAINER_meta_data_merge (sr->meta, meta);
 573   }
 574   koff = ent - sc->requests;
 575   GNUNET_assert ( (ent >= sc->requests) && (koff < sc->uri->data.ksk.keywordCount));
 576   sr->keyword_bitmap[koff / 8] |= (1 << (koff % 8));
 577   /* check if mandatory satisfied */
 578   if (ent->mandatory)
 579     sr->mandatory_missing--;
 580   else
 581     sr->optional_support++;
 582   if (0 != sr->mandatory_missing)
 583     return;
 584   if (is_new)
 585     notify_client_chk_result (sc, sr);
 586   else
 587     notify_client_chk_update (sc, sr);
 588   GNUNET_FS_search_result_sync_ (sr);
 589   GNUNET_FS_search_start_probe_ (sr);
 590 }
 591
 592
 593 /**
 594  * Start search for content, internal API.
 595  *
 596  * @param h handle to the file sharing subsystem
 597  * @param uri specifies the search parameters; can be
 598  *        a KSK URI or an SKS URI.
 599  * @param anonymity desired level of anonymity
 600  * @param options options for the search
 601  * @param cctx client context
 602  * @param psearch parent search result (for namespace update searches)
 603  * @return context that can be used to control the search
 604  */
 605 static struct GNUNET_FS_SearchContext *
 606 search_start (struct GNUNET_FS_Handle *h, const struct GNUNET_FS_Uri *uri,
 607               uint32_t anonymity, enum GNUNET_FS_SearchOptions options,
 608               void *cctx, struct GNUNET_FS_SearchResult *psearch);
 609
 610
 611 /**
 612  * We have received an SKS result.  Start searching for updates and
 613  * notify the client if it is a new result.
 614  *
 615  * @param sc context for the overall query
 616  * @param id_update identifier for updates, NULL for none
 617  * @param uri the URI that was found
 618  * @param meta metadata associated with the URI
 619   */
 620 static void
 621 process_sks_result (struct GNUNET_FS_SearchContext *sc,
 622                     const char *id_update,
 623                     const struct GNUNET_FS_Uri *uri,
 624                     const struct GNUNET_CONTAINER_MetaData *meta)
 625 {
 626   struct GNUNET_FS_Uri uu;
 627   struct GNUNET_HashCode key;
 628   struct GNUNET_FS_SearchResult *sr;
 629
 630   /* check if new */
 631   GNUNET_assert (NULL != sc);
 632   GNUNET_FS_uri_to_key (uri, &key);
 633   GNUNET_CRYPTO_hash_xor (&uri->data.chk.chk.key, &uri->data.chk.chk.query,
 634                           &key);
 635   if (GNUNET_SYSERR ==
 636       GNUNET_CONTAINER_multihashmap_get_multiple (sc->master_result_map, &key,
 637                                                   &test_result_present,
 638                                                   (void *) uri))
 639     return;                     /* duplicate result */
 640   sr = GNUNET_new (struct GNUNET_FS_SearchResult);
 641   sr->h = sc->h;
 642   sr->sc = sc;
 643   sr->anonymity = sc->anonymity;
 644   sr->uri = GNUNET_FS_uri_dup (uri);
 645   sr->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
 646   sr->key = key;
 647   GNUNET_CONTAINER_multihashmap_put (sc->master_result_map, &key, sr,
 648                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 649   GNUNET_FS_search_result_sync_ (sr);
 650   GNUNET_FS_search_start_probe_ (sr);
 651   /* notify client */
 652   notify_client_chk_result (sc, sr);
 653   /* search for updates */
 654   if (0 == strlen (id_update))
 655     return;                     /* no updates */
 656   uu.type = GNUNET_FS_URI_SKS;
 657   uu.data.sks.ns = sc->uri->data.sks.ns;
 658   uu.data.sks.identifier = GNUNET_strdup (id_update);
 659   (void) search_start (sc->h, &uu, sc->anonymity, sc->options, NULL, sr);
 660   GNUNET_free (uu.data.sks.identifier);
 661 }
 662
 663
 664 /**
 665  * Decrypt a ublock using a 'keyword' as the passphrase.  Given the
 666  * KSK public key derived from the keyword, this function looks up
 667  * the original keyword in the search context and decrypts the
 668  * given ciphertext block.
 669  *
 670  * @param sc search context with the keywords
 671  * @param dpub derived public key used for the search
 672  * @param edata encrypted data
 673  * @param edata_size number of bytes in @a edata (and @a data)
 674  * @param data where to store the plaintext
 675  * @return keyword index on success, #GNUNET_SYSERR on error (no such
 676  *         keyword, internal error)
 677  */
 678 static int
 679 decrypt_block_with_keyword (const struct GNUNET_FS_SearchContext *sc,
 680                             const struct GNUNET_CRYPTO_EcdsaPublicKey *dpub,
 681                             const void *edata,
 682                             size_t edata_size,
 683                             char *data)
 684 {
 685   const struct GNUNET_CRYPTO_EcdsaPrivateKey *anon;
 686   struct GNUNET_CRYPTO_EcdsaPublicKey anon_pub;
 687   unsigned int i;
 688
 689   /* find key */
 690   for (i = 0; i < sc->uri->data.ksk.keywordCount; i++)
 691     if (0 == memcmp (dpub,
 692                      &sc->requests[i].dpub,
 693                      sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey)))
 694       break;
 695   if (i == sc->uri->data.ksk.keywordCount)
 696   {
 697     /* oops, does not match any of our keywords!? */
 698     GNUNET_break (0);
 699     return GNUNET_SYSERR;
 700   }
 701   /* decrypt */
 702   anon = GNUNET_CRYPTO_ecdsa_key_get_anonymous ();
 703   GNUNET_CRYPTO_ecdsa_key_get_public (anon, &anon_pub);
 704   GNUNET_FS_ublock_decrypt_ (edata, edata_size,
 705                              &anon_pub,
 706                              sc->requests[i].keyword,
 707                              data);
 708   return i;
 709 }
 710
 711
 712 /**
 713  * Process a keyword search result.  The actual type of block is
 714  * a UBlock; we know it is a keyword search result because that's
 715  * what we were searching for.
 716  *
 717  * @param sc our search context
 718  * @param ub the ublock with the keyword search result
 719  * @param size size of @a ub
 720  */
 721 static void
 722 process_kblock (struct GNUNET_FS_SearchContext *sc,
 723                 const struct UBlock *ub,
 724                 size_t size)
 725 {
 726   size_t j;
 727   char pt[size - sizeof (struct UBlock)];
 728   const char *eos;
 729   struct GNUNET_CONTAINER_MetaData *meta;
 730   struct GNUNET_FS_Uri *uri;
 731   char *emsg;
 732   int i;
 733
 734   if (-1 == (i = decrypt_block_with_keyword (sc,
 735                                              &ub->verification_key,
 736                                              &ub[1],
 737                                              size - sizeof (struct UBlock),
 738                                              pt)))
 739     return;
 740   /* parse; pt[0] is just '\0', so we skip over that */
 741   eos = memchr (&pt[1], '\0', sizeof (pt) - 1);
 742   if (NULL == eos)
 743   {
 744     GNUNET_break_op (0);
 745     return;
 746   }
 747   if (NULL == (uri = GNUNET_FS_uri_parse (&pt[1], &emsg)))
 748   {
 749     GNUNET_break_op (0);        /* ublock malformed */
 750     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 751                 _("Failed to parse URI `%s': %s\n"),
 752                 &pt[1],
 753                 emsg);
 754     GNUNET_free_non_null (emsg);
 755     return;
 756   }
 757   j = eos - pt + 1;
 758   if (sizeof (pt) == j)
 759     meta = GNUNET_CONTAINER_meta_data_create ();
 760   else
 761     meta = GNUNET_CONTAINER_meta_data_deserialize (&pt[j], sizeof (pt) - j);
 762   if (NULL == meta)
 763   {
 764     GNUNET_break_op (0);        /* ublock malformed */
 765     GNUNET_FS_uri_destroy (uri);
 766     return;
 767   }
 768   process_ksk_result (sc, &sc->requests[i], uri, meta);
 769
 770   /* clean up */
 771   GNUNET_CONTAINER_meta_data_destroy (meta);
 772   GNUNET_FS_uri_destroy (uri);
 773 }
 774
 775
 776 /**
 777  * Process a namespace-search result.  The actual type of block is
 778  * a UBlock; we know it is a namespace search result because that's
 779  * what we were searching for.
 780  *
 781  * @param sc our search context
 782  * @param ub the ublock with a namespace result
 783  * @param size size of @a ub
 784  */
 785 static void
 786 process_sblock (struct GNUNET_FS_SearchContext *sc,
 787                 const struct UBlock *ub,
 788                 size_t size)
 789 {
 790   size_t len = size - sizeof (struct UBlock);
 791   char pt[len];
 792   struct GNUNET_FS_Uri *uri;
 793   struct GNUNET_CONTAINER_MetaData *meta;
 794   const char *id;
 795   const char *uris;
 796   size_t off;
 797   char *emsg;
 798
 799   GNUNET_FS_ublock_decrypt_ (&ub[1], len,
 800                              &sc->uri->data.sks.ns,
 801                              sc->uri->data.sks.identifier,
 802                              pt);
 803   /* parse */
 804   if (0 == (off = GNUNET_STRINGS_buffer_tokenize (pt, len, 2, &id, &uris)))
 805   {
 806     GNUNET_break_op (0);        /* ublock malformed */
 807     return;
 808   }
 809   if (NULL == (meta = GNUNET_CONTAINER_meta_data_deserialize (&pt[off], len - off)))
 810   {
 811     GNUNET_break_op (0);        /* ublock malformed */
 812     return;
 813   }
 814   if (NULL == (uri = GNUNET_FS_uri_parse (uris, &emsg)))
 815   {
 816     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 817                 _("Failed to parse URI `%s': %s\n"),
 818                 uris, emsg);
 819     GNUNET_break_op (0);        /* ublock malformed */
 820     GNUNET_free_non_null (emsg);
 821     GNUNET_CONTAINER_meta_data_destroy (meta);
 822     return;
 823   }
 824   /* process */
 825   process_sks_result (sc, id, uri, meta);
 826   /* clean up */
 827   GNUNET_FS_uri_destroy (uri);
 828   GNUNET_CONTAINER_meta_data_destroy (meta);
 829 }
 830
 831
 832 /**
 833  * Process a search result.
 834  *
 835  * @param sc our search context
 836  * @param type type of the result
 837  * @param expiration when it will expire
 838  * @param data the (encrypted) response
 839  * @param size size of @a data
 840  */
 841 static void
 842 process_result (struct GNUNET_FS_SearchContext *sc,
 843                 enum GNUNET_BLOCK_Type type,
 844                 struct GNUNET_TIME_Absolute expiration,
 845                 const void *data,
 846                 size_t size)
 847 {
 848   if (GNUNET_TIME_absolute_get_duration (expiration).rel_value_us > 0)
 849   {
 850     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 851                 "Result received has already expired.\n");
 852     return;                     /* result expired */
 853   }
 854   switch (type)
 855   {
 856   case GNUNET_BLOCK_TYPE_FS_UBLOCK:
 857     if (GNUNET_FS_URI_SKS == sc->uri->type)
 858       process_sblock (sc, data, size);
 859     else
 860       process_kblock (sc, data, size);
 861     break;
 862   case GNUNET_BLOCK_TYPE_ANY:
 863     GNUNET_break (0);
 864     break;
 865   case GNUNET_BLOCK_TYPE_FS_DBLOCK:
 866     GNUNET_break (0);
 867     break;
 868   case GNUNET_BLOCK_TYPE_FS_ONDEMAND:
 869     GNUNET_break (0);
 870     break;
 871   case GNUNET_BLOCK_TYPE_FS_IBLOCK:
 872     GNUNET_break (0);
 873     break;
 874   default:
 875     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 876                 _("Got result with unknown block type `%d', ignoring"), type);
 877     break;
 878   }
 879 }
 880
 881
 882 /**
 883  * Shutdown any existing connection to the FS
 884  * service and try to establish a fresh one
 885  * (and then re-transmit our search request).
 886  *
 887  * @param sc the search to reconnec
 888  */
 889 static void
 890 try_reconnect (struct GNUNET_FS_SearchContext *sc);
 891
 892
 893 /**
 894  * Type of a function to call when we receive a message
 895  * from the service.
 896  *
 897  * @param cls closure
 898  * @param msg message received, NULL on timeout or fatal error
 899  */
 900 static void
 901 receive_results (void *cls, const struct GNUNET_MessageHeader *msg)
 902 {
 903   struct GNUNET_FS_SearchContext *sc = cls;
 904   const struct ClientPutMessage *cm;
 905   uint16_t msize;
 906
 907   if ((NULL == msg) || (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_FS_PUT) ||
 908       (ntohs (msg->size) <= sizeof (struct ClientPutMessage)))
 909   {
 910     try_reconnect (sc);
 911     return;
 912   }
 913   msize = ntohs (msg->size);
 914   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 915               "Receiving %u bytes of result from fs service\n", msize);
 916   cm = (const struct ClientPutMessage *) msg;
 917   process_result (sc, ntohl (cm->type),
 918                   GNUNET_TIME_absolute_ntoh (cm->expiration), &cm[1],
 919                   msize - sizeof (struct ClientPutMessage));
 920   /* continue receiving */
 921   GNUNET_CLIENT_receive (sc->client, &receive_results, sc,
 922                          GNUNET_TIME_UNIT_FOREVER_REL);
 923 }
 924
 925
 926 /**
 927  * Schedule the transmission of the (next) search request
 928  * to the service.
 929  *
 930  * @param sc context for the search
 931  */
 932 static void
 933 schedule_transmit_search_request (struct GNUNET_FS_SearchContext *sc);
 934
 935
 936 /**
 937  * Closure for 'build_result_set'.
 938  */
 939 struct MessageBuilderContext
 940 {
 941   /**
 942    * How many entries can we store to xoff.
 943    */
 944   unsigned int put_cnt;
 945
 946   /**
 947    * How many entries should we skip.
 948    */
 949   unsigned int skip_cnt;
 950
 951   /**
 952    * Where to store the keys.
 953    */
 954   struct GNUNET_HashCode *xoff;
 955
 956   /**
 957    * Search context we are iterating for.
 958    */
 959   struct GNUNET_FS_SearchContext *sc;
 960
 961   /**
 962    * Keyword offset the search result must match (0 for SKS)
 963    */
 964   unsigned int keyword_offset;
 965 };
 966
 967
 968 /**
 969  * Iterating over the known results, pick those matching the given
 970  * result range and store their keys at 'xoff'.
 971  *
 972  * @param cls the `struct MessageBuilderContext`
 973  * @param key key for a result
 974  * @param value the search result
 975  * @return #GNUNET_OK to continue iterating
 976  */
 977 static int
 978 build_result_set (void *cls, const struct GNUNET_HashCode * key, void *value)
 979 {
 980   struct MessageBuilderContext *mbc = cls;
 981   struct GNUNET_FS_SearchResult *sr = value;
 982
 983   if ( (NULL != sr->keyword_bitmap) &&
 984        (0 == (sr->keyword_bitmap[mbc->keyword_offset / 8] & (1 << (mbc->keyword_offset % 8)))) )
 985     return GNUNET_OK; /* have no match for this keyword yet */
 986   if (mbc->skip_cnt > 0)
 987   {
 988     mbc->skip_cnt--;
 989     return GNUNET_OK;
 990   }
 991   if (0 == mbc->put_cnt)
 992     return GNUNET_SYSERR;
 993   mbc->sc->search_request_map_offset++;
 994   mbc->xoff[--mbc->put_cnt] = *key;
 995
 996   return GNUNET_OK;
 997 }
 998
 999
1000 /**
1001  * Iterating over the known results, count those
1002  * matching the given result range and increment
1003  * put count for each.
1004  *
1005  * @param cls the `struct MessageBuilderContext`
1006  * @param key key for a result
1007  * @param value the search result
1008  * @return #GNUNET_OK to continue iterating
1009  */
1010 static int
1011 find_result_set (void *cls, const struct GNUNET_HashCode * key, void *value)
1012 {
1013   struct MessageBuilderContext *mbc = cls;
1014   struct GNUNET_FS_SearchResult *sr = value;
1015
1016   if ( (NULL != sr->keyword_bitmap) &&
1017        (0 == (sr->keyword_bitmap[mbc->keyword_offset / 8] & (1 << (mbc->keyword_offset % 8)))) )
1018     return GNUNET_OK; /* have no match for this keyword yet */
1019   mbc->put_cnt++;
1020   return GNUNET_OK;
1021 }
1022
1023
1024 /**
1025  * We're ready to transmit the search request to the
1026  * file-sharing service.  Do it.
1027  *
1028  * @param cls closure
1029  * @param size number of bytes available in @a buf
1030  * @param buf where the callee should write the message
1031  * @return number of bytes written to @a buf
1032  */
1033 static size_t
1034 transmit_search_request (void *cls, size_t size, void *buf)
1035 {
1036   struct GNUNET_FS_SearchContext *sc = cls;
1037   struct MessageBuilderContext mbc;
1038   size_t msize;
1039   struct SearchMessage *sm;
1040   struct GNUNET_CRYPTO_EcdsaPublicKey dpub;
1041   unsigned int sqms;
1042   uint32_t options;
1043
1044   if (NULL == buf)
1045   {
1046     try_reconnect (sc);
1047     return 0;
1048   }
1049   mbc.sc = sc;
1050   mbc.skip_cnt = sc->search_request_map_offset;
1051   sm = buf;
1052   sm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_START_SEARCH);
1053   mbc.xoff = (struct GNUNET_HashCode *) & sm[1];
1054   options = SEARCH_MESSAGE_OPTION_NONE;
1055   if (0 != (sc->options & GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY))
1056     options |= SEARCH_MESSAGE_OPTION_LOOPBACK_ONLY;
1057   if (GNUNET_FS_uri_test_ksk (sc->uri))
1058   {
1059     msize = sizeof (struct SearchMessage);
1060     GNUNET_assert (size >= msize);
1061     mbc.keyword_offset = sc->keyword_offset;
1062     /* calculate total number of known results (in put_cnt => sqms) */
1063     mbc.put_cnt = 0;
1064     GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1065                                            &find_result_set, &mbc);
1066     sqms = mbc.put_cnt;
1067     /* calculate how many results we can send in this message */
1068     mbc.put_cnt = (size - msize) / sizeof (struct GNUNET_HashCode);
1069     mbc.put_cnt = GNUNET_MIN (mbc.put_cnt, sqms - mbc.skip_cnt);
1070     if (sc->search_request_map_offset < sqms)
1071       GNUNET_assert (mbc.put_cnt > 0);
1072
1073     /* now build message */
1074     msize += sizeof (struct GNUNET_HashCode) * mbc.put_cnt;
1075     sm->header.size = htons (msize);
1076     sm->type = htonl (GNUNET_BLOCK_TYPE_FS_UBLOCK);
1077     sm->anonymity_level = htonl (sc->anonymity);
1078     memset (&sm->target, 0, sizeof (struct GNUNET_PeerIdentity));
1079     sm->query = sc->requests[sc->keyword_offset].uquery;
1080     GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1081                                            &build_result_set, &mbc);
1082     GNUNET_assert (sqms >= sc->search_request_map_offset);
1083     if (sqms != sc->search_request_map_offset)
1084     {
1085       /* more requesting to be done... */
1086       sm->options = htonl (options | SEARCH_MESSAGE_OPTION_CONTINUED);
1087       schedule_transmit_search_request (sc);
1088       return msize;
1089     }
1090     sm->options = htonl (options);
1091     sc->keyword_offset++;
1092     if (sc->uri->data.ksk.keywordCount != sc->keyword_offset)
1093     {
1094       /* more requesting to be done... */
1095       schedule_transmit_search_request (sc);
1096       return msize;
1097     }
1098   }
1099   else
1100   {
1101     GNUNET_assert (GNUNET_FS_uri_test_sks (sc->uri));
1102     msize = sizeof (struct SearchMessage);
1103     GNUNET_assert (size >= msize);
1104     sm->type = htonl (GNUNET_BLOCK_TYPE_FS_UBLOCK);
1105     sm->anonymity_level = htonl (sc->anonymity);
1106     memset (&sm->target, 0, sizeof (struct GNUNET_PeerIdentity));
1107     GNUNET_CRYPTO_ecdsa_public_key_derive (&sc->uri->data.sks.ns,
1108                                          sc->uri->data.sks.identifier,
1109                                          "fs-ublock",
1110                                          &dpub);
1111     GNUNET_CRYPTO_hash (&dpub,
1112                         sizeof (dpub),
1113                         &sm->query);
1114     mbc.put_cnt = (size - msize) / sizeof (struct GNUNET_HashCode);
1115     sqms = GNUNET_CONTAINER_multihashmap_size (sc->master_result_map);
1116     mbc.put_cnt = GNUNET_MIN (mbc.put_cnt, sqms - mbc.skip_cnt);
1117     mbc.keyword_offset = 0;
1118     if (sc->search_request_map_offset < sqms)
1119       GNUNET_assert (mbc.put_cnt > 0);
1120     msize += sizeof (struct GNUNET_HashCode) * mbc.put_cnt;
1121     GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1122                                            &build_result_set, &mbc);
1123     sm->header.size = htons (msize);
1124     GNUNET_assert (sqms >= sc->search_request_map_offset);
1125     if (sqms != sc->search_request_map_offset)
1126     {
1127       /* more requesting to be done... */
1128       sm->options = htonl (options | SEARCH_MESSAGE_OPTION_CONTINUED);
1129       schedule_transmit_search_request (sc);
1130       return msize;
1131     }
1132     sm->options = htonl (options);
1133   }
1134   GNUNET_CLIENT_receive (sc->client, &receive_results, sc,
1135                          GNUNET_TIME_UNIT_FOREVER_REL);
1136   return msize;
1137 }
1138
1139
1140 /**
1141  * Schedule the transmission of the (next) search request
1142  * to the service.
1143  *
1144  * @param sc context for the search
1145  */
1146 static void
1147 schedule_transmit_search_request (struct GNUNET_FS_SearchContext *sc)
1148 {
1149   size_t size;
1150   unsigned int sqms;
1151   unsigned int fit;
1152
1153   size = sizeof (struct SearchMessage);
1154   sqms =
1155       GNUNET_CONTAINER_multihashmap_size (sc->master_result_map) -
1156       sc->search_request_map_offset;
1157   fit = (GNUNET_SERVER_MAX_MESSAGE_SIZE - 1 - size) / sizeof (struct GNUNET_HashCode);
1158   fit = GNUNET_MIN (fit, sqms);
1159   size += sizeof (struct GNUNET_HashCode) * fit;
1160   GNUNET_CLIENT_notify_transmit_ready (sc->client, size,
1161                                        GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1162                                        GNUNET_NO, &transmit_search_request, sc);
1163
1164 }
1165
1166
1167 /**
1168  * Reconnect to the FS service and transmit
1169  * our queries NOW.
1170  *
1171  * @param cls our search context
1172  * @param tc unused
1173  */
1174 static void
1175 do_reconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1176 {
1177   struct GNUNET_FS_SearchContext *sc = cls;
1178   struct GNUNET_CLIENT_Connection *client;
1179
1180   sc->task = GNUNET_SCHEDULER_NO_TASK;
1181   client = GNUNET_CLIENT_connect ("fs", sc->h->cfg);
1182   if (NULL == client)
1183   {
1184     try_reconnect (sc);
1185     return;
1186   }
1187   sc->client = client;
1188   sc->search_request_map_offset = 0;
1189   sc->keyword_offset = 0;
1190   schedule_transmit_search_request (sc);
1191 }
1192
1193
1194 /**
1195  * Shutdown any existing connection to the FS
1196  * service and try to establish a fresh one
1197  * (and then re-transmit our search request).
1198  *
1199  * @param sc the search to reconnec
1200  */
1201 static void
1202 try_reconnect (struct GNUNET_FS_SearchContext *sc)
1203 {
1204   if (NULL != sc->client)
1205   {
1206     GNUNET_CLIENT_disconnect (sc->client);
1207     sc->client = NULL;
1208   }
1209   sc->reconnect_backoff = GNUNET_TIME_STD_BACKOFF (sc->reconnect_backoff);
1210   sc->task =
1211       GNUNET_SCHEDULER_add_delayed (sc->reconnect_backoff,
1212                                     &do_reconnect,
1213                                     sc);
1214 }
1215
1216
1217 /**
1218  * Start search for content, internal API.
1219  *
1220  * @param h handle to the file sharing subsystem
1221  * @param uri specifies the search parameters; can be
1222  *        a KSK URI or an SKS URI.
1223  * @param anonymity desired level of anonymity
1224  * @param options options for the search
1225  * @param cctx initial value for the client context
1226  * @param psearch parent search result (for namespace update searches)
1227  * @return context that can be used to control the search
1228  */
1229 static struct GNUNET_FS_SearchContext *
1230 search_start (struct GNUNET_FS_Handle *h,
1231               const struct GNUNET_FS_Uri *uri,
1232               uint32_t anonymity,
1233               enum GNUNET_FS_SearchOptions options,
1234               void *cctx,
1235               struct GNUNET_FS_SearchResult *psearch)
1236 {
1237   struct GNUNET_FS_SearchContext *sc;
1238   struct GNUNET_FS_ProgressInfo pi;
1239
1240   sc = GNUNET_new (struct GNUNET_FS_SearchContext);
1241   sc->h = h;
1242   sc->options = options;
1243   sc->uri = GNUNET_FS_uri_dup (uri);
1244   sc->anonymity = anonymity;
1245   sc->start_time = GNUNET_TIME_absolute_get ();
1246   if (NULL != psearch)
1247   {
1248     sc->psearch_result = psearch;
1249     psearch->update_search = sc;
1250   }
1251   sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16, GNUNET_NO);
1252   sc->client_info = cctx;
1253   if (GNUNET_OK != GNUNET_FS_search_start_searching_ (sc))
1254   {
1255     GNUNET_FS_uri_destroy (sc->uri);
1256     GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
1257     GNUNET_free (sc);
1258     return NULL;
1259   }
1260   GNUNET_FS_search_sync_ (sc);
1261   pi.status = GNUNET_FS_STATUS_SEARCH_START;
1262   sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
1263   return sc;
1264 }
1265
1266
1267 /**
1268  * Build the request and actually initiate the search using the
1269  * GNUnet FS service.
1270  *
1271  * @param sc search context
1272  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1273  */
1274 int
1275 GNUNET_FS_search_start_searching_ (struct GNUNET_FS_SearchContext *sc)
1276 {
1277   unsigned int i;
1278   const char *keyword;
1279   const struct GNUNET_CRYPTO_EcdsaPrivateKey *anon;
1280   struct GNUNET_CRYPTO_EcdsaPublicKey anon_pub;
1281   struct SearchRequestEntry *sre;
1282
1283   GNUNET_assert (NULL == sc->client);
1284   if (GNUNET_FS_uri_test_ksk (sc->uri))
1285   {
1286     GNUNET_assert (0 != sc->uri->data.ksk.keywordCount);
1287     anon = GNUNET_CRYPTO_ecdsa_key_get_anonymous ();
1288     GNUNET_CRYPTO_ecdsa_key_get_public (anon, &anon_pub);
1289     sc->requests =
1290         GNUNET_malloc (sizeof (struct SearchRequestEntry) *
1291                        sc->uri->data.ksk.keywordCount);
1292     for (i = 0; i < sc->uri->data.ksk.keywordCount; i++)
1293     {
1294       keyword = &sc->uri->data.ksk.keywords[i][1];
1295       sre = &sc->requests[i];
1296       sre->keyword = GNUNET_strdup (keyword);
1297       GNUNET_CRYPTO_ecdsa_public_key_derive (&anon_pub,
1298                                            keyword,
1299                                            "fs-ublock",
1300                                            &sre->dpub);
1301       GNUNET_CRYPTO_hash (&sre->dpub,
1302                           sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey),
1303                           &sre->uquery);
1304       sre->mandatory = (sc->uri->data.ksk.keywords[i][0] == '+');
1305       if (sre->mandatory)
1306         sc->mandatory_count++;
1307       sre->results = GNUNET_CONTAINER_multihashmap_create (4, GNUNET_NO);
1308     }
1309   }
1310   sc->client = GNUNET_CLIENT_connect ("fs", sc->h->cfg);
1311   if (NULL == sc->client)
1312     return GNUNET_SYSERR;
1313   schedule_transmit_search_request (sc);
1314   return GNUNET_OK;
1315 }
1316
1317
1318 /**
1319  * Freeze probes for the given search result.
1320  *
1321  * @param cls the global FS handle
1322  * @param key the key for the search result (unused)
1323  * @param value the search result to free
1324  * @return #GNUNET_OK
1325  */
1326 static int
1327 search_result_freeze_probes (void *cls,
1328                              const struct GNUNET_HashCode *key,
1329                              void *value)
1330 {
1331   struct GNUNET_FS_SearchResult *sr = value;
1332
1333   if (NULL != sr->probe_ctx)
1334   {
1335     GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
1336     sr->probe_ctx = NULL;
1337   }
1338   if (GNUNET_SCHEDULER_NO_TASK != sr->probe_ping_task)
1339   {
1340     GNUNET_SCHEDULER_cancel (sr->probe_ping_task);
1341     sr->probe_ping_task = GNUNET_SCHEDULER_NO_TASK;
1342   }
1343   if (GNUNET_SCHEDULER_NO_TASK != sr->probe_cancel_task)
1344   {
1345     GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
1346     sr->probe_cancel_task = GNUNET_SCHEDULER_NO_TASK;
1347   }
1348   if (NULL != sr->update_search)
1349     GNUNET_FS_search_pause (sr->update_search);
1350   return GNUNET_OK;
1351 }
1352
1353
1354 /**
1355  * Resume probes for the given search result.
1356  *
1357  * @param cls the global FS handle
1358  * @param key the key for the search result (unused)
1359  * @param value the search result to free
1360  * @return #GNUNET_OK
1361  */
1362 static int
1363 search_result_resume_probes (void *cls,
1364                              const struct GNUNET_HashCode * key,
1365                              void *value)
1366 {
1367   struct GNUNET_FS_SearchResult *sr = value;
1368
1369   GNUNET_FS_search_start_probe_ (sr);
1370   if (NULL != sr->update_search)
1371     GNUNET_FS_search_continue (sr->update_search);
1372   return GNUNET_OK;
1373 }
1374
1375
1376 /**
1377  * Signal suspend and free the given search result.
1378  *
1379  * @param cls the global FS handle
1380  * @param key the key for the search result (unused)
1381  * @param value the search result to free
1382  * @return #GNUNET_OK
1383  */
1384 static int
1385 search_result_suspend (void *cls,
1386                        const struct GNUNET_HashCode * key,
1387                        void *value)
1388 {
1389   struct GNUNET_FS_SearchContext *sc = cls;
1390   struct GNUNET_FS_SearchResult *sr = value;
1391   struct GNUNET_FS_ProgressInfo pi;
1392
1393   if (NULL != sr->download)
1394   {
1395     GNUNET_FS_download_signal_suspend_ (sr->download);
1396     sr->download = NULL;
1397   }
1398   if (NULL != sr->update_search)
1399   {
1400     GNUNET_FS_search_signal_suspend_ (sr->update_search);
1401     sr->update_search = NULL;
1402   }
1403   GNUNET_FS_search_stop_probe_ (sr);
1404   pi.status = GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND;
1405   pi.value.search.specifics.result_suspend.cctx = sr->client_info;
1406   pi.value.search.specifics.result_suspend.meta = sr->meta;
1407   pi.value.search.specifics.result_suspend.uri = sr->uri;
1408   sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
1409   GNUNET_break (NULL == sr->client_info);
1410   GNUNET_free_non_null (sr->serialization);
1411   GNUNET_FS_uri_destroy (sr->uri);
1412   GNUNET_CONTAINER_meta_data_destroy (sr->meta);
1413   GNUNET_free_non_null (sr->keyword_bitmap);
1414   GNUNET_free (sr);
1415   return GNUNET_OK;
1416 }
1417
1418
1419 /**
1420  * Create SUSPEND event for the given search operation
1421  * and then clean up our state (without stop signal).
1422  *
1423  * @param cls the `struct GNUNET_FS_SearchContext` to signal for
1424  */
1425 void
1426 GNUNET_FS_search_signal_suspend_ (void *cls)
1427 {
1428   struct GNUNET_FS_SearchContext *sc = cls;
1429   struct GNUNET_FS_ProgressInfo pi;
1430   unsigned int i;
1431
1432   GNUNET_FS_end_top (sc->h, sc->top);
1433   GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1434                                          &search_result_suspend, sc);
1435   pi.status = GNUNET_FS_STATUS_SEARCH_SUSPEND;
1436   sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
1437   GNUNET_break (NULL == sc->client_info);
1438   if (sc->task != GNUNET_SCHEDULER_NO_TASK)
1439   {
1440     GNUNET_SCHEDULER_cancel (sc->task);
1441     sc->task = GNUNET_SCHEDULER_NO_TASK;
1442   }
1443   if (NULL != sc->client)
1444   {
1445     GNUNET_CLIENT_disconnect (sc->client);
1446     sc->client = NULL;
1447   }
1448   GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
1449   if (NULL != sc->requests)
1450   {
1451     GNUNET_assert (GNUNET_FS_uri_test_ksk (sc->uri));
1452     for (i = 0; i < sc->uri->data.ksk.keywordCount; i++)
1453     {
1454       GNUNET_CONTAINER_multihashmap_destroy (sc->requests[i].results);
1455       GNUNET_free (sc->requests[i].keyword);
1456     }
1457   }
1458   GNUNET_free_non_null (sc->requests);
1459   GNUNET_free_non_null (sc->emsg);
1460   GNUNET_FS_uri_destroy (sc->uri);
1461   GNUNET_free_non_null (sc->serialization);
1462   GNUNET_free (sc);
1463 }
1464
1465
1466 /**
1467  * Start search for content.
1468  *
1469  * @param h handle to the file sharing subsystem
1470  * @param uri specifies the search parameters; can be
1471  *        a KSK URI or an SKS URI.
1472  * @param anonymity desired level of anonymity
1473  * @param options options for the search
1474  * @param cctx initial value for the client context
1475  * @return context that can be used to control the search
1476  */
1477 struct GNUNET_FS_SearchContext *
1478 GNUNET_FS_search_start (struct GNUNET_FS_Handle *h,
1479                         const struct GNUNET_FS_Uri *uri, uint32_t anonymity,
1480                         enum GNUNET_FS_SearchOptions options, void *cctx)
1481 {
1482   struct GNUNET_FS_SearchContext *ret;
1483
1484   ret = search_start (h, uri, anonymity, options, cctx, NULL);
1485   if (NULL == ret)
1486     return NULL;
1487   ret->top = GNUNET_FS_make_top (h, &GNUNET_FS_search_signal_suspend_, ret);
1488   return ret;
1489 }
1490
1491
1492 /**
1493  * Pause search.
1494  *
1495  * @param sc context for the search that should be paused
1496  */
1497 void
1498 GNUNET_FS_search_pause (struct GNUNET_FS_SearchContext *sc)
1499 {
1500   struct GNUNET_FS_ProgressInfo pi;
1501
1502   if (GNUNET_SCHEDULER_NO_TASK != sc->task)
1503   {
1504     GNUNET_SCHEDULER_cancel (sc->task);
1505     sc->task = GNUNET_SCHEDULER_NO_TASK;
1506   }
1507   if (NULL != sc->client)
1508     GNUNET_CLIENT_disconnect (sc->client);
1509   sc->client = NULL;
1510   GNUNET_FS_search_sync_ (sc);
1511   GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1512                                          &search_result_freeze_probes, sc);
1513   pi.status = GNUNET_FS_STATUS_SEARCH_PAUSED;
1514   sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
1515 }
1516
1517
1518 /**
1519  * Continue paused search.
1520  *
1521  * @param sc context for the search that should be resumed
1522  */
1523 void
1524 GNUNET_FS_search_continue (struct GNUNET_FS_SearchContext *sc)
1525 {
1526   struct GNUNET_FS_ProgressInfo pi;
1527
1528   GNUNET_assert (NULL == sc->client);
1529   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == sc->task);
1530   do_reconnect (sc, NULL);
1531   GNUNET_FS_search_sync_ (sc);
1532   pi.status = GNUNET_FS_STATUS_SEARCH_CONTINUED;
1533   sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
1534   GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1535                                          &search_result_resume_probes, sc);
1536 }
1537
1538
1539 /**
1540  * Signal stop for the given search result.
1541  *
1542  * @param cls the global FS handle
1543  * @param key the key for the search result (unused)
1544  * @param value the search result to free
1545  * @return #GNUNET_OK
1546  */
1547 static int
1548 search_result_stop (void *cls,
1549                     const struct GNUNET_HashCode *key,
1550                     void *value)
1551 {
1552   struct GNUNET_FS_SearchContext *sc = cls;
1553   struct GNUNET_FS_SearchResult *sr = value;
1554   struct GNUNET_FS_ProgressInfo pi;
1555
1556   GNUNET_FS_search_stop_probe_ (sr);
1557   if (NULL != sr->download)
1558   {
1559     sr->download->search = NULL;
1560     sr->download->top =
1561         GNUNET_FS_make_top (sr->download->h,
1562                             &GNUNET_FS_download_signal_suspend_, sr->download);
1563     if (NULL != sr->download->serialization)
1564     {
1565       GNUNET_FS_remove_sync_file_ (sc->h, GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD,
1566                                    sr->download->serialization);
1567       GNUNET_free (sr->download->serialization);
1568       sr->download->serialization = NULL;
1569     }
1570     pi.status = GNUNET_FS_STATUS_DOWNLOAD_LOST_PARENT;
1571     GNUNET_FS_download_make_status_ (&pi, sr->download);
1572     GNUNET_FS_download_sync_ (sr->download);
1573     sr->download = NULL;
1574   }
1575   pi.status = GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED;
1576   pi.value.search.specifics.result_stopped.cctx = sr->client_info;
1577   pi.value.search.specifics.result_stopped.meta = sr->meta;
1578   pi.value.search.specifics.result_stopped.uri = sr->uri;
1579   sr->client_info = GNUNET_FS_search_make_status_ (&pi, sr->h, sc);
1580   return GNUNET_OK;
1581 }
1582
1583
1584 /**
1585  * Free the given search result.
1586  *
1587  * @param cls the global FS handle
1588  * @param key the key for the search result (unused)
1589  * @param value the search result to free
1590  * @return #GNUNET_OK
1591  */
1592 static int
1593 search_result_free (void *cls,
1594                     const struct GNUNET_HashCode *key,
1595                     void *value)
1596 {
1597   struct GNUNET_FS_SearchResult *sr = value;
1598
1599   if (NULL != sr->update_search)
1600   {
1601     GNUNET_FS_search_stop (sr->update_search);
1602     GNUNET_assert (NULL == sr->update_search);
1603   }
1604   GNUNET_break (NULL == sr->probe_ctx);
1605   GNUNET_break (GNUNET_SCHEDULER_NO_TASK == sr->probe_cancel_task);
1606   GNUNET_break (GNUNET_SCHEDULER_NO_TASK == sr->probe_ping_task);
1607   GNUNET_break (NULL == sr->client_info);
1608   GNUNET_free_non_null (sr->serialization);
1609   GNUNET_FS_uri_destroy (sr->uri);
1610   GNUNET_CONTAINER_meta_data_destroy (sr->meta);
1611   GNUNET_free_non_null (sr->keyword_bitmap);
1612   GNUNET_free (sr);
1613   return GNUNET_OK;
1614 }
1615
1616
1617 /**
1618  * Stop search for content.
1619  *
1620  * @param sc context for the search that should be stopped
1621  */
1622 void
1623 GNUNET_FS_search_stop (struct GNUNET_FS_SearchContext *sc)
1624 {
1625   struct GNUNET_FS_ProgressInfo pi;
1626   unsigned int i;
1627
1628   if (NULL != sc->top)
1629     GNUNET_FS_end_top (sc->h, sc->top);
1630   GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1631                                          &search_result_stop, sc);
1632   if (NULL != sc->psearch_result)
1633     sc->psearch_result->update_search = NULL;
1634   if (NULL != sc->serialization)
1635   {
1636     GNUNET_FS_remove_sync_file_ (sc->h,
1637                                  (sc->psearch_result !=
1638                                   NULL) ? GNUNET_FS_SYNC_PATH_CHILD_SEARCH :
1639                                  GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
1640                                  sc->serialization);
1641     GNUNET_FS_remove_sync_dir_ (sc->h,
1642                                 (sc->psearch_result !=
1643                                  NULL) ? GNUNET_FS_SYNC_PATH_CHILD_SEARCH :
1644                                 GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
1645                                 sc->serialization);
1646     GNUNET_free (sc->serialization);
1647   }
1648   pi.status = GNUNET_FS_STATUS_SEARCH_STOPPED;
1649   sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
1650   GNUNET_break (NULL == sc->client_info);
1651   if (GNUNET_SCHEDULER_NO_TASK != sc->task)
1652     GNUNET_SCHEDULER_cancel (sc->task);
1653   if (NULL != sc->client)
1654     GNUNET_CLIENT_disconnect (sc->client);
1655   GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1656                                          &search_result_free, sc);
1657   GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
1658   if (NULL != sc->requests)
1659   {
1660     GNUNET_assert (GNUNET_FS_uri_test_ksk (sc->uri));
1661     for (i = 0; i < sc->uri->data.ksk.keywordCount; i++)
1662       GNUNET_CONTAINER_multihashmap_destroy (sc->requests[i].results);
1663   }
1664   GNUNET_free_non_null (sc->requests);
1665   GNUNET_free_non_null (sc->emsg);
1666   GNUNET_FS_uri_destroy (sc->uri);
1667   GNUNET_free (sc);
1668 }
1669
1670 /* end of fs_search.c */