2 This file is part of GNUnet.
3 Copyright (C) 2001-2014 GNUnet e.V.
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.
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.
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 02110-1301, USA.
21 * @file fs/fs_search.c
22 * @brief Helper functions for searching.
23 * @author Christian Grothoff
26 #include "gnunet_constants.h"
27 #include "gnunet_fs_service.h"
28 #include "gnunet_protocols.h"
30 #include "fs_publish_ublock.h"
34 * Number of availability trials we perform per search result.
36 #define AVAILABILITY_TRIALS_MAX 8
39 * Fill in all of the generic fields for a search event and
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
48 GNUNET_FS_search_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
49 struct GNUNET_FS_Handle *h,
50 struct GNUNET_FS_SearchContext *sc)
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))
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;
66 ret = h->upcb (h->upcb_cls, pi);
72 * Check if the given result is identical to the given URI.
74 * @param cls points to the URI we check against
76 * @param value a `struct GNUNET_FS_SearchResult` who's URI we
78 * @return #GNUNET_SYSERR if the result is present,
79 * #GNUNET_OK otherwise
82 test_result_present (void *cls,
83 const struct GNUNET_HashCode * key,
86 const struct GNUNET_FS_Uri *uri = cls;
87 struct GNUNET_FS_SearchResult *sr = value;
89 if (GNUNET_FS_uri_test_equal (uri, sr->uri))
96 * We've found a new CHK result. Let the client
99 * @param sc the search context
100 * @param sr the specific result
103 notify_client_chk_result (struct GNUNET_FS_SearchContext *sc,
104 struct GNUNET_FS_SearchResult *sr)
106 struct GNUNET_FS_ProgressInfo pi;
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);
118 * We've found new information about an existing CHK result. Let the
119 * client know about it.
121 * @param sc the search context
122 * @param sr the specific result
125 notify_client_chk_update (struct GNUNET_FS_SearchContext *sc,
126 struct GNUNET_FS_SearchResult *sr)
128 struct GNUNET_FS_ProgressInfo pi;
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);
146 * Context for "get_result_present".
148 struct GetResultContext
151 * The URI we're looking for.
153 const struct GNUNET_FS_Uri *uri;
156 * Where to store a pointer to the search
157 * result struct if we found a match.
159 struct GNUNET_FS_SearchResult *sr;
164 * Check if the given result is identical to the given URI and if so
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
174 get_result_present (void *cls,
175 const struct GNUNET_HashCode *key,
178 struct GetResultContext *grc = cls;
179 struct GNUNET_FS_SearchResult *sr = value;
181 if (GNUNET_FS_uri_test_equal (grc->uri, sr->uri))
188 * Signal result of last probe to client and then schedule next
191 * @param sr search result to signal for
194 signal_probe_result (struct GNUNET_FS_SearchResult *sr)
196 struct GNUNET_FS_ProgressInfo pi;
198 pi.status = GNUNET_FS_STATUS_SEARCH_UPDATE;
199 pi.value.search.specifics.update.cctx = sr->client_info;
200 pi.value.search.specifics.update.meta = sr->meta;
201 pi.value.search.specifics.update.uri = sr->uri;
202 pi.value.search.specifics.update.availability_rank
203 = 2 * sr->availability_success - sr->availability_trials;
204 pi.value.search.specifics.update.availability_certainty
205 = sr->availability_trials;
206 pi.value.search.specifics.update.applicability_rank = sr->optional_support;
207 pi.value.search.specifics.update.current_probe_time
208 = GNUNET_TIME_absolute_get_duration (sr->probe_active_time);
209 sr->client_info = GNUNET_FS_search_make_status_ (&pi, sr->h, sr->sc);
210 GNUNET_FS_search_start_probe_ (sr);
215 * Handle the case where we have failed to receive a response for our probe.
217 * @param cls our `struct GNUNET_FS_SearchResult *`
220 probe_failure_handler (void *cls)
222 struct GNUNET_FS_SearchResult *sr = cls;
224 sr->probe_cancel_task = NULL;
225 sr->availability_trials++;
226 GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
227 sr->probe_ctx = NULL;
228 GNUNET_FS_stop_probe_ping_task_ (sr);
229 GNUNET_FS_search_result_sync_ (sr);
230 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
231 "Probe #%u for search result %p failed\n",
232 sr->availability_trials,
234 signal_probe_result (sr);
239 * Handle the case where we have gotten a response for our probe.
241 * @param cls our `struct GNUNET_FS_SearchResult *`
244 probe_success_handler (void *cls)
246 struct GNUNET_FS_SearchResult *sr = cls;
248 sr->probe_cancel_task = NULL;
249 sr->availability_trials++;
250 sr->availability_success++;
251 GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
252 sr->probe_ctx = NULL;
253 GNUNET_FS_stop_probe_ping_task_ (sr);
254 GNUNET_FS_search_result_sync_ (sr);
255 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
256 "Probe #%u for search result %p succeeded\n",
257 sr->availability_trials,
259 signal_probe_result (sr);
264 * Notification of FS that a search probe has made progress.
265 * This function is used INSTEAD of the client's event handler
266 * for downloads where the #GNUNET_FS_DOWNLOAD_IS_PROBE flag is set.
268 * @param cls closure, always NULL (!), actual closure
269 * is in the client-context of the info struct
270 * @param info details about the event, specifying the event type
271 * and various bits about the event
272 * @return client-context (for the next progress call
273 * for this operation; should be set to NULL for
274 * SUSPEND and STOPPED events). The value returned
275 * will be passed to future callbacks in the respective
276 * field in the `struct GNUNET_FS_ProgressInfo`.
279 GNUNET_FS_search_probe_progress_ (void *cls,
280 const struct GNUNET_FS_ProgressInfo *info)
282 struct GNUNET_FS_SearchResult *sr = info->value.download.cctx;
283 struct GNUNET_TIME_Relative dur;
285 switch (info->status)
287 case GNUNET_FS_STATUS_DOWNLOAD_START:
290 case GNUNET_FS_STATUS_DOWNLOAD_RESUME:
291 /* probes should never be resumed */
294 case GNUNET_FS_STATUS_DOWNLOAD_SUSPEND:
295 /* probes should never be suspended */
298 case GNUNET_FS_STATUS_DOWNLOAD_PROGRESS:
301 case GNUNET_FS_STATUS_DOWNLOAD_ERROR:
302 if (NULL != sr->probe_cancel_task)
304 GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
305 sr->probe_cancel_task = NULL;
307 sr->probe_cancel_task =
308 GNUNET_SCHEDULER_add_delayed (sr->remaining_probe_time,
309 &probe_failure_handler, sr);
311 case GNUNET_FS_STATUS_DOWNLOAD_COMPLETED:
312 if (NULL != sr->probe_cancel_task)
314 GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
315 sr->probe_cancel_task = NULL;
317 sr->probe_cancel_task =
318 GNUNET_SCHEDULER_add_now (&probe_success_handler, sr);
320 case GNUNET_FS_STATUS_DOWNLOAD_STOPPED:
321 if (NULL != sr->probe_cancel_task)
323 GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
324 sr->probe_cancel_task = NULL;
328 case GNUNET_FS_STATUS_DOWNLOAD_ACTIVE:
329 if (NULL == sr->probe_cancel_task)
331 sr->probe_active_time = GNUNET_TIME_absolute_get ();
332 sr->probe_cancel_task =
333 GNUNET_SCHEDULER_add_delayed (sr->remaining_probe_time,
334 &probe_failure_handler, sr);
337 case GNUNET_FS_STATUS_DOWNLOAD_INACTIVE:
338 if (NULL != sr->probe_cancel_task)
340 GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
341 sr->probe_cancel_task = NULL;
343 dur = GNUNET_TIME_absolute_get_duration (sr->probe_active_time);
344 sr->remaining_probe_time =
345 GNUNET_TIME_relative_subtract (sr->remaining_probe_time, dur);
346 if (0 == sr->remaining_probe_time.rel_value_us)
347 sr->probe_cancel_task =
348 GNUNET_SCHEDULER_add_now (&probe_failure_handler, sr);
349 GNUNET_FS_search_result_sync_ (sr);
360 * Task run periodically to remind clients that a probe is active.
362 * @param cls the `struct GNUNET_FS_SearchResult` that we are probing for
365 probe_ping_task_cb (void *cls)
367 struct GNUNET_FS_Handle *h = cls;
368 struct GNUNET_FS_SearchResult *sr;
370 for (sr = h->probes_head; NULL != sr; sr = sr->next)
371 if (NULL != sr->probe_ctx->mq)
372 signal_probe_result (sr);
374 = GNUNET_SCHEDULER_add_delayed (GNUNET_FS_PROBE_UPDATE_FREQUENCY,
381 * Start the ping task for this search result.
383 * @param sr result to start pinging for.
386 start_probe_ping_task (struct GNUNET_FS_SearchResult *sr)
388 struct GNUNET_FS_Handle *h = sr->h;
390 GNUNET_CONTAINER_DLL_insert (h->probes_head,
393 if (NULL == h->probe_ping_task)
395 = GNUNET_SCHEDULER_add_now (&probe_ping_task_cb,
401 * Stop the ping task for this search result.
403 * @param sr result to start pinging for.
406 GNUNET_FS_stop_probe_ping_task_ (struct GNUNET_FS_SearchResult *sr)
408 struct GNUNET_FS_Handle *h = sr->h;
410 GNUNET_CONTAINER_DLL_remove (h->probes_head,
413 if (NULL == h->probes_head)
415 GNUNET_SCHEDULER_cancel (h->probe_ping_task);
416 h->probe_ping_task = NULL;
422 * Start download probes for the given search result.
424 * @param sr the search result
427 GNUNET_FS_search_start_probe_ (struct GNUNET_FS_SearchResult *sr)
432 if (NULL != sr->probe_ctx)
434 if (NULL != sr->download)
436 if (0 == (sr->h->flags & GNUNET_FS_FLAGS_DO_PROBES))
438 if (sr->availability_trials > AVAILABILITY_TRIALS_MAX)
440 if ( (GNUNET_FS_URI_CHK != sr->uri->type) && (GNUNET_FS_URI_LOC != sr->uri->type))
442 len = GNUNET_FS_uri_chk_get_file_size (sr->uri);
445 if ((len <= DBLOCK_SIZE) && (sr->availability_success > 0))
447 off = len / DBLOCK_SIZE;
449 off = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, off);
451 if (len - off < DBLOCK_SIZE)
455 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
456 "Starting probe #%u (at offset %llu) for search result %p\n",
457 sr->availability_trials + 1,
458 (unsigned long long) off,
460 sr->remaining_probe_time =
461 GNUNET_TIME_relative_saturating_multiply (sr->h->avg_block_latency,
462 2 * (1 + sr->availability_trials));
464 GNUNET_FS_download_start (sr->h, sr->uri, sr->meta, NULL, NULL, off,
466 GNUNET_FS_DOWNLOAD_NO_TEMPORARIES |
467 GNUNET_FS_DOWNLOAD_IS_PROBE, sr, NULL);
468 start_probe_ping_task (sr);
473 * Start download probes for the given search result.
475 * @param h file-sharing handle to use for the operation
476 * @param uri URI to probe
477 * @param meta meta data associated with the URI
478 * @param client_info client info pointer to use for associated events
479 * @param anonymity anonymity level to use for the probes
480 * @return the search result handle to access the probe activity
482 struct GNUNET_FS_SearchResult *
483 GNUNET_FS_probe (struct GNUNET_FS_Handle *h,
484 const struct GNUNET_FS_Uri *uri,
485 const struct GNUNET_CONTAINER_MetaData *meta,
489 struct GNUNET_FS_SearchResult *sr;
491 GNUNET_assert (NULL != h);
492 sr = GNUNET_new (struct GNUNET_FS_SearchResult);
494 sr->uri = GNUNET_FS_uri_dup (uri);
495 sr->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
496 sr->client_info = client_info;
497 sr->anonymity = anonymity;
498 GNUNET_FS_search_start_probe_ (sr);
504 * Stop probing activity associated with a search result.
506 * @param sr search result
509 GNUNET_FS_search_stop_probe_ (struct GNUNET_FS_SearchResult *sr)
511 if (NULL != sr->probe_ctx)
513 GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
514 sr->probe_ctx = NULL;
515 GNUNET_FS_stop_probe_ping_task_ (sr);
517 if (NULL != sr->probe_cancel_task)
519 GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
520 sr->probe_cancel_task = NULL;
526 * Stop probe activity. Must ONLY be used on values
527 * returned from #GNUNET_FS_probe.
529 * @param sr search result to stop probing for (freed)
530 * @return the value of the 'client_info' pointer
533 GNUNET_FS_probe_stop (struct GNUNET_FS_SearchResult *sr)
537 GNUNET_assert (NULL == sr->sc);
538 GNUNET_FS_search_stop_probe_ (sr);
539 GNUNET_FS_uri_destroy (sr->uri);
540 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
541 client_info = sr->client_info;
548 * We have received a KSK result. Check how it fits in with the
549 * overall query and notify the client accordingly.
551 * @param sc context for the overall query
552 * @param ent entry for the specific keyword
553 * @param uri the URI that was found
554 * @param meta metadata associated with the URI
555 * under the @a ent keyword
558 process_ksk_result (struct GNUNET_FS_SearchContext *sc,
559 struct SearchRequestEntry *ent,
560 const struct GNUNET_FS_Uri *uri,
561 const struct GNUNET_CONTAINER_MetaData *meta)
563 struct GNUNET_HashCode key;
564 struct GNUNET_FS_SearchResult *sr;
565 struct GetResultContext grc;
570 GNUNET_assert (NULL != sc);
572 GNUNET_FS_uri_to_key (uri,
579 GNUNET_CONTAINER_multihashmap_get_multiple (ent->results,
581 &test_result_present,
583 return; /* duplicate result */
584 /* try to find search result in master map */
587 GNUNET_CONTAINER_multihashmap_get_multiple (sc->master_result_map,
589 &get_result_present, &grc);
591 is_new = (NULL == sr) || (sr->mandatory_missing > 0);
594 sr = GNUNET_new (struct GNUNET_FS_SearchResult);
597 sr->anonymity = sc->anonymity;
598 sr->uri = GNUNET_FS_uri_dup (uri);
599 sr->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
600 sr->mandatory_missing = sc->mandatory_count;
602 sr->keyword_bitmap = GNUNET_malloc ((sc->uri->data.ksk.keywordCount + 7) / 8); /* round up, count bits */
603 GNUNET_CONTAINER_multihashmap_put (sc->master_result_map, &key, sr,
604 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
608 GNUNET_CONTAINER_meta_data_merge (sr->meta, meta);
610 GNUNET_break (GNUNET_OK ==
611 GNUNET_CONTAINER_multihashmap_put (ent->results,
614 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
616 koff = ent - sc->requests;
617 GNUNET_assert ( (ent >= sc->requests) &&
618 (koff < sc->uri->data.ksk.keywordCount));
619 sr->keyword_bitmap[koff / 8] |= (1 << (koff % 8));
620 /* check if mandatory satisfied */
621 if (1 <= GNUNET_CONTAINER_multihashmap_size (ent->results))
625 GNUNET_break (sr->mandatory_missing > 0);
626 sr->mandatory_missing--;
630 sr->optional_support++;
633 if (0 != sr->mandatory_missing)
635 GNUNET_break (NULL == sr->client_info);
639 notify_client_chk_result (sc, sr);
641 notify_client_chk_update (sc, sr);
642 GNUNET_FS_search_result_sync_ (sr);
643 GNUNET_FS_search_start_probe_ (sr);
648 * Start search for content, internal API.
650 * @param h handle to the file sharing subsystem
651 * @param uri specifies the search parameters; can be
652 * a KSK URI or an SKS URI.
653 * @param anonymity desired level of anonymity
654 * @param options options for the search
655 * @param cctx client context
656 * @param psearch parent search result (for namespace update searches)
657 * @return context that can be used to control the search
659 static struct GNUNET_FS_SearchContext *
660 search_start (struct GNUNET_FS_Handle *h,
661 const struct GNUNET_FS_Uri *uri,
663 enum GNUNET_FS_SearchOptions options,
665 struct GNUNET_FS_SearchResult *psearch);
669 * We have received an SKS result. Start searching for updates and
670 * notify the client if it is a new result.
672 * @param sc context for the overall query
673 * @param id_update identifier for updates, NULL for none
674 * @param uri the URI that was found
675 * @param meta metadata associated with the URI
678 process_sks_result (struct GNUNET_FS_SearchContext *sc,
679 const char *id_update,
680 const struct GNUNET_FS_Uri *uri,
681 const struct GNUNET_CONTAINER_MetaData *meta)
683 struct GNUNET_FS_Uri uu;
684 struct GNUNET_HashCode key;
685 struct GNUNET_FS_SearchResult *sr;
688 GNUNET_assert (NULL != sc);
690 GNUNET_FS_uri_to_key (uri,
696 GNUNET_CRYPTO_hash_xor (&uri->data.chk.chk.key,
697 &uri->data.chk.chk.query,
700 GNUNET_CONTAINER_multihashmap_get_multiple (sc->master_result_map, &key,
701 &test_result_present,
703 return; /* duplicate result */
704 sr = GNUNET_new (struct GNUNET_FS_SearchResult);
707 sr->anonymity = sc->anonymity;
708 sr->uri = GNUNET_FS_uri_dup (uri);
709 sr->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
711 GNUNET_CONTAINER_multihashmap_put (sc->master_result_map, &key, sr,
712 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
713 GNUNET_FS_search_result_sync_ (sr);
714 GNUNET_FS_search_start_probe_ (sr);
716 if (0 == sr->mandatory_missing)
717 notify_client_chk_result (sc, sr);
719 GNUNET_break (NULL == sr->client_info);
720 /* search for updates */
721 if (0 == strlen (id_update))
722 return; /* no updates */
723 uu.type = GNUNET_FS_URI_SKS;
724 uu.data.sks.ns = sc->uri->data.sks.ns;
725 uu.data.sks.identifier = GNUNET_strdup (id_update);
726 (void) search_start (sc->h, &uu, sc->anonymity, sc->options, NULL, sr);
727 GNUNET_free (uu.data.sks.identifier);
732 * Decrypt a ublock using a 'keyword' as the passphrase. Given the
733 * KSK public key derived from the keyword, this function looks up
734 * the original keyword in the search context and decrypts the
735 * given ciphertext block.
737 * @param sc search context with the keywords
738 * @param dpub derived public key used for the search
739 * @param edata encrypted data
740 * @param edata_size number of bytes in @a edata (and @a data)
741 * @param data where to store the plaintext
742 * @return keyword index on success, #GNUNET_SYSERR on error (no such
743 * keyword, internal error)
746 decrypt_block_with_keyword (const struct GNUNET_FS_SearchContext *sc,
747 const struct GNUNET_CRYPTO_EcdsaPublicKey *dpub,
752 const struct GNUNET_CRYPTO_EcdsaPrivateKey *anon;
753 struct GNUNET_CRYPTO_EcdsaPublicKey anon_pub;
757 for (i = 0; i < sc->uri->data.ksk.keywordCount; i++)
758 if (0 == memcmp (dpub,
759 &sc->requests[i].dpub,
760 sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey)))
762 if (i == sc->uri->data.ksk.keywordCount)
764 /* oops, does not match any of our keywords!? */
766 return GNUNET_SYSERR;
769 anon = GNUNET_CRYPTO_ecdsa_key_get_anonymous ();
770 GNUNET_CRYPTO_ecdsa_key_get_public (anon, &anon_pub);
771 GNUNET_FS_ublock_decrypt_ (edata, edata_size,
773 sc->requests[i].keyword,
780 * Process a keyword search result. The actual type of block is
781 * a UBlock; we know it is a keyword search result because that's
782 * what we were searching for.
784 * @param sc our search context
785 * @param ub the ublock with the keyword search result
786 * @param size size of @a ub
789 process_kblock (struct GNUNET_FS_SearchContext *sc,
790 const struct UBlock *ub,
794 char pt[size - sizeof (struct UBlock)];
796 struct GNUNET_CONTAINER_MetaData *meta;
797 struct GNUNET_FS_Uri *uri;
801 if (-1 == (i = decrypt_block_with_keyword (sc,
802 &ub->verification_key,
804 size - sizeof (struct UBlock),
807 /* parse; pt[0] is just '\0', so we skip over that */
808 eos = memchr (&pt[1], '\0', sizeof (pt) - 1);
814 if (NULL == (uri = GNUNET_FS_uri_parse (&pt[1], &emsg)))
816 if (GNUNET_FS_VERSION > 0x00090400)
818 /* we broke this in 0x00090300, so don't bitch
819 too loudly just one version up... */
820 GNUNET_break_op (0); /* ublock malformed */
821 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
822 _("Failed to parse URI `%s': %s\n"),
826 GNUNET_free_non_null (emsg);
830 if (sizeof (pt) == j)
831 meta = GNUNET_CONTAINER_meta_data_create ();
833 meta = GNUNET_CONTAINER_meta_data_deserialize (&pt[j], sizeof (pt) - j);
836 GNUNET_break_op (0); /* ublock malformed */
837 GNUNET_FS_uri_destroy (uri);
840 process_ksk_result (sc,
846 GNUNET_CONTAINER_meta_data_destroy (meta);
847 GNUNET_FS_uri_destroy (uri);
852 * Process a namespace-search result. The actual type of block is
853 * a UBlock; we know it is a namespace search result because that's
854 * what we were searching for.
856 * @param sc our search context
857 * @param ub the ublock with a namespace result
858 * @param size size of @a ub
861 process_sblock (struct GNUNET_FS_SearchContext *sc,
862 const struct UBlock *ub,
865 size_t len = size - sizeof (struct UBlock);
867 struct GNUNET_FS_Uri *uri;
868 struct GNUNET_CONTAINER_MetaData *meta;
874 GNUNET_FS_ublock_decrypt_ (&ub[1], len,
875 &sc->uri->data.sks.ns,
876 sc->uri->data.sks.identifier,
879 if (0 == (off = GNUNET_STRINGS_buffer_tokenize (pt, len, 2, &id, &uris)))
881 GNUNET_break_op (0); /* ublock malformed */
884 if (NULL == (meta = GNUNET_CONTAINER_meta_data_deserialize (&pt[off], len - off)))
886 GNUNET_break_op (0); /* ublock malformed */
889 if (NULL == (uri = GNUNET_FS_uri_parse (uris, &emsg)))
891 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
892 _("Failed to parse URI `%s': %s\n"),
894 GNUNET_break_op (0); /* ublock malformed */
895 GNUNET_free_non_null (emsg);
896 GNUNET_CONTAINER_meta_data_destroy (meta);
900 process_sks_result (sc, id, uri, meta);
902 GNUNET_FS_uri_destroy (uri);
903 GNUNET_CONTAINER_meta_data_destroy (meta);
908 * Shutdown any existing connection to the FS
909 * service and try to establish a fresh one
910 * (and then re-transmit our search request).
912 * @param sc the search to reconnec
915 try_reconnect (struct GNUNET_FS_SearchContext *sc);
919 * We check a result message from the service.
922 * @param msg result message received
925 check_result (void *cls,
926 const struct ClientPutMessage *cm)
928 /* payload of any variable size is OK */
934 * We process a search result from the service.
937 * @param msg result message received
940 handle_result (void *cls,
941 const struct ClientPutMessage *cm)
943 struct GNUNET_FS_SearchContext *sc = cls;
944 uint16_t msize = ntohs (cm->header.size) - sizeof (*cm);
945 enum GNUNET_BLOCK_Type type = ntohl (cm->type);
947 if (GNUNET_TIME_absolute_get_duration (GNUNET_TIME_absolute_ntoh (cm->expiration)).rel_value_us > 0)
949 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
950 "Result received has already expired.\n");
951 return; /* result expired */
955 case GNUNET_BLOCK_TYPE_FS_UBLOCK:
956 if (GNUNET_FS_URI_SKS == sc->uri->type)
958 (const struct UBlock *) &cm[1],
962 (const struct UBlock *) &cm[1],
965 case GNUNET_BLOCK_TYPE_ANY:
968 case GNUNET_BLOCK_TYPE_FS_DBLOCK:
971 case GNUNET_BLOCK_TYPE_FS_ONDEMAND:
974 case GNUNET_BLOCK_TYPE_FS_IBLOCK:
978 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
979 _("Got result with unknown block type `%d', ignoring"),
987 * Schedule the transmission of the (next) search request
990 * @param sc context for the search
993 schedule_transmit_search_request (struct GNUNET_FS_SearchContext *sc);
997 * Closure for #build_result_set().
999 struct MessageBuilderContext
1002 * How many entries can we store to xoff.
1004 unsigned int put_cnt;
1007 * How many entries should we skip.
1009 unsigned int skip_cnt;
1012 * Where to store the keys.
1014 struct GNUNET_HashCode *xoff;
1017 * Search context we are iterating for.
1019 struct GNUNET_FS_SearchContext *sc;
1022 * Keyword offset the search result must match (0 for SKS)
1024 unsigned int keyword_offset;
1029 * Iterating over the known results, pick those matching the given
1030 * result range and store their keys at 'xoff'.
1032 * @param cls the `struct MessageBuilderContext`
1033 * @param key key for a result
1034 * @param value the search result
1035 * @return #GNUNET_OK to continue iterating
1038 build_result_set (void *cls,
1039 const struct GNUNET_HashCode *key,
1042 struct MessageBuilderContext *mbc = cls;
1043 struct GNUNET_FS_SearchResult *sr = value;
1045 if ( (NULL != sr->keyword_bitmap) &&
1046 (0 == (sr->keyword_bitmap[mbc->keyword_offset / 8] & (1 << (mbc->keyword_offset % 8)))) )
1047 return GNUNET_OK; /* have no match for this keyword yet */
1048 if (mbc->skip_cnt > 0)
1053 if (0 == mbc->put_cnt)
1054 return GNUNET_SYSERR;
1055 mbc->xoff[--mbc->put_cnt] = *key;
1062 * Iterating over the known results, count those matching the given
1063 * result range and increment put count for each.
1065 * @param cls the `struct MessageBuilderContext`
1066 * @param key key for a result
1067 * @param value the search result
1068 * @return #GNUNET_OK to continue iterating
1071 find_result_set (void *cls,
1072 const struct GNUNET_HashCode *key,
1075 struct MessageBuilderContext *mbc = cls;
1076 struct GNUNET_FS_SearchResult *sr = value;
1078 if ( (NULL != sr->keyword_bitmap) &&
1079 (0 == (sr->keyword_bitmap[mbc->keyword_offset / 8] & (1 << (mbc->keyword_offset % 8)))) )
1080 return GNUNET_OK; /* have no match for this keyword yet */
1087 * Schedule the transmission of the (next) search request
1090 * @param sc context for the search
1093 schedule_transmit_search_request (struct GNUNET_FS_SearchContext *sc)
1095 struct MessageBuilderContext mbc;
1096 struct GNUNET_MQ_Envelope *env;
1097 struct SearchMessage *sm;
1098 struct GNUNET_CRYPTO_EcdsaPublicKey dpub;
1099 unsigned int total_seen_results; /* total number of result hashes to send */
1104 unsigned int search_request_map_offset;
1105 unsigned int keyword_offset;
1108 memset (&mbc, 0, sizeof (mbc));
1110 if (GNUNET_FS_uri_test_ksk (sc->uri))
1112 /* This will calculate the result set size ONLY for
1113 "keyword_offset == 0", so we will have to recalculate
1114 it for the other keywords later! */
1115 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1118 total_seen_results = mbc.put_cnt;
1123 = GNUNET_CONTAINER_multihashmap_size (sc->master_result_map);
1125 search_request_map_offset = 0;
1127 first_call = GNUNET_YES;
1128 while ( (0 != (left =
1129 (total_seen_results - search_request_map_offset))) ||
1130 (GNUNET_YES == first_call) )
1132 first_call = GNUNET_NO;
1133 options = SEARCH_MESSAGE_OPTION_NONE;
1134 if (0 != (sc->options & GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY))
1135 options |= SEARCH_MESSAGE_OPTION_LOOPBACK_ONLY;
1137 fit = (GNUNET_MAX_MESSAGE_SIZE - 1 - sizeof (*sm)) / sizeof (struct GNUNET_HashCode);
1138 todo = GNUNET_MIN (fit,
1140 env = GNUNET_MQ_msg_extra (sm,
1141 sizeof (struct GNUNET_HashCode) * todo,
1142 GNUNET_MESSAGE_TYPE_FS_START_SEARCH);
1143 mbc.skip_cnt = search_request_map_offset;
1144 mbc.xoff = (struct GNUNET_HashCode *) &sm[1];
1145 sm->type = htonl (GNUNET_BLOCK_TYPE_FS_UBLOCK);
1146 sm->anonymity_level = htonl (sc->anonymity);
1147 memset (&sm->target,
1149 sizeof (struct GNUNET_PeerIdentity));
1151 if (GNUNET_FS_uri_test_ksk (sc->uri))
1153 mbc.keyword_offset = keyword_offset;
1154 /* calculate how many results we can send in this message */
1156 /* now build message */
1157 sm->query = sc->requests[keyword_offset].uquery;
1158 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1161 search_request_map_offset += todo;
1162 GNUNET_assert (0 == mbc.put_cnt);
1163 GNUNET_assert (total_seen_results >= search_request_map_offset);
1164 if (total_seen_results != search_request_map_offset)
1166 /* more requesting to be done... */
1167 sm->options = htonl (options | SEARCH_MESSAGE_OPTION_CONTINUED);
1171 sm->options = htonl (options);
1173 if (sc->uri->data.ksk.keywordCount != keyword_offset)
1175 /* more keywords => more requesting to be done... */
1176 first_call = GNUNET_YES;
1177 search_request_map_offset = 0;
1179 mbc.keyword_offset = keyword_offset;
1180 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1183 total_seen_results = mbc.put_cnt;
1189 GNUNET_assert (GNUNET_FS_uri_test_sks (sc->uri));
1191 GNUNET_CRYPTO_ecdsa_public_key_derive (&sc->uri->data.sks.ns,
1192 sc->uri->data.sks.identifier,
1195 GNUNET_CRYPTO_hash (&dpub,
1199 mbc.keyword_offset = 0;
1200 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1203 GNUNET_assert (total_seen_results >= search_request_map_offset);
1204 if (total_seen_results != search_request_map_offset)
1206 /* more requesting to be done... */
1207 sm->options = htonl (options | SEARCH_MESSAGE_OPTION_CONTINUED);
1211 sm->options = htonl (options);
1214 GNUNET_MQ_send (sc->mq,
1221 * Generic error handler, called with the appropriate error code and
1222 * the same closure specified at the creation of the message queue.
1223 * Not every message queue implementation supports an error handler.
1225 * @param cls closure with the `struct GNUNET_FS_SearchContext *`
1226 * @param error error code
1229 search_mq_error_handler (void *cls,
1230 enum GNUNET_MQ_Error error)
1232 struct GNUNET_FS_SearchContext *sc = cls;
1236 GNUNET_MQ_destroy (sc->mq);
1244 * Reconnect to the FS service and transmit
1247 * @param cls our search context
1250 do_reconnect (void *cls)
1252 struct GNUNET_FS_SearchContext *sc = cls;
1253 struct GNUNET_MQ_MessageHandler handlers[] = {
1254 GNUNET_MQ_hd_var_size (result,
1255 GNUNET_MESSAGE_TYPE_FS_PUT,
1256 struct ClientPutMessage,
1258 GNUNET_MQ_handler_end ()
1262 sc->mq = GNUNET_CLIENT_connect (sc->h->cfg,
1265 &search_mq_error_handler,
1272 schedule_transmit_search_request (sc);
1277 * Shutdown any existing connection to the FS
1278 * service and try to establish a fresh one
1279 * (and then re-transmit our search request).
1281 * @param sc the search to reconnec
1284 try_reconnect (struct GNUNET_FS_SearchContext *sc)
1288 GNUNET_MQ_destroy (sc->mq);
1291 sc->reconnect_backoff = GNUNET_TIME_STD_BACKOFF (sc->reconnect_backoff);
1293 GNUNET_SCHEDULER_add_delayed (sc->reconnect_backoff,
1300 * Start search for content, internal API.
1302 * @param h handle to the file sharing subsystem
1303 * @param uri specifies the search parameters; can be
1304 * a KSK URI or an SKS URI.
1305 * @param anonymity desired level of anonymity
1306 * @param options options for the search
1307 * @param cctx initial value for the client context
1308 * @param psearch parent search result (for namespace update searches)
1309 * @return context that can be used to control the search
1311 static struct GNUNET_FS_SearchContext *
1312 search_start (struct GNUNET_FS_Handle *h,
1313 const struct GNUNET_FS_Uri *uri,
1315 enum GNUNET_FS_SearchOptions options,
1317 struct GNUNET_FS_SearchResult *psearch)
1319 struct GNUNET_FS_SearchContext *sc;
1320 struct GNUNET_FS_ProgressInfo pi;
1322 sc = GNUNET_new (struct GNUNET_FS_SearchContext);
1324 sc->options = options;
1325 sc->uri = GNUNET_FS_uri_dup (uri);
1326 sc->anonymity = anonymity;
1327 sc->start_time = GNUNET_TIME_absolute_get ();
1328 if (NULL != psearch)
1330 sc->psearch_result = psearch;
1331 psearch->update_search = sc;
1333 sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16, GNUNET_NO);
1334 sc->client_info = cctx;
1335 if (GNUNET_OK != GNUNET_FS_search_start_searching_ (sc))
1337 GNUNET_FS_uri_destroy (sc->uri);
1338 GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
1342 GNUNET_FS_search_sync_ (sc);
1343 pi.status = GNUNET_FS_STATUS_SEARCH_START;
1344 sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
1350 * Update the 'results' map for the individual keywords with the
1351 * results from the 'global' result set.
1353 * @param cls closure, the `struct GNUNET_FS_SearchContext *`
1354 * @param key current key code
1355 * @param value value in the hash map, the `struct GNUNET_FS_SearchResult *`
1356 * @return #GNUNET_YES (we should continue to iterate)
1359 update_sre_result_maps (void *cls,
1360 const struct GNUNET_HashCode *key,
1363 struct GNUNET_FS_SearchContext *sc = cls;
1364 struct GNUNET_FS_SearchResult *sr = value;
1367 for (i = 0; i < sc->uri->data.ksk.keywordCount; i++)
1368 if (0 != (sr->keyword_bitmap[i / 8] & (1 << (i % 8))))
1369 GNUNET_break (GNUNET_OK ==
1370 GNUNET_CONTAINER_multihashmap_put (sc->requests[i].results,
1373 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1380 * Build the request and actually initiate the search using the
1381 * GNUnet FS service.
1383 * @param sc search context
1384 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1387 GNUNET_FS_search_start_searching_ (struct GNUNET_FS_SearchContext *sc)
1390 const char *keyword;
1391 const struct GNUNET_CRYPTO_EcdsaPrivateKey *anon;
1392 struct GNUNET_CRYPTO_EcdsaPublicKey anon_pub;
1393 struct SearchRequestEntry *sre;
1395 GNUNET_assert (NULL == sc->mq);
1396 if (GNUNET_FS_uri_test_ksk (sc->uri))
1398 GNUNET_assert (0 != sc->uri->data.ksk.keywordCount);
1399 anon = GNUNET_CRYPTO_ecdsa_key_get_anonymous ();
1400 GNUNET_CRYPTO_ecdsa_key_get_public (anon, &anon_pub);
1402 = GNUNET_new_array (sc->uri->data.ksk.keywordCount,
1403 struct SearchRequestEntry);
1405 for (i = 0; i < sc->uri->data.ksk.keywordCount; i++)
1407 keyword = &sc->uri->data.ksk.keywords[i][1];
1408 sre = &sc->requests[i];
1409 sre->keyword = GNUNET_strdup (keyword);
1410 GNUNET_CRYPTO_ecdsa_public_key_derive (&anon_pub,
1414 GNUNET_CRYPTO_hash (&sre->dpub,
1415 sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey),
1417 sre->mandatory = (sc->uri->data.ksk.keywords[i][0] == '+');
1419 sc->mandatory_count++;
1420 sre->results = GNUNET_CONTAINER_multihashmap_create (4, GNUNET_NO);
1422 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1423 &update_sre_result_maps,
1426 GNUNET_assert (NULL == sc->task);
1430 GNUNET_SCHEDULER_cancel (sc->task);
1432 return GNUNET_SYSERR;
1439 * Freeze probes for the given search result.
1441 * @param cls the global FS handle
1442 * @param key the key for the search result (unused)
1443 * @param value the search result to free
1444 * @return #GNUNET_OK
1447 search_result_freeze_probes (void *cls,
1448 const struct GNUNET_HashCode *key,
1451 struct GNUNET_FS_SearchResult *sr = value;
1453 if (NULL != sr->probe_ctx)
1455 GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
1456 sr->probe_ctx = NULL;
1457 GNUNET_FS_stop_probe_ping_task_ (sr);
1459 if (NULL != sr->probe_cancel_task)
1461 GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
1462 sr->probe_cancel_task = NULL;
1464 if (NULL != sr->update_search)
1465 GNUNET_FS_search_pause (sr->update_search);
1471 * Resume probes for the given search result.
1473 * @param cls the global FS handle
1474 * @param key the key for the search result (unused)
1475 * @param value the search result to free
1476 * @return #GNUNET_OK
1479 search_result_resume_probes (void *cls,
1480 const struct GNUNET_HashCode * key,
1483 struct GNUNET_FS_SearchResult *sr = value;
1485 GNUNET_FS_search_start_probe_ (sr);
1486 if (NULL != sr->update_search)
1487 GNUNET_FS_search_continue (sr->update_search);
1493 * Signal suspend and free the given search result.
1495 * @param cls the global FS handle
1496 * @param key the key for the search result (unused)
1497 * @param value the search result to free
1498 * @return #GNUNET_OK
1501 search_result_suspend (void *cls,
1502 const struct GNUNET_HashCode *key,
1505 struct GNUNET_FS_SearchContext *sc = cls;
1506 struct GNUNET_FS_SearchResult *sr = value;
1507 struct GNUNET_FS_ProgressInfo pi;
1509 if (NULL != sr->download)
1511 GNUNET_FS_download_signal_suspend_ (sr->download);
1512 sr->download = NULL;
1514 if (NULL != sr->update_search)
1516 GNUNET_FS_search_signal_suspend_ (sr->update_search);
1517 sr->update_search = NULL;
1519 GNUNET_FS_search_stop_probe_ (sr);
1520 if (0 == sr->mandatory_missing)
1522 /* client is aware of search result, notify about suspension event */
1523 pi.status = GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND;
1524 pi.value.search.specifics.result_suspend.cctx = sr->client_info;
1525 pi.value.search.specifics.result_suspend.meta = sr->meta;
1526 pi.value.search.specifics.result_suspend.uri = sr->uri;
1527 sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
1529 GNUNET_break (NULL == sr->client_info);
1530 GNUNET_free_non_null (sr->serialization);
1531 GNUNET_FS_uri_destroy (sr->uri);
1532 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
1533 GNUNET_free_non_null (sr->keyword_bitmap);
1540 * Create SUSPEND event for the given search operation
1541 * and then clean up our state (without stop signal).
1543 * @param cls the `struct GNUNET_FS_SearchContext` to signal for
1546 GNUNET_FS_search_signal_suspend_ (void *cls)
1548 struct GNUNET_FS_SearchContext *sc = cls;
1549 struct GNUNET_FS_ProgressInfo pi;
1552 GNUNET_FS_end_top (sc->h, sc->top);
1553 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1554 &search_result_suspend, sc);
1555 pi.status = GNUNET_FS_STATUS_SEARCH_SUSPEND;
1556 sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
1557 GNUNET_break (NULL == sc->client_info);
1558 if (sc->task != NULL)
1560 GNUNET_SCHEDULER_cancel (sc->task);
1565 GNUNET_MQ_destroy (sc->mq);
1568 GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
1569 if (NULL != sc->requests)
1571 GNUNET_assert (GNUNET_FS_uri_test_ksk (sc->uri));
1572 for (i = 0; i < sc->uri->data.ksk.keywordCount; i++)
1574 GNUNET_CONTAINER_multihashmap_destroy (sc->requests[i].results);
1575 GNUNET_free (sc->requests[i].keyword);
1578 GNUNET_free_non_null (sc->requests);
1579 GNUNET_free_non_null (sc->emsg);
1580 GNUNET_FS_uri_destroy (sc->uri);
1581 GNUNET_free_non_null (sc->serialization);
1587 * Start search for content.
1589 * @param h handle to the file sharing subsystem
1590 * @param uri specifies the search parameters; can be
1591 * a KSK URI or an SKS URI.
1592 * @param anonymity desired level of anonymity
1593 * @param options options for the search
1594 * @param cctx initial value for the client context
1595 * @return context that can be used to control the search
1597 struct GNUNET_FS_SearchContext *
1598 GNUNET_FS_search_start (struct GNUNET_FS_Handle *h,
1599 const struct GNUNET_FS_Uri *uri, uint32_t anonymity,
1600 enum GNUNET_FS_SearchOptions options, void *cctx)
1602 struct GNUNET_FS_SearchContext *ret;
1604 ret = search_start (h, uri, anonymity, options, cctx, NULL);
1607 ret->top = GNUNET_FS_make_top (h, &GNUNET_FS_search_signal_suspend_, ret);
1615 * @param sc context for the search that should be paused
1618 GNUNET_FS_search_pause (struct GNUNET_FS_SearchContext *sc)
1620 struct GNUNET_FS_ProgressInfo pi;
1622 if (NULL != sc->task)
1624 GNUNET_SCHEDULER_cancel (sc->task);
1629 GNUNET_MQ_destroy (sc->mq);
1632 GNUNET_FS_search_sync_ (sc);
1633 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1634 &search_result_freeze_probes,
1636 pi.status = GNUNET_FS_STATUS_SEARCH_PAUSED;
1637 sc->client_info = GNUNET_FS_search_make_status_ (&pi,
1644 * Continue paused search.
1646 * @param sc context for the search that should be resumed
1649 GNUNET_FS_search_continue (struct GNUNET_FS_SearchContext *sc)
1651 struct GNUNET_FS_ProgressInfo pi;
1653 GNUNET_assert (NULL == sc->mq);
1654 GNUNET_assert (NULL == sc->task);
1656 GNUNET_FS_search_sync_ (sc);
1657 pi.status = GNUNET_FS_STATUS_SEARCH_CONTINUED;
1658 sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
1659 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1660 &search_result_resume_probes, sc);
1665 * Signal stop for the given search result.
1667 * @param cls the global FS handle
1668 * @param key the key for the search result (unused)
1669 * @param value the search result to free
1670 * @return #GNUNET_OK
1673 search_result_stop (void *cls,
1674 const struct GNUNET_HashCode *key,
1677 struct GNUNET_FS_SearchContext *sc = cls;
1678 struct GNUNET_FS_SearchResult *sr = value;
1679 struct GNUNET_FS_ProgressInfo pi;
1681 GNUNET_FS_search_stop_probe_ (sr);
1682 if (NULL != sr->download)
1684 sr->download->search = NULL;
1686 = GNUNET_FS_make_top (sr->download->h,
1687 &GNUNET_FS_download_signal_suspend_,
1689 if (NULL != sr->download->serialization)
1691 GNUNET_FS_remove_sync_file_ (sc->h,
1692 GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD,
1693 sr->download->serialization);
1694 GNUNET_free (sr->download->serialization);
1695 sr->download->serialization = NULL;
1697 pi.status = GNUNET_FS_STATUS_DOWNLOAD_LOST_PARENT;
1698 GNUNET_FS_download_make_status_ (&pi,
1700 GNUNET_FS_download_sync_ (sr->download);
1701 sr->download = NULL;
1703 if (0 != sr->mandatory_missing)
1705 /* client is unaware of search result as
1706 it does not match required keywords */
1707 GNUNET_break (NULL == sr->client_info);
1710 pi.status = GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED;
1711 pi.value.search.specifics.result_stopped.cctx = sr->client_info;
1712 pi.value.search.specifics.result_stopped.meta = sr->meta;
1713 pi.value.search.specifics.result_stopped.uri = sr->uri;
1714 sr->client_info = GNUNET_FS_search_make_status_ (&pi, sr->h, sc);
1720 * Free the given search result.
1722 * @param cls the global FS handle
1723 * @param key the key for the search result (unused)
1724 * @param value the search result to free
1725 * @return #GNUNET_OK
1728 search_result_free (void *cls,
1729 const struct GNUNET_HashCode *key,
1732 struct GNUNET_FS_SearchResult *sr = value;
1734 if (NULL != sr->update_search)
1736 GNUNET_FS_search_stop (sr->update_search);
1737 GNUNET_assert (NULL == sr->update_search);
1739 GNUNET_break (NULL == sr->probe_ctx);
1740 GNUNET_break (NULL == sr->probe_cancel_task);
1741 GNUNET_break (NULL == sr->client_info);
1742 GNUNET_free_non_null (sr->serialization);
1743 GNUNET_FS_uri_destroy (sr->uri);
1744 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
1745 GNUNET_free_non_null (sr->keyword_bitmap);
1752 * Stop search for content.
1754 * @param sc context for the search that should be stopped
1757 GNUNET_FS_search_stop (struct GNUNET_FS_SearchContext *sc)
1759 struct GNUNET_FS_ProgressInfo pi;
1762 if (NULL != sc->top)
1763 GNUNET_FS_end_top (sc->h, sc->top);
1764 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1765 &search_result_stop,
1767 if (NULL != sc->psearch_result)
1768 sc->psearch_result->update_search = NULL;
1769 if (NULL != sc->serialization)
1771 GNUNET_FS_remove_sync_file_ (sc->h,
1772 (NULL != sc->psearch_result)
1773 ? GNUNET_FS_SYNC_PATH_CHILD_SEARCH
1774 : GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
1776 GNUNET_FS_remove_sync_dir_ (sc->h,
1777 (NULL != sc->psearch_result)
1778 ? GNUNET_FS_SYNC_PATH_CHILD_SEARCH
1779 : GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
1781 GNUNET_free (sc->serialization);
1783 pi.status = GNUNET_FS_STATUS_SEARCH_STOPPED;
1784 sc->client_info = GNUNET_FS_search_make_status_ (&pi,
1787 GNUNET_break (NULL == sc->client_info);
1788 if (NULL != sc->task)
1790 GNUNET_SCHEDULER_cancel (sc->task);
1795 GNUNET_MQ_destroy (sc->mq);
1798 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1799 &search_result_free, sc);
1800 GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
1801 if (NULL != sc->requests)
1803 GNUNET_assert (GNUNET_FS_uri_test_ksk (sc->uri));
1804 for (i = 0; i < sc->uri->data.ksk.keywordCount; i++)
1805 GNUNET_CONTAINER_multihashmap_destroy (sc->requests[i].results);
1807 GNUNET_free_non_null (sc->requests);
1808 GNUNET_free_non_null (sc->emsg);
1809 GNUNET_FS_uri_destroy (sc->uri);
1813 /* end of fs_search.c */