2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2009 Christian Grothoff (and other contributing authors)
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 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file fs/fs_search.c
23 * @brief Helper functions for searching.
24 * @author Christian Grothoff
27 * - add support for pushing "already seen" information
28 * to FS service for bloomfilter (can wait)
32 #include "gnunet_constants.h"
33 #include "gnunet_fs_service.h"
34 #include "gnunet_protocols.h"
37 #define DEBUG_SEARCH GNUNET_NO
40 * Fill in all of the generic fields for a search event and
43 * @param pi structure to fill in
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_SearchContext *sc)
52 pi->value.search.sc = sc;
56 = (sc->psearch_result == NULL) ? NULL : sc->psearch_result->client_info;
57 pi->value.search.query
59 pi->value.search.duration = GNUNET_TIME_absolute_get_duration (sc->start_time);
60 pi->value.search.anonymity = sc->anonymity;
61 ret = sc->h->upcb (sc->h->upcb_cls,
68 * Check if the given result is identical
71 * @param cls points to the URI we check against
73 * @param value a "struct GNUNET_FS_SearchResult" who's URI we
75 * @return GNUNET_SYSERR if the result is present,
79 test_result_present (void *cls,
80 const GNUNET_HashCode * key,
83 const struct GNUNET_FS_Uri *uri = cls;
84 struct GNUNET_FS_SearchResult *sr = value;
86 if (GNUNET_FS_uri_test_equal (uri,
94 * We've found a new CHK result. Let the client
97 * @param sc the search context
98 * @param sr the specific result
101 notify_client_chk_result (struct GNUNET_FS_SearchContext *sc,
102 struct GNUNET_FS_SearchResult *sr)
104 struct GNUNET_FS_ProgressInfo pi;
106 pi.status = GNUNET_FS_STATUS_SEARCH_RESULT;
107 pi.value.search.specifics.result.meta = sr->meta;
108 pi.value.search.specifics.result.uri = sr->uri;
109 pi.value.search.specifics.result.result = sr;
110 pi.value.search.specifics.result.applicability_rank = sr->optional_support;
111 sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
116 * We've found new information about an existing CHK result. Let the
117 * client know about it.
119 * @param sc the search context
120 * @param sr the specific result
123 notify_client_chk_update (struct GNUNET_FS_SearchContext *sc,
124 struct GNUNET_FS_SearchResult *sr)
126 struct GNUNET_FS_ProgressInfo pi;
128 pi.status = GNUNET_FS_STATUS_SEARCH_UPDATE;
129 pi.value.search.specifics.update.cctx = sr->client_info;
130 pi.value.search.specifics.update.meta = sr->meta;
131 pi.value.search.specifics.update.uri = sr->uri;
132 pi.value.search.specifics.update.availability_rank
133 = 2*sr->availability_success - sr->availability_trials;
134 pi.value.search.specifics.update.availability_certainty
135 = sr->availability_trials;
136 pi.value.search.specifics.update.applicability_rank
137 = sr->optional_support;
138 sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
143 * Context for "get_result_present".
145 struct GetResultContext
148 * The URI we're looking for.
150 const struct GNUNET_FS_Uri *uri;
153 * Where to store a pointer to the search
154 * result struct if we found a match.
156 struct GNUNET_FS_SearchResult *sr;
161 * Check if the given result is identical to the given URI and if so
164 * @param cls a "struct GetResultContext"
165 * @param key not used
166 * @param value a "struct GNUNET_FS_SearchResult" who's URI we
167 * should compare with
171 get_result_present (void *cls,
172 const GNUNET_HashCode * key,
175 struct GetResultContext *grc = cls;
176 struct GNUNET_FS_SearchResult *sr = value;
178 if (GNUNET_FS_uri_test_equal (grc->uri,
186 * Signal result of last probe to client and then schedule next
190 signal_probe_result (struct GNUNET_FS_SearchResult *sr)
192 struct GNUNET_FS_ProgressInfo pi;
194 pi.status = GNUNET_FS_STATUS_SEARCH_START;
195 pi.value.search.specifics.update.cctx = sr->client_info;
196 pi.value.search.specifics.update.meta = sr->meta;
197 pi.value.search.specifics.update.uri = sr->uri;
198 pi.value.search.specifics.update.availability_rank = sr->availability_success;
199 pi.value.search.specifics.update.availability_certainty = sr->availability_trials;
200 pi.value.search.specifics.update.applicability_rank = sr->optional_support;
201 sr->sc->client_info = GNUNET_FS_search_make_status_ (&pi, sr->sc);
202 GNUNET_FS_search_start_probe_ (sr);
207 * Handle the case where we have failed to receive a response for our probe.
209 * @param cls our 'struct GNUNET_FS_SearchResult*'
210 * @param tc scheduler context
213 probe_failure_handler (void *cls,
214 const struct GNUNET_SCHEDULER_TaskContext *tc)
216 struct GNUNET_FS_SearchResult *sr = cls;
217 sr->availability_trials++;
218 GNUNET_FS_search_result_sync_ (sr);
219 signal_probe_result (sr);
224 * Handle the case where we have gotten a response for our probe.
226 * @param cls our 'struct GNUNET_FS_SearchResult*'
227 * @param tc scheduler context
230 probe_success_handler (void *cls,
231 const struct GNUNET_SCHEDULER_TaskContext *tc)
233 struct GNUNET_FS_SearchResult *sr = cls;
234 sr->availability_trials++;
235 sr->availability_success++;
236 GNUNET_FS_search_result_sync_ (sr);
237 signal_probe_result (sr);
242 * Notification of FS that a search probe has made progress.
243 * This function is used INSTEAD of the client's event handler
244 * for downloads where the GNUNET_FS_DOWNLOAD_IS_PROBE flag is set.
246 * @param cls closure, always NULL (!), actual closure
247 * is in the client-context of the info struct
248 * @param info details about the event, specifying the event type
249 * and various bits about the event
250 * @return client-context (for the next progress call
251 * for this operation; should be set to NULL for
252 * SUSPEND and STOPPED events). The value returned
253 * will be passed to future callbacks in the respective
254 * field in the GNUNET_FS_ProgressInfo struct.
257 GNUNET_FS_search_probe_progress_ (void *cls,
258 const struct GNUNET_FS_ProgressInfo *info)
260 struct GNUNET_FS_SearchResult *sr = info->value.download.cctx;
261 struct GNUNET_TIME_Relative dur;
263 switch (info->status)
265 case GNUNET_FS_STATUS_DOWNLOAD_START:
268 case GNUNET_FS_STATUS_DOWNLOAD_RESUME:
269 /* probes should never be resumed */
272 case GNUNET_FS_STATUS_DOWNLOAD_SUSPEND:
273 /* probes should never be suspended */
276 case GNUNET_FS_STATUS_DOWNLOAD_PROGRESS:
279 case GNUNET_FS_STATUS_DOWNLOAD_ERROR:
280 if (sr->probe_cancel_task != GNUNET_SCHEDULER_NO_TASK)
282 GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
283 sr->probe_cancel_task = GNUNET_SCHEDULER_NO_TASK;
285 sr->probe_cancel_task = GNUNET_SCHEDULER_add_delayed (sr->remaining_probe_time,
286 &probe_failure_handler,
289 case GNUNET_FS_STATUS_DOWNLOAD_COMPLETED:
290 if (sr->probe_cancel_task != GNUNET_SCHEDULER_NO_TASK)
292 GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
293 sr->probe_cancel_task = GNUNET_SCHEDULER_NO_TASK;
295 sr->probe_cancel_task = GNUNET_SCHEDULER_add_delayed (sr->remaining_probe_time,
296 &probe_success_handler,
299 case GNUNET_FS_STATUS_DOWNLOAD_STOPPED:
300 if (sr->probe_cancel_task != GNUNET_SCHEDULER_NO_TASK)
302 GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
303 sr->probe_cancel_task = GNUNET_SCHEDULER_NO_TASK;
307 case GNUNET_FS_STATUS_DOWNLOAD_ACTIVE:
308 GNUNET_assert (sr->probe_cancel_task == GNUNET_SCHEDULER_NO_TASK);
309 sr->probe_active_time = GNUNET_TIME_absolute_get ();
310 sr->probe_cancel_task = GNUNET_SCHEDULER_add_delayed (sr->remaining_probe_time,
311 &probe_failure_handler,
314 case GNUNET_FS_STATUS_DOWNLOAD_INACTIVE:
315 if (sr->probe_cancel_task != GNUNET_SCHEDULER_NO_TASK)
317 GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
318 sr->probe_cancel_task = GNUNET_SCHEDULER_NO_TASK;
320 dur = GNUNET_TIME_absolute_get_duration (sr->probe_active_time);
321 sr->remaining_probe_time = GNUNET_TIME_relative_subtract (sr->remaining_probe_time,
323 GNUNET_FS_search_result_sync_ (sr);
334 * Start download probes for the given search result.
336 * @param sr the search result
339 GNUNET_FS_search_start_probe_ (struct GNUNET_FS_SearchResult *sr)
344 if (sr->probe_ctx != NULL)
346 if (sr->download != NULL)
348 if (0 == (sr->sc->h->flags & GNUNET_FS_FLAGS_DO_PROBES))
350 if (sr->availability_trials > AVAILABILITY_TRIALS_MAX)
352 len = GNUNET_FS_uri_chk_get_file_size (sr->uri);
355 if ( (len <= DBLOCK_SIZE) && (sr->availability_success > 0))
357 off = len / DBLOCK_SIZE;
359 off = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, off);
361 if (len - off < DBLOCK_SIZE)
365 sr->remaining_probe_time = GNUNET_TIME_relative_multiply (sr->sc->h->avg_block_latency,
366 2 * (1 + sr->availability_trials));
367 sr->probe_ctx = GNUNET_FS_download_start (sr->sc->h,
373 GNUNET_FS_DOWNLOAD_NO_TEMPORARIES |
374 GNUNET_FS_DOWNLOAD_IS_PROBE,
380 * We have received a KSK result. Check how it fits in with the
381 * overall query and notify the client accordingly.
383 * @param sc context for the overall query
384 * @param ent entry for the specific keyword
385 * @param uri the URI that was found
386 * @param meta metadata associated with the URI
387 * under the "ent" keyword
390 process_ksk_result (struct GNUNET_FS_SearchContext *sc,
391 struct SearchRequestEntry *ent,
392 const struct GNUNET_FS_Uri *uri,
393 const struct GNUNET_CONTAINER_MetaData *meta)
396 struct GNUNET_FS_SearchResult *sr;
397 struct GetResultContext grc;
401 GNUNET_FS_uri_to_key (uri, &key);
403 GNUNET_CONTAINER_multihashmap_get_multiple (ent->results,
405 &test_result_present,
407 return; /* duplicate result */
408 /* try to find search result in master map */
411 GNUNET_CONTAINER_multihashmap_get_multiple (sc->master_result_map,
416 is_new = (NULL == sr) || (sr->mandatory_missing > 0);
419 sr = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchResult));
421 sr->uri = GNUNET_FS_uri_dup (uri);
422 sr->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
423 sr->mandatory_missing = sc->mandatory_count;
425 GNUNET_CONTAINER_multihashmap_put (sc->master_result_map,
428 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
432 GNUNET_CONTAINER_meta_data_merge (sr->meta, meta);
434 /* check if mandatory satisfied */
436 sr->mandatory_missing--;
438 sr->optional_support++;
439 if (0 != sr->mandatory_missing)
442 notify_client_chk_result (sc, sr);
444 notify_client_chk_update (sc, sr);
445 GNUNET_FS_search_result_sync_ (sr);
446 GNUNET_FS_search_start_probe_ (sr);
451 * Start search for content, internal API.
453 * @param h handle to the file sharing subsystem
454 * @param uri specifies the search parameters; can be
455 * a KSK URI or an SKS URI.
456 * @param anonymity desired level of anonymity
457 * @param options options for the search
458 * @param cctx client context
459 * @param psearch parent search result (for namespace update searches)
460 * @return context that can be used to control the search
462 static struct GNUNET_FS_SearchContext *
463 search_start (struct GNUNET_FS_Handle *h,
464 const struct GNUNET_FS_Uri *uri,
466 enum GNUNET_FS_SearchOptions options,
468 struct GNUNET_FS_SearchResult *psearch);
472 * We have received an SKS result. Start searching for updates and
473 * notify the client if it is a new result.
475 * @param sc context for the overall query
476 * @param id_update identifier for updates, NULL for none
477 * @param uri the URI that was found
478 * @param meta metadata associated with the URI
481 process_sks_result (struct GNUNET_FS_SearchContext *sc,
482 const char *id_update,
483 const struct GNUNET_FS_Uri *uri,
484 const struct GNUNET_CONTAINER_MetaData *meta)
486 struct GNUNET_FS_Uri uu;
488 struct GNUNET_FS_SearchResult *sr;
491 GNUNET_FS_uri_to_key (uri, &key);
492 GNUNET_CRYPTO_hash_xor (&uri->data.chk.chk.key,
493 &uri->data.chk.chk.query,
496 GNUNET_CONTAINER_multihashmap_get_multiple (sc->master_result_map,
498 &test_result_present,
500 return; /* duplicate result */
501 sr = GNUNET_malloc (sizeof (struct GNUNET_FS_SearchResult));
503 sr->uri = GNUNET_FS_uri_dup (uri);
504 sr->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
506 GNUNET_CONTAINER_multihashmap_put (sc->master_result_map,
509 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
510 GNUNET_FS_search_result_sync_ (sr);
511 GNUNET_FS_search_start_probe_ (sr);
513 notify_client_chk_result (sc, sr);
514 /* search for updates */
515 if (strlen (id_update) == 0)
516 return; /* no updates */
518 uu.data.sks.namespace = sc->uri->data.sks.namespace;
519 uu.data.sks.identifier = GNUNET_strdup (id_update);
520 (void) search_start (sc->h,
526 GNUNET_free (uu.data.sks.identifier);
531 * Process a keyword-search result.
533 * @param sc our search context
534 * @param kb the kblock
535 * @param size size of kb
538 process_kblock (struct GNUNET_FS_SearchContext *sc,
539 const struct KBlock *kb,
545 char pt[size - sizeof (struct KBlock)];
546 struct GNUNET_CRYPTO_AesSessionKey skey;
547 struct GNUNET_CRYPTO_AesInitializationVector iv;
549 struct GNUNET_CONTAINER_MetaData *meta;
550 struct GNUNET_FS_Uri *uri;
553 GNUNET_CRYPTO_hash (&kb->keyspace,
554 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
557 for (i=0;i<sc->uri->data.ksk.keywordCount;i++)
559 &sc->requests[i].query,
560 sizeof (GNUNET_HashCode)))
562 if (i == sc->uri->data.ksk.keywordCount)
564 /* oops, does not match any of our keywords!? */
569 GNUNET_CRYPTO_hash_to_aes_key (&sc->requests[i].key, &skey, &iv);
570 if (-1 == GNUNET_CRYPTO_aes_decrypt (&kb[1],
571 size - sizeof (struct KBlock),
580 eos = memchr (pt, 0, sizeof (pt));
587 if (sizeof (pt) == j)
588 meta = GNUNET_CONTAINER_meta_data_create ();
590 meta = GNUNET_CONTAINER_meta_data_deserialize (&pt[j],
594 GNUNET_break_op (0); /* kblock malformed */
597 uri = GNUNET_FS_uri_parse (pt, &emsg);
600 GNUNET_break_op (0); /* kblock malformed */
601 GNUNET_free_non_null (emsg);
602 GNUNET_CONTAINER_meta_data_destroy (meta);
606 process_ksk_result (sc, &sc->requests[i], uri, meta);
609 GNUNET_CONTAINER_meta_data_destroy (meta);
610 GNUNET_FS_uri_destroy (uri);
615 * Process a keyword-search result with a namespace advertisment.
617 * @param sc our search context
618 * @param nb the nblock
619 * @param size size of nb
622 process_nblock (struct GNUNET_FS_SearchContext *sc,
623 const struct NBlock *nb,
629 char pt[size - sizeof (struct NBlock)];
630 struct GNUNET_CRYPTO_AesSessionKey skey;
631 struct GNUNET_CRYPTO_AesInitializationVector iv;
633 struct GNUNET_CONTAINER_MetaData *meta;
634 struct GNUNET_FS_Uri *uri;
637 GNUNET_CRYPTO_hash (&nb->keyspace,
638 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
641 for (i=0;i<sc->uri->data.ksk.keywordCount;i++)
643 &sc->requests[i].query,
644 sizeof (GNUNET_HashCode)))
646 if (i == sc->uri->data.ksk.keywordCount)
648 /* oops, does not match any of our keywords!? */
653 GNUNET_CRYPTO_hash_to_aes_key (&sc->requests[i].key, &skey, &iv);
654 if (-1 == GNUNET_CRYPTO_aes_decrypt (&nb[1],
655 size - sizeof (struct NBlock),
664 eos = memchr (pt, 0, sizeof (pt));
671 if (sizeof (pt) == j)
672 meta = GNUNET_CONTAINER_meta_data_create ();
674 meta = GNUNET_CONTAINER_meta_data_deserialize (&pt[j],
678 GNUNET_break_op (0); /* nblock malformed */
682 uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
684 uri->data.sks.identifier = GNUNET_strdup (pt);
685 GNUNET_CRYPTO_hash (&nb->subspace,
686 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
687 &uri->data.sks.namespace);
688 uris = GNUNET_FS_uri_to_string (uri);
689 GNUNET_CONTAINER_meta_data_insert (meta,
691 EXTRACTOR_METATYPE_URI,
692 EXTRACTOR_METAFORMAT_UTF8,
697 GNUNET_PSEUDONYM_add (sc->h->cfg,
698 &uri->data.sks.namespace,
701 process_ksk_result (sc, &sc->requests[i], uri, meta);
704 GNUNET_CONTAINER_meta_data_destroy (meta);
705 GNUNET_FS_uri_destroy (uri);
710 * Process a namespace-search result.
712 * @param sc our search context
713 * @param sb the sblock
714 * @param size size of sb
717 process_sblock (struct GNUNET_FS_SearchContext *sc,
718 const struct SBlock *sb,
721 size_t len = size - sizeof (struct SBlock);
723 struct GNUNET_CRYPTO_AesSessionKey skey;
724 struct GNUNET_CRYPTO_AesInitializationVector iv;
725 struct GNUNET_FS_Uri *uri;
726 struct GNUNET_CONTAINER_MetaData *meta;
735 identifier = sc->uri->data.sks.identifier;
736 GNUNET_CRYPTO_hash (identifier,
739 GNUNET_CRYPTO_hash_to_aes_key (&key, &skey, &iv);
740 if (-1 == GNUNET_CRYPTO_aes_decrypt (&sb[1],
750 off = GNUNET_STRINGS_buffer_tokenize (pt,
757 GNUNET_break_op (0); /* sblock malformed */
760 meta = GNUNET_CONTAINER_meta_data_deserialize (&pt[off],
764 GNUNET_break_op (0); /* sblock malformed */
767 uri = GNUNET_FS_uri_parse (uris, &emsg);
770 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
771 "Failed to parse URI `%s': %s\n",
773 GNUNET_break_op (0); /* sblock malformed */
774 GNUNET_free_non_null (emsg);
775 GNUNET_CONTAINER_meta_data_destroy (meta);
779 process_sks_result (sc, id, uri, meta);
781 GNUNET_FS_uri_destroy (uri);
782 GNUNET_CONTAINER_meta_data_destroy (meta);
787 * Process a search result.
789 * @param sc our search context
790 * @param type type of the result
791 * @param expiration when it will expire
792 * @param data the (encrypted) response
793 * @param size size of data
796 process_result (struct GNUNET_FS_SearchContext *sc,
797 enum GNUNET_BLOCK_Type type,
798 struct GNUNET_TIME_Absolute expiration,
802 if (GNUNET_TIME_absolute_get_duration (expiration).rel_value > 0)
804 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
805 "Result received has already expired.\n");
806 return; /* result expired */
810 case GNUNET_BLOCK_TYPE_FS_KBLOCK:
811 if (! GNUNET_FS_uri_test_ksk (sc->uri))
816 if (sizeof (struct KBlock) > size)
821 process_kblock (sc, data, size);
823 case GNUNET_BLOCK_TYPE_FS_SBLOCK:
824 if (! GNUNET_FS_uri_test_sks (sc->uri))
829 if (sizeof (struct SBlock) > size)
834 process_sblock (sc, data, size);
836 case GNUNET_BLOCK_TYPE_FS_NBLOCK:
837 if (! GNUNET_FS_uri_test_ksk (sc->uri))
842 if (sizeof (struct NBlock) > size)
847 process_nblock (sc, data, size);
849 case GNUNET_BLOCK_TYPE_ANY:
850 case GNUNET_BLOCK_TYPE_FS_DBLOCK:
851 case GNUNET_BLOCK_TYPE_FS_ONDEMAND:
852 case GNUNET_BLOCK_TYPE_FS_IBLOCK:
856 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
857 _("Got result with unknown block type `%d', ignoring"),
865 * Shutdown any existing connection to the FS
866 * service and try to establish a fresh one
867 * (and then re-transmit our search request).
869 * @param sc the search to reconnec
872 try_reconnect (struct GNUNET_FS_SearchContext *sc);
876 * Type of a function to call when we receive a message
880 * @param msg message received, NULL on timeout or fatal error
883 receive_results (void *cls,
884 const struct GNUNET_MessageHeader * msg)
886 struct GNUNET_FS_SearchContext *sc = cls;
887 const struct PutMessage *cm;
890 if ( (NULL == msg) ||
891 (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_FS_PUT) ||
892 (ntohs (msg->size) <= sizeof (struct PutMessage)) )
897 msize = ntohs (msg->size);
898 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
899 "Receiving %u bytes of result from fs service\n",
901 cm = (const struct PutMessage*) msg;
904 GNUNET_TIME_absolute_ntoh (cm->expiration),
906 msize - sizeof (struct PutMessage));
907 /* continue receiving */
908 GNUNET_CLIENT_receive (sc->client,
911 GNUNET_TIME_UNIT_FOREVER_REL);
916 * We're ready to transmit the search request to the
917 * file-sharing service. Do it.
920 * @param size number of bytes available in buf
921 * @param buf where the callee should write the message
922 * @return number of bytes written to buf
925 transmit_search_request (void *cls,
929 struct GNUNET_FS_SearchContext *sc = cls;
931 struct SearchMessage *sm;
933 const char *identifier;
942 if (GNUNET_FS_uri_test_ksk (sc->uri))
944 msize = sizeof (struct SearchMessage) * sc->uri->data.ksk.keywordCount;
945 GNUNET_assert (size >= msize);
947 memset (sm, 0, msize);
948 for (i=0;i<sc->uri->data.ksk.keywordCount;i++)
950 sm[i].header.size = htons (sizeof (struct SearchMessage));
951 sm[i].header.type = htons (GNUNET_MESSAGE_TYPE_FS_START_SEARCH);
952 if (0 != (sc->options & GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY))
953 sm[i].options = htonl (1);
955 sm[i].options = htonl (0);
956 sm[i].type = htonl (GNUNET_BLOCK_TYPE_ANY);
957 sm[i].anonymity_level = htonl (sc->anonymity);
958 sm[i].query = sc->requests[i].query;
959 /* FIXME: should transmit hash codes of all already-known results here!
960 (and if they do not fit, add another message with the same
961 header and additional already-seen results!) */
966 GNUNET_assert (GNUNET_FS_uri_test_sks (sc->uri));
967 msize = sizeof (struct SearchMessage);
968 GNUNET_assert (size >= msize);
970 memset (sm, 0, msize);
971 sm->header.size = htons (sizeof (struct SearchMessage));
972 sm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_START_SEARCH);
973 if (0 != (sc->options & GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY))
974 sm->options = htonl (1);
976 sm->options = htonl (0);
977 sm->type = htonl (GNUNET_BLOCK_TYPE_FS_SBLOCK);
978 sm->anonymity_level = htonl (sc->anonymity);
979 sm->target = sc->uri->data.sks.namespace;
980 identifier = sc->uri->data.sks.identifier;
981 GNUNET_CRYPTO_hash (identifier,
984 GNUNET_CRYPTO_hash (&key,
985 sizeof (GNUNET_HashCode),
987 GNUNET_CRYPTO_hash_xor (&idh,
990 /* FIXME: should transmit hash codes of all already-known results here!
991 (and if they do not fit, add another message with the same
992 header and additional already-seen results!) */
994 GNUNET_CLIENT_receive (sc->client,
997 GNUNET_TIME_UNIT_FOREVER_REL);
1003 * Reconnect to the FS service and transmit
1006 * @param cls our search context
1010 do_reconnect (void *cls,
1011 const struct GNUNET_SCHEDULER_TaskContext *tc)
1013 struct GNUNET_FS_SearchContext *sc = cls;
1014 struct GNUNET_CLIENT_Connection *client;
1017 sc->task = GNUNET_SCHEDULER_NO_TASK;
1018 client = GNUNET_CLIENT_connect ("fs",
1025 sc->client = client;
1026 if (GNUNET_FS_uri_test_ksk (sc->uri))
1027 size = sizeof (struct SearchMessage) * sc->uri->data.ksk.keywordCount;
1029 size = sizeof (struct SearchMessage);
1030 GNUNET_CLIENT_notify_transmit_ready (client,
1032 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1034 &transmit_search_request,
1040 * Shutdown any existing connection to the FS
1041 * service and try to establish a fresh one
1042 * (and then re-transmit our search request).
1044 * @param sc the search to reconnec
1047 try_reconnect (struct GNUNET_FS_SearchContext *sc)
1049 if (NULL != sc->client)
1051 GNUNET_CLIENT_disconnect (sc->client, GNUNET_NO);
1055 = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
1062 * Start search for content, internal API.
1064 * @param h handle to the file sharing subsystem
1065 * @param uri specifies the search parameters; can be
1066 * a KSK URI or an SKS URI.
1067 * @param anonymity desired level of anonymity
1068 * @param options options for the search
1069 * @param cctx initial value for the client context
1070 * @param psearch parent search result (for namespace update searches)
1071 * @return context that can be used to control the search
1073 static struct GNUNET_FS_SearchContext *
1074 search_start (struct GNUNET_FS_Handle *h,
1075 const struct GNUNET_FS_Uri *uri,
1077 enum GNUNET_FS_SearchOptions options,
1079 struct GNUNET_FS_SearchResult *psearch)
1081 struct GNUNET_FS_SearchContext *sc;
1082 struct GNUNET_FS_ProgressInfo pi;
1084 sc = GNUNET_malloc (sizeof(struct GNUNET_FS_SearchContext));
1086 sc->options = options;
1087 sc->uri = GNUNET_FS_uri_dup (uri);
1088 sc->anonymity = anonymity;
1089 sc->start_time = GNUNET_TIME_absolute_get ();
1090 if (psearch != NULL)
1092 sc->psearch_result = psearch;
1093 psearch->update_search = sc;
1095 sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16);
1096 sc->client_info = cctx;
1098 GNUNET_FS_search_start_searching_ (sc))
1100 GNUNET_FS_uri_destroy (sc->uri);
1101 GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
1105 GNUNET_FS_search_sync_ (sc);
1106 pi.status = GNUNET_FS_STATUS_SEARCH_START;
1107 sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
1113 * Build the request and actually initiate the search using the
1114 * GNUnet FS service.
1116 * @param sc search context
1117 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1120 GNUNET_FS_search_start_searching_ (struct GNUNET_FS_SearchContext *sc)
1123 const char *keyword;
1125 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pub;
1126 struct GNUNET_CRYPTO_RsaPrivateKey *pk;
1129 GNUNET_assert (NULL == sc->client);
1130 if (GNUNET_FS_uri_test_ksk (sc->uri))
1132 size = sizeof (struct SearchMessage) * sc->uri->data.ksk.keywordCount;
1136 GNUNET_assert (GNUNET_FS_uri_test_sks (sc->uri));
1137 size = sizeof (struct SearchMessage);
1139 if (size >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
1141 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1142 _("Too many keywords specified for a single search."));
1143 return GNUNET_SYSERR;
1145 if (GNUNET_FS_uri_test_ksk (sc->uri))
1147 GNUNET_assert (0 != sc->uri->data.ksk.keywordCount);
1148 sc->requests = GNUNET_malloc (sizeof (struct SearchRequestEntry) *
1149 sc->uri->data.ksk.keywordCount);
1150 for (i=0;i<sc->uri->data.ksk.keywordCount;i++)
1152 keyword = &sc->uri->data.ksk.keywords[i][1];
1153 GNUNET_CRYPTO_hash (keyword, strlen (keyword), &hc);
1154 pk = GNUNET_CRYPTO_rsa_key_create_from_hash (&hc);
1155 GNUNET_assert (pk != NULL);
1156 GNUNET_CRYPTO_rsa_key_get_public (pk, &pub);
1157 GNUNET_CRYPTO_rsa_key_free (pk);
1158 GNUNET_CRYPTO_hash (&pub,
1159 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
1160 &sc->requests[i].query);
1161 sc->requests[i].mandatory = (sc->uri->data.ksk.keywords[i][0] == '+');
1162 if (sc->requests[i].mandatory)
1163 sc->mandatory_count++;
1164 sc->requests[i].results = GNUNET_CONTAINER_multihashmap_create (4);
1165 GNUNET_CRYPTO_hash (keyword,
1167 &sc->requests[i].key);
1170 sc->client = GNUNET_CLIENT_connect ("fs",
1172 if (NULL == sc->client)
1173 return GNUNET_SYSERR;
1174 GNUNET_CLIENT_notify_transmit_ready (sc->client,
1176 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1178 &transmit_search_request,
1185 * Freeze probes for the given search result.
1187 * @param cls the global FS handle
1188 * @param key the key for the search result (unused)
1189 * @param value the search result to free
1193 search_result_freeze_probes (void *cls,
1194 const GNUNET_HashCode * key,
1197 struct GNUNET_FS_SearchResult *sr = value;
1199 if (sr->probe_ctx != NULL)
1201 GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
1202 sr->probe_ctx = NULL;
1204 if (sr->probe_cancel_task != GNUNET_SCHEDULER_NO_TASK)
1206 GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
1207 sr->probe_cancel_task = GNUNET_SCHEDULER_NO_TASK;
1209 if (sr->update_search != NULL)
1210 GNUNET_FS_search_pause (sr->update_search);
1216 * Resume probes for the given search result.
1218 * @param cls the global FS handle
1219 * @param key the key for the search result (unused)
1220 * @param value the search result to free
1224 search_result_resume_probes (void *cls,
1225 const GNUNET_HashCode * key,
1228 struct GNUNET_FS_SearchResult *sr = value;
1230 GNUNET_FS_search_start_probe_ (sr);
1231 if (sr->update_search != NULL)
1232 GNUNET_FS_search_continue (sr->update_search);
1238 * Signal suspend and free the given search result.
1240 * @param cls the global FS handle
1241 * @param key the key for the search result (unused)
1242 * @param value the search result to free
1246 search_result_suspend (void *cls,
1247 const GNUNET_HashCode * key,
1250 struct GNUNET_FS_SearchContext *sc = cls;
1251 struct GNUNET_FS_SearchResult *sr = value;
1252 struct GNUNET_FS_ProgressInfo pi;
1254 if (sr->download != NULL)
1255 GNUNET_FS_download_signal_suspend_ (sr->download);
1256 if (sr->update_search != NULL)
1257 GNUNET_FS_search_signal_suspend_ (sr->update_search);
1258 pi.status = GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND;
1259 pi.value.search.specifics.result_suspend.cctx = sr->client_info;
1260 pi.value.search.specifics.result_suspend.meta = sr->meta;
1261 pi.value.search.specifics.result_suspend.uri = sr->uri;
1262 sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
1263 GNUNET_break (NULL == sr->client_info);
1264 GNUNET_free_non_null (sr->serialization);
1265 GNUNET_FS_uri_destroy (sr->uri);
1266 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
1267 if (sr->probe_ctx != NULL)
1268 GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
1269 if (sr->probe_cancel_task != GNUNET_SCHEDULER_NO_TASK)
1270 GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
1277 * Create SUSPEND event for the given search operation
1278 * and then clean up our state (without stop signal).
1280 * @param cls the 'struct GNUNET_FS_SearchContext' to signal for
1283 GNUNET_FS_search_signal_suspend_ (void *cls)
1285 struct GNUNET_FS_SearchContext *sc = cls;
1286 struct GNUNET_FS_ProgressInfo pi;
1289 GNUNET_FS_end_top (sc->h, sc->top);
1290 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1291 &search_result_suspend,
1293 pi.status = GNUNET_FS_STATUS_SEARCH_SUSPEND;
1294 sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
1295 GNUNET_break (NULL == sc->client_info);
1296 if (sc->task != GNUNET_SCHEDULER_NO_TASK)
1297 GNUNET_SCHEDULER_cancel (sc->task);
1298 if (NULL != sc->client)
1299 GNUNET_CLIENT_disconnect (sc->client, GNUNET_NO);
1300 GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
1301 if (sc->requests != NULL)
1303 GNUNET_assert (GNUNET_FS_uri_test_ksk (sc->uri));
1304 for (i=0;i<sc->uri->data.ksk.keywordCount;i++)
1305 GNUNET_CONTAINER_multihashmap_destroy (sc->requests[i].results);
1307 GNUNET_free_non_null (sc->requests);
1308 GNUNET_free_non_null (sc->emsg);
1309 GNUNET_FS_uri_destroy (sc->uri);
1310 GNUNET_free_non_null (sc->serialization);
1316 * Start search for content.
1318 * @param h handle to the file sharing subsystem
1319 * @param uri specifies the search parameters; can be
1320 * a KSK URI or an SKS URI.
1321 * @param anonymity desired level of anonymity
1322 * @param options options for the search
1323 * @param cctx initial value for the client context
1324 * @return context that can be used to control the search
1326 struct GNUNET_FS_SearchContext *
1327 GNUNET_FS_search_start (struct GNUNET_FS_Handle *h,
1328 const struct GNUNET_FS_Uri *uri,
1330 enum GNUNET_FS_SearchOptions options,
1333 struct GNUNET_FS_SearchContext *ret;
1334 ret = search_start (h, uri, anonymity, options, cctx, NULL);
1337 ret->top = GNUNET_FS_make_top (h, &GNUNET_FS_search_signal_suspend_, ret);
1345 * @param sc context for the search that should be paused
1348 GNUNET_FS_search_pause (struct GNUNET_FS_SearchContext *sc)
1350 struct GNUNET_FS_ProgressInfo pi;
1352 if (sc->task != GNUNET_SCHEDULER_NO_TASK)
1353 GNUNET_SCHEDULER_cancel (sc->task);
1354 sc->task = GNUNET_SCHEDULER_NO_TASK;
1355 if (NULL != sc->client)
1356 GNUNET_CLIENT_disconnect (sc->client, GNUNET_NO);
1358 GNUNET_FS_search_sync_ (sc);
1359 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1360 &search_result_freeze_probes,
1362 pi.status = GNUNET_FS_STATUS_SEARCH_PAUSED;
1363 sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
1368 * Continue paused search.
1370 * @param sc context for the search that should be resumed
1373 GNUNET_FS_search_continue (struct GNUNET_FS_SearchContext *sc)
1375 struct GNUNET_FS_ProgressInfo pi;
1377 GNUNET_assert (sc->client == NULL);
1378 GNUNET_assert (sc->task == GNUNET_SCHEDULER_NO_TASK);
1379 do_reconnect (sc, NULL);
1380 GNUNET_FS_search_sync_ (sc);
1381 pi.status = GNUNET_FS_STATUS_SEARCH_CONTINUED;
1382 sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
1383 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1384 &search_result_resume_probes,
1390 * Free the given search result.
1392 * @param cls the global FS handle
1393 * @param key the key for the search result (unused)
1394 * @param value the search result to free
1398 search_result_free (void *cls,
1399 const GNUNET_HashCode * key,
1402 struct GNUNET_FS_SearchContext *sc = cls;
1403 struct GNUNET_FS_SearchResult *sr = value;
1404 struct GNUNET_FS_ProgressInfo pi;
1406 if (NULL != sr->download)
1408 sr->download->search = NULL;
1409 sr->download->top = GNUNET_FS_make_top (sr->download->h,
1410 &GNUNET_FS_download_signal_suspend_,
1412 if (NULL != sr->download->serialization)
1414 GNUNET_FS_remove_sync_file_ (sc->h,
1415 GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD,
1416 sr->download->serialization);
1417 GNUNET_free (sr->download->serialization);
1418 sr->download->serialization = NULL;
1420 pi.status = GNUNET_FS_STATUS_DOWNLOAD_LOST_PARENT;
1421 GNUNET_FS_download_make_status_ (&pi,
1423 GNUNET_FS_download_sync_ (sr->download);
1424 sr->download = NULL;
1426 if (NULL != sr->update_search)
1428 GNUNET_FS_search_stop (sr->update_search);
1429 GNUNET_assert (sr->update_search == NULL);
1431 pi.status = GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED;
1432 pi.value.search.specifics.result_stopped.cctx = sr->client_info;
1433 pi.value.search.specifics.result_stopped.meta = sr->meta;
1434 pi.value.search.specifics.result_stopped.uri = sr->uri;
1435 sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
1436 GNUNET_break (NULL == sr->client_info);
1437 GNUNET_free_non_null (sr->serialization);
1438 GNUNET_FS_uri_destroy (sr->uri);
1439 GNUNET_CONTAINER_meta_data_destroy (sr->meta);
1440 if (sr->probe_ctx != NULL)
1441 GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
1442 if (sr->probe_cancel_task != GNUNET_SCHEDULER_NO_TASK)
1443 GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
1450 * Stop search for content.
1452 * @param sc context for the search that should be stopped
1455 GNUNET_FS_search_stop (struct GNUNET_FS_SearchContext *sc)
1457 struct GNUNET_FS_ProgressInfo pi;
1460 if (sc->top != NULL)
1461 GNUNET_FS_end_top (sc->h, sc->top);
1462 if (sc->psearch_result != NULL)
1463 sc->psearch_result->update_search = NULL;
1464 GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1465 &search_result_free,
1467 if (sc->serialization != NULL)
1469 GNUNET_FS_remove_sync_file_ (sc->h,
1470 (sc->psearch_result != NULL)
1471 ? GNUNET_FS_SYNC_PATH_CHILD_SEARCH
1472 : GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
1474 GNUNET_FS_remove_sync_dir_ (sc->h,
1475 (sc->psearch_result != NULL)
1476 ? GNUNET_FS_SYNC_PATH_CHILD_SEARCH
1477 : GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
1479 GNUNET_free (sc->serialization);
1481 pi.status = GNUNET_FS_STATUS_SEARCH_STOPPED;
1482 sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc);
1483 GNUNET_break (NULL == sc->client_info);
1484 if (sc->task != GNUNET_SCHEDULER_NO_TASK)
1485 GNUNET_SCHEDULER_cancel (sc->task);
1486 if (NULL != sc->client)
1487 GNUNET_CLIENT_disconnect (sc->client, GNUNET_NO);
1488 GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
1489 if (sc->requests != NULL)
1491 GNUNET_assert (GNUNET_FS_uri_test_ksk (sc->uri));
1492 for (i=0;i<sc->uri->data.ksk.keywordCount;i++)
1493 GNUNET_CONTAINER_multihashmap_destroy (sc->requests[i].results);
1495 GNUNET_free_non_null (sc->requests);
1496 GNUNET_free_non_null (sc->emsg);
1497 GNUNET_FS_uri_destroy (sc->uri);
1501 /* end of fs_search.c */