2 This file is part of GNUnet
3 Copyright (C) 2012, 2013, 2016 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
19 * @file regex/regex_api_search.c
20 * @brief access regex service to discover
21 * peers using matching strings
22 * @author Maximilian Szengel
23 * @author Christian Grothoff
26 #include "gnunet_protocols.h"
27 #include "gnunet_util_lib.h"
28 #include "gnunet_regex_service.h"
29 #include "regex_ipc.h"
31 #define LOG(kind,...) GNUNET_log_from (kind, "regex-api",__VA_ARGS__)
35 * Handle to store data about a regex search.
37 struct GNUNET_REGEX_Search
40 * Connection to the regex service.
42 struct GNUNET_MQ_Handle *mq;
47 const struct GNUNET_CONFIGURATION_Handle *cfg;
50 * Function to call with results.
52 GNUNET_REGEX_Found callback;
55 * Closure for @e callback.
60 * Search string to transmit to the service.
67 * (Re)connect to the REGEX service for the given search @a s.
69 * @param s context for the search search for
72 search_reconnect (struct GNUNET_REGEX_Search *s);
76 * We got a response or disconnect after asking regex
77 * to do the search. Check it is well-formed.
79 * @param cls the `struct GNUNET_REGEX_Search` to handle reply for
80 * @param result the message
81 * @return #GNUNET_SYSERR if @a rm is not well-formed.
84 check_search_response (void *cls,
85 const struct ResultMessage *result)
87 uint16_t size = ntohs (result->header.size) - sizeof (*result);
88 uint16_t gpl = ntohs (result->get_path_length);
89 uint16_t ppl = ntohs (result->put_path_length);
91 if (size != (gpl + ppl) * sizeof (struct GNUNET_PeerIdentity))
101 * We got a response or disconnect after asking regex
102 * to do the search. Handle it.
104 * @param cls the `struct GNUNET_REGEX_Search` to handle reply for
105 * @param result the message
108 handle_search_response (void *cls,
109 const struct ResultMessage *result)
111 struct GNUNET_REGEX_Search *s = cls;
112 uint16_t gpl = ntohs (result->get_path_length);
113 uint16_t ppl = ntohs (result->put_path_length);
114 const struct GNUNET_PeerIdentity *pid;
117 LOG (GNUNET_ERROR_TYPE_DEBUG,
118 "Got regex result %s\n",
120 s->callback (s->callback_cls,
130 * We got a disconnect after asking regex to do the announcement.
133 * @param cls the `struct GNUNET_REGEX_Search` to retry
134 * @param error error code
137 mq_error_handler (void *cls,
138 enum GNUNET_MQ_Error error)
140 struct GNUNET_REGEX_Search *s = cls;
142 GNUNET_MQ_destroy (s->mq);
144 search_reconnect (s);
149 * (Re)connect to the REGEX service for the given search @a s.
151 * @param s context for the search search for
154 search_reconnect (struct GNUNET_REGEX_Search *s)
156 struct GNUNET_MQ_MessageHandler handlers[] = {
157 GNUNET_MQ_hd_var_size (search_response,
158 GNUNET_MESSAGE_TYPE_REGEX_RESULT,
159 struct ResultMessage,
161 GNUNET_MQ_handler_end ()
163 size_t slen = strlen (s->string) + 1;
164 struct GNUNET_MQ_Envelope *env;
165 struct RegexSearchMessage *rsm;
167 GNUNET_assert (NULL == s->mq);
168 s->mq = GNUNET_CLIENT_connect (s->cfg,
175 env = GNUNET_MQ_msg_extra (rsm,
177 GNUNET_MESSAGE_TYPE_REGEX_SEARCH);
178 GNUNET_memcpy (&rsm[1],
181 GNUNET_MQ_send (s->mq,
187 * Search for a peer offering a regex matching certain string in the DHT.
188 * The search runs until #GNUNET_REGEX_search_cancel() is called, even if results
191 * @param cfg configuration to use
192 * @param string String to match against the regexes in the DHT.
193 * @param callback Callback for found peers.
194 * @param callback_cls Closure for @c callback.
195 * @return Handle to stop search and free resources.
196 * Must be freed by calling #GNUNET_REGEX_search_cancel().
198 struct GNUNET_REGEX_Search *
199 GNUNET_REGEX_search (const struct GNUNET_CONFIGURATION_Handle *cfg,
201 GNUNET_REGEX_Found callback,
204 struct GNUNET_REGEX_Search *s;
205 size_t slen = strlen (string) + 1;
207 if (slen + sizeof (struct RegexSearchMessage) >= GNUNET_MAX_MESSAGE_SIZE)
209 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
210 _("Search string `%s' is too long!\n"),
215 LOG (GNUNET_ERROR_TYPE_DEBUG,
216 "Starting regex search for %s\n",
218 s = GNUNET_new (struct GNUNET_REGEX_Search);
220 s->string = GNUNET_strdup (string);
221 s->callback = callback;
222 s->callback_cls = callback_cls;
223 search_reconnect (s);
226 GNUNET_free (s->string);
235 * Stop search and free all data used by a #GNUNET_REGEX_search() call.
237 * @param s Handle returned by a previous #GNUNET_REGEX_search() call.
240 GNUNET_REGEX_search_cancel (struct GNUNET_REGEX_Search *s)
242 GNUNET_MQ_destroy (s->mq);
243 GNUNET_free (s->string);
248 /* end of regex_api_search.c */