not needed anymore
[oweals/gnunet.git] / src / transport / gnunet-service-transport_clients.c
1 /*
2      This file is part of GNUnet.
3      (C) 2010,2011 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 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file transport/gnunet-service-transport_clients.c
23  * @brief plugin management API
24  * @author Christian Grothoff
25  */
26 #include "platform.h"
27 #include "gnunet-service-transport_blacklist.h"
28 #include "gnunet-service-transport_clients.h"
29 #include "gnunet-service-transport_hello.h"
30 #include "gnunet-service-transport_neighbours.h"
31 #include "gnunet-service-transport_plugins.h"
32 #include "gnunet-service-transport_validation.h"
33 #include "gnunet-service-transport.h"
34 #include "transport.h"
35
36 /**
37  * How many messages can we have pending for a given client process
38  * before we start to drop incoming messages?  We typically should
39  * have only one client and so this would be the primary buffer for
40   * messages, so the number should be chosen rather generously.
41  *
42  * The expectation here is that most of the time the queue is large
43  * enough so that a drop is virtually never required.  Note that
44  * this value must be about as large as 'TOTAL_MSGS' in the
45  * 'test_transport_api_reliability.c', otherwise that testcase may
46  * fail.
47  */
48 #define MAX_PENDING (128 * 1024)
49
50
51 /**
52  * Linked list of messages to be transmitted to the client.  Each
53  * entry is followed by the actual message.
54  */
55 struct ClientMessageQueueEntry
56 {
57   /**
58    * This is a doubly-linked list.
59    */
60   struct ClientMessageQueueEntry *next;
61
62   /**
63    * This is a doubly-linked list.
64    */
65   struct ClientMessageQueueEntry *prev;
66 };
67
68
69 /**
70  * Client connected to the transport service.
71  */
72 struct TransportClient
73 {
74
75   /**
76    * This is a doubly-linked list.
77    */
78   struct TransportClient *next;
79
80   /**
81    * This is a doubly-linked list.
82    */
83   struct TransportClient *prev;
84
85   /**
86    * Handle to the client.
87    */
88   struct GNUNET_SERVER_Client *client;
89
90   /**
91    * Linked list of messages yet to be transmitted to
92    * the client.
93    */
94   struct ClientMessageQueueEntry *message_queue_head;
95
96   /**
97    * Tail of linked list of messages yet to be transmitted to the
98    * client.
99    */
100   struct ClientMessageQueueEntry *message_queue_tail;
101
102   /**
103    * Current transmit request handle.
104    */
105   struct GNUNET_CONNECTION_TransmitHandle *th;
106
107   /**
108    * Length of the list of messages pending for this client.
109    */
110   unsigned int message_count;
111 };
112
113
114 /**
115  * Head of linked list of all clients to this service.
116  */
117 static struct TransportClient *clients_head;
118
119 /**
120  * Tail of linked list of all clients to this service.
121  */
122 static struct TransportClient *clients_tail;
123
124 /**
125  * Find the internal handle associated with the given client handle
126  *
127  * @param client server's client handle to look up
128  * @return internal client handle
129  */
130 static struct TransportClient *
131 lookup_client (struct GNUNET_SERVER_Client *client)
132 {
133   struct TransportClient *tc;
134
135   tc = clients_head;
136   while (tc != NULL)
137   {
138     if (tc->client == client)
139       return tc;
140     tc = tc->next;
141   }
142   return NULL;
143 }
144
145
146 /**
147  * Create the internal handle for the given server client handle
148  *
149  * @param client server's client handle to create our internal handle for
150  * @return fresh internal client handle
151  */
152 static struct TransportClient *
153 setup_client (struct GNUNET_SERVER_Client *client)
154 {
155   struct TransportClient *tc;
156
157   GNUNET_assert (lookup_client (client) == NULL);
158
159   tc = GNUNET_malloc (sizeof (struct TransportClient));
160   tc->client = client;
161
162   GNUNET_CONTAINER_DLL_insert (clients_head, clients_tail, tc);
163   return tc;
164 }
165
166
167 /**
168  * Function called to notify a client about the socket being ready to
169  * queue more data.  "buf" will be NULL and "size" zero if the socket
170  * was closed for writing in the meantime.
171  *
172  * @param cls closure
173  * @param size number of bytes available in buf
174  * @param buf where the callee should write the message
175  * @return number of bytes written to buf
176  */
177 static size_t
178 transmit_to_client_callback (void *cls, size_t size, void *buf)
179 {
180   struct TransportClient *tc = cls;
181   struct ClientMessageQueueEntry *q;
182   const struct GNUNET_MessageHeader *msg;
183   char *cbuf;
184   uint16_t msize;
185   size_t tsize;
186
187   tc->th = NULL;
188   if (buf == NULL)
189   {
190 #if DEBUG_TRANSPORT
191     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
192                 "Transmission to client failed, closing connection.\n");
193 #endif
194     return 0;
195   }
196   cbuf = buf;
197   tsize = 0;
198   while (NULL != (q = tc->message_queue_head))
199   {
200     msg = (const struct GNUNET_MessageHeader *) &q[1];
201     msize = ntohs (msg->size);
202     if (msize + tsize > size)
203       break;
204 #if DEBUG_TRANSPORT
205     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
206                 "Transmitting message of type %u to client %X.\n",
207                 ntohs (msg->type), tc);
208 #endif
209     GNUNET_CONTAINER_DLL_remove (tc->message_queue_head, tc->message_queue_tail,
210                                  q);
211     tc->message_count--;
212     memcpy (&cbuf[tsize], msg, msize);
213     GNUNET_free (q);
214     tsize += msize;
215   }
216   if (NULL != q)
217   {
218     GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
219     tc->th =
220         GNUNET_SERVER_notify_transmit_ready (tc->client, msize,
221                                              GNUNET_TIME_UNIT_FOREVER_REL,
222                                              &transmit_to_client_callback, tc);
223     GNUNET_assert (tc->th != NULL);
224   }
225   return tsize;
226 }
227
228
229 /**
230  * Queue the given message for transmission to the given client
231  *
232  * @param client target of the message
233  * @param msg message to transmit
234  * @param may_drop GNUNET_YES if the message can be dropped
235  */
236 static void
237 unicast (struct TransportClient *tc, const struct GNUNET_MessageHeader *msg,
238          int may_drop)
239 {
240   struct ClientMessageQueueEntry *q;
241   uint16_t msize;
242
243   if ((tc->message_count >= MAX_PENDING) && (GNUNET_YES == may_drop))
244   {
245     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
246                 _
247                 ("Dropping message of type %u and size %u, have %u/%u messages pending\n"),
248                 ntohs (msg->type), ntohs (msg->size), tc->message_count,
249                 MAX_PENDING);
250     GNUNET_STATISTICS_update (GST_stats,
251                               gettext_noop
252                               ("# messages dropped due to slow client"), 1,
253                               GNUNET_NO);
254     return;
255   }
256   msize = ntohs (msg->size);
257   GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
258   q = GNUNET_malloc (sizeof (struct ClientMessageQueueEntry) + msize);
259   memcpy (&q[1], msg, msize);
260   GNUNET_CONTAINER_DLL_insert_tail (tc->message_queue_head,
261                                     tc->message_queue_tail, q);
262   tc->message_count++;
263   if (tc->th != NULL)
264     return;
265   tc->th =
266       GNUNET_SERVER_notify_transmit_ready (tc->client, msize,
267                                            GNUNET_TIME_UNIT_FOREVER_REL,
268                                            &transmit_to_client_callback, tc);
269   GNUNET_assert (tc->th != NULL);
270 }
271
272
273 /**
274  * Called whenever a client is disconnected.  Frees our
275  * resources associated with that client.
276  *
277  * @param cls closure
278  * @param client identification of the client
279  */
280 static void
281 client_disconnect_notification (void *cls, struct GNUNET_SERVER_Client *client)
282 {
283   struct TransportClient *tc;
284   struct ClientMessageQueueEntry *mqe;
285
286   if (client == NULL)
287     return;
288   tc = lookup_client (client);
289   if (tc == NULL)
290     return;
291 #if DEBUG_TRANSPORT
292   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
293               "Client %X disconnected, cleaning up.\n", tc);
294 #endif
295   while (NULL != (mqe = tc->message_queue_head))
296   {
297     GNUNET_CONTAINER_DLL_remove (tc->message_queue_head, tc->message_queue_tail,
298                                  mqe);
299     tc->message_count--;
300     GNUNET_free (mqe);
301   }
302   GNUNET_CONTAINER_DLL_remove (clients_head, clients_tail, tc);
303   if (tc->th != NULL)
304   {
305     GNUNET_CONNECTION_notify_transmit_ready_cancel (tc->th);
306     tc->th = NULL;
307   }
308   GNUNET_break (0 == tc->message_count);
309   GNUNET_free (tc);
310 }
311
312
313 /**
314  * Function called for each of our connected neighbours.  Notify the
315  * client about the existing neighbour.
316  *
317  * @param cls the 'struct TransportClient' to notify
318  * @param peer identity of the neighbour
319  * @param ats performance data
320  * @param ats_count number of entries in ats (excluding 0-termination)
321  */
322 static void
323 notify_client_about_neighbour (void *cls,
324                                const struct GNUNET_PeerIdentity *peer,
325                                const struct GNUNET_TRANSPORT_ATS_Information
326                                *ats, uint32_t ats_count)
327 {
328   struct TransportClient *tc = cls;
329   struct ConnectInfoMessage *cim;
330   size_t size;
331
332   size =
333       sizeof (struct ConnectInfoMessage) +
334       ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information);
335   GNUNET_assert (size < GNUNET_SERVER_MAX_MESSAGE_SIZE);
336   cim = GNUNET_malloc (size);
337   cim->header.size = htons (size);
338   cim->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
339   cim->ats_count = htonl (ats_count);
340   cim->id = *peer;
341   memcpy (&cim->ats, ats,
342           ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
343   unicast (tc, &cim->header, GNUNET_NO);
344   GNUNET_free (cim);
345 }
346
347
348 /**
349  * Initialize a normal client.  We got a start message from this
350  * client, add him to the list of clients for broadcasting of inbound
351  * messages.
352  *
353  * @param cls unused
354  * @param client the client
355  * @param message the start message that was sent
356  */
357 static void
358 clients_handle_start (void *cls, struct GNUNET_SERVER_Client *client,
359                       const struct GNUNET_MessageHeader *message)
360 {
361   const struct StartMessage *start;
362   struct TransportClient *tc;
363
364   tc = lookup_client (client);
365
366 #if DEBUG_TRANSPORT
367   if (tc != NULL)
368     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
369                 "Client %X sent START\n", tc);
370   else
371     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
372                 "Client %X sent START\n", tc);
373 #endif
374   if (tc != NULL)
375   {
376     /* got 'start' twice from the same client, not allowed */
377 #if DEBUG_TRANSPORT
378     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
379                 "TransportClient %X ServerClient %X  sent multiple START messages\n",
380                 tc,
381                 tc->client);
382 #endif
383     GNUNET_break (0);
384     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
385     return;
386   }
387   start = (const struct StartMessage *) message;
388   if ((GNUNET_NO != ntohl (start->do_check)) &&
389       (0 !=
390        memcmp (&start->self, &GST_my_identity,
391                sizeof (struct GNUNET_PeerIdentity))))
392   {
393     /* client thinks this is a different peer, reject */
394     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
395                 _
396                 ("Rejecting control connection from peer `%s', which is not me!\n"),
397                 GNUNET_i2s (&start->self));
398     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
399     return;
400   }
401   tc = setup_client (client);
402
403   unicast (tc, GST_hello_get (), GNUNET_NO);
404   GST_neighbours_iterate (&notify_client_about_neighbour, tc);
405   GNUNET_SERVER_receive_done (client, GNUNET_OK);
406 }
407
408
409 /**
410  * Client sent us a HELLO.  Process the request.
411  *
412  * @param cls unused
413  * @param client the client
414  * @param message the HELLO message
415  */
416 static void
417 clients_handle_hello (void *cls, struct GNUNET_SERVER_Client *client,
418                       const struct GNUNET_MessageHeader *message)
419 {
420   GST_validation_handle_hello (message);
421   GNUNET_SERVER_receive_done (client, GNUNET_OK);
422 }
423
424
425 /**
426  * Closure for 'handle_send_transmit_continuation'
427  */
428 struct SendTransmitContinuationContext
429 {
430   /**
431    * Client that made the request.
432    */
433   struct GNUNET_SERVER_Client *client;
434
435   /**
436    * Peer that was the target.
437    */
438   struct GNUNET_PeerIdentity target;
439 };
440
441
442 /**
443  * Function called after the transmission is done.  Notify the client that it is
444  * OK to send the next message.
445  *
446  * @param cls closure
447  * @param success GNUNET_OK on success, GNUNET_NO on failure, GNUNET_SYSERR if we're not connected
448  */
449 static void
450 handle_send_transmit_continuation (void *cls, int success)
451 {
452   struct SendTransmitContinuationContext *stcc = cls;
453   struct SendOkMessage send_ok_msg;
454
455   send_ok_msg.header.size = htons (sizeof (send_ok_msg));
456   send_ok_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK);
457   send_ok_msg.success = htonl (success);
458   send_ok_msg.latency =
459       GNUNET_TIME_relative_hton (GNUNET_TIME_UNIT_FOREVER_REL);
460   send_ok_msg.peer = stcc->target;
461   GST_clients_unicast (stcc->client, &send_ok_msg.header, GNUNET_NO);
462   GNUNET_SERVER_client_drop (stcc->client);
463   GNUNET_free (stcc);
464 }
465
466
467 /**
468  * Client asked for transmission to a peer.  Process the request.
469  *
470  * @param cls unused
471  * @param client the client
472  * @param message the send message that was sent
473  */
474 static void
475 clients_handle_send (void *cls, struct GNUNET_SERVER_Client *client,
476                      const struct GNUNET_MessageHeader *message)
477 {
478   const struct OutboundMessage *obm;
479   const struct GNUNET_MessageHeader *obmm;
480   struct SendTransmitContinuationContext *stcc;
481   uint16_t size;
482   uint16_t msize;
483
484   size = ntohs (message->size);
485   if (size <
486       sizeof (struct OutboundMessage) + sizeof (struct GNUNET_MessageHeader))
487   {
488     GNUNET_break (0);
489     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
490     return;
491   }
492   obm = (const struct OutboundMessage *) message;
493   obmm = (const struct GNUNET_MessageHeader *) &obm[1];
494   msize = size - sizeof (struct OutboundMessage);
495   if (msize < sizeof (struct GNUNET_MessageHeader))
496   {
497     GNUNET_break (0);
498     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
499     return;
500   }
501   GNUNET_STATISTICS_update (GST_stats,
502                             gettext_noop
503                             ("# bytes payload received for other peers"), msize,
504                             GNUNET_NO);
505 #if DEBUG_TRANSPORT
506   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
507               "Received `%s' request from client with target `%4s' and first message of type %u and total size %u\n",
508               "SEND", GNUNET_i2s (&obm->peer), ntohs (obmm->type), msize);
509 #endif
510   if (GNUNET_NO == GST_neighbours_test_connected (&obm->peer))
511   {
512     /* not connected, not allowed to send; can happen due to asynchronous operations */
513 #if DEBUG_TRANSPORT
514     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
515                 "Could not send message to peer `%s': not connected\n",
516                 GNUNET_i2s (&obm->peer));
517 #endif
518     GNUNET_STATISTICS_update (GST_stats,
519                               gettext_noop
520                               ("# bytes payload dropped (other peer was not connected)"),
521                               msize, GNUNET_NO);
522     GNUNET_SERVER_receive_done (client, GNUNET_OK);
523     return;
524   }
525   GNUNET_SERVER_receive_done (client, GNUNET_OK);
526   stcc = GNUNET_malloc (sizeof (struct SendTransmitContinuationContext));
527   stcc->target = obm->peer;
528   stcc->client = client;
529   GNUNET_SERVER_client_keep (client);
530   GST_neighbours_send (&obm->peer, obmm, msize,
531                        GNUNET_TIME_relative_ntoh (obm->timeout),
532                        &handle_send_transmit_continuation, stcc);
533 }
534
535
536 /**
537  * Try to initiate a connection to the given peer if the blacklist
538  * allowed it.
539  *
540  * @param cls closure (unused, NULL)
541  * @param peer identity of peer that was tested
542  * @param result GNUNET_OK if the connection is allowed,
543  *               GNUNET_NO if not
544  */
545 static void
546 try_connect_if_allowed (void *cls, const struct GNUNET_PeerIdentity *peer,
547                         int result)
548 {
549   if (GNUNET_OK != result)
550     return;                     /* not allowed */
551   GST_neighbours_try_connect (peer);
552 }
553
554
555 /**
556  * Handle request connect message
557  *
558  * @param cls closure (always NULL)
559  * @param client identification of the client
560  * @param message the actual message
561  */
562 static void
563 clients_handle_request_connect (void *cls, struct GNUNET_SERVER_Client *client,
564                                 const struct GNUNET_MessageHeader *message)
565 {
566   const struct TransportRequestConnectMessage *trcm =
567       (const struct TransportRequestConnectMessage *) message;
568
569   GNUNET_STATISTICS_update (GST_stats,
570                             gettext_noop
571                             ("# REQUEST CONNECT messages received"), 1,
572                             GNUNET_NO);
573 #if DEBUG_TRANSPORT
574   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
575               "Received a request connect message for peer `%s'\n",
576               GNUNET_i2s (&trcm->peer));
577 #endif
578   (void) GST_blacklist_test_allowed (&trcm->peer, NULL, &try_connect_if_allowed,
579                                      NULL);
580   GNUNET_SERVER_receive_done (client, GNUNET_OK);
581 }
582
583
584 /**
585  * Client asked for a quota change for a particular peer.  Process the request.
586  *
587  * @param cls unused
588  * @param client the client
589  * @param message the quota changing message
590  */
591 static void
592 clients_handle_set_quota (void *cls, struct GNUNET_SERVER_Client *client,
593                           const struct GNUNET_MessageHeader *message)
594 {
595   const struct QuotaSetMessage *qsm;
596
597   qsm = (const struct QuotaSetMessage *) message;
598   GNUNET_STATISTICS_update (GST_stats,
599                             gettext_noop ("# SET QUOTA messages received"), 1,
600                             GNUNET_NO);
601 #if DEBUG_TRANSPORT
602   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
603               "Received `%s' request (new quota %u) from client for peer `%4s'\n",
604               "SET_QUOTA", (unsigned int) ntohl (qsm->quota.value__),
605               GNUNET_i2s (&qsm->peer));
606 #endif
607   GST_neighbours_set_incoming_quota (&qsm->peer, qsm->quota);
608   GNUNET_SERVER_receive_done (client, GNUNET_OK);
609 }
610
611
612 /**
613  * Take the given address and append it to the set of results sent back to
614  * the client.
615  *
616  * @param cls the transmission context used ('struct GNUNET_SERVER_TransmitContext*')
617  * @param address the resolved name, NULL to indicate the last response
618  */
619 static void
620 transmit_address_to_client (void *cls, const char *address)
621 {
622   struct GNUNET_SERVER_TransmitContext *tc = cls;
623
624   if (NULL == address)
625   {
626     GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
627                                                 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
628     GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
629     return;
630   }
631   GNUNET_SERVER_transmit_context_append_data (tc, address, strlen (address) + 1,
632                                               GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
633 }
634
635
636 /**
637  * Client asked to resolve an address.  Process the request.
638  *
639  * @param cls unused
640  * @param client the client
641  * @param message the resolution request
642  */
643 static void
644 clients_handle_address_lookup (void *cls, struct GNUNET_SERVER_Client *client,
645                                const struct GNUNET_MessageHeader *message)
646 {
647   const struct AddressLookupMessage *alum;
648   struct GNUNET_TRANSPORT_PluginFunctions *papi;
649   const char *plugin_name;
650   const char *address;
651   uint32_t address_len;
652   uint16_t size;
653   struct GNUNET_SERVER_TransmitContext *tc;
654   struct GNUNET_TIME_Relative rtimeout;
655   int32_t numeric;
656
657   size = ntohs (message->size);
658   if (size < sizeof (struct AddressLookupMessage))
659   {
660     GNUNET_break (0);
661     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
662     return;
663   }
664   alum = (const struct AddressLookupMessage *) message;
665   address_len = ntohl (alum->addrlen);
666   if (size <= sizeof (struct AddressLookupMessage) + address_len)
667   {
668     GNUNET_break (0);
669     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
670     return;
671   }
672   address = (const char *) &alum[1];
673   plugin_name = (const char *) &address[address_len];
674   if (plugin_name[size - sizeof (struct AddressLookupMessage) - address_len - 1]
675       != '\0')
676   {
677     GNUNET_break (0);
678     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
679     return;
680   }
681   rtimeout = GNUNET_TIME_relative_ntoh (alum->timeout);
682   numeric = ntohl (alum->numeric_only);
683   tc = GNUNET_SERVER_transmit_context_create (client);
684   papi = GST_plugins_find (plugin_name);
685   if (NULL == papi)
686   {
687     GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
688                                                 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
689     GNUNET_SERVER_transmit_context_run (tc, rtimeout);
690     return;
691   }
692   GNUNET_SERVER_disable_receive_done_warning (client);
693   papi->address_pretty_printer (papi->cls, plugin_name, address, address_len,
694                                 numeric, rtimeout, &transmit_address_to_client,
695                                 tc);
696 }
697
698
699 /**
700  * Send an address to the client.
701  *
702  * @param cls our 'struct GNUNET_SERVER_TransmitContext' (for sending)
703  * @param public_key public key for the peer, never NULL
704  * @param target peer this change is about, never NULL
705  * @param valid_until until what time do we consider the address valid?
706  * @param validation_block  is FOREVER if the address is for an unsupported plugin (from PEERINFO)
707  *                          is ZERO if the address is considered valid (no validation needed)
708  *                          is a time in the future if we're currently denying re-validation
709  * @param plugin_name name of the plugin
710  * @param plugin_address binary address
711  * @param plugin_address_len length of address
712  */
713 static void
714 send_address_to_client (void *cls,
715                         const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
716                         *public_key, const struct GNUNET_PeerIdentity *target,
717                         struct GNUNET_TIME_Absolute valid_until,
718                         struct GNUNET_TIME_Absolute validation_block,
719                         const char *plugin_name, const void *plugin_address,
720                         size_t plugin_address_len)
721 {
722   struct GNUNET_SERVER_TransmitContext *tc = cls;
723   char *addr_buf;
724
725   /* FIXME: move to a binary format!!! */
726   GNUNET_asprintf (&addr_buf, "%s --- %s, %s",
727                    GST_plugins_a2s (plugin_name, plugin_address,
728                                     plugin_address_len),
729                    (GNUNET_YES ==
730                     GST_neighbours_test_connected (target)) ? "CONNECTED" :
731                    "DISCONNECTED",
732                    (GNUNET_TIME_absolute_get_remaining (valid_until).rel_value >
733                     0) ? "VALIDATED" : "UNVALIDATED");
734   transmit_address_to_client (tc, addr_buf);
735   GNUNET_free (addr_buf);
736 }
737
738
739 /**
740  * Client asked to obtain information about a peer's addresses.
741  * Process the request.
742  * FIXME: use better name!
743  *
744  * @param cls unused
745  * @param client the client
746  * @param message the peer address information request
747  */
748 static void
749 clients_handle_peer_address_lookup (void *cls,
750                                     struct GNUNET_SERVER_Client *client,
751                                     const struct GNUNET_MessageHeader *message)
752 {
753   const struct PeerAddressLookupMessage *peer_address_lookup;
754   struct GNUNET_SERVER_TransmitContext *tc;
755
756   peer_address_lookup = (const struct PeerAddressLookupMessage *) message;
757   GNUNET_break (ntohl (peer_address_lookup->reserved) == 0);
758   tc = GNUNET_SERVER_transmit_context_create (client);
759   GST_validation_get_addresses (&peer_address_lookup->peer,
760                                 &send_address_to_client, tc);
761   GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
762                                               GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
763   GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
764 }
765
766
767 /**
768  * Output the active address of connected neighbours to the given client.
769  *
770  * @param cls the 'struct GNUNET_SERVER_TransmitContext' for transmission to the client
771  * @param neighbour identity of the neighbour
772  * @param ats performance data
773  * @param ats_count number of entries in ats (excluding 0-termination)
774  */
775 static void
776 output_addresses (void *cls, const struct GNUNET_PeerIdentity *neighbour,
777                   const struct GNUNET_TRANSPORT_ATS_Information *ats,
778                   uint32_t ats_count)
779 {
780   struct GNUNET_SERVER_TransmitContext *tc = cls;
781   char *addr_buf;
782
783   /* FIXME: move to a binary format!!! */
784   GNUNET_asprintf (&addr_buf, "%s: %s", GNUNET_i2s (neighbour),
785                    GST_plugins_a2s ("FIXME", NULL, 0));
786   transmit_address_to_client (tc, addr_buf);
787   GNUNET_free (addr_buf);
788 }
789
790
791 /**
792  * Client asked to obtain information about all actively used addresses.
793  * Process the request.  FIXME: use better name!
794  *
795  * @param cls unused
796  * @param client the client
797  * @param message the peer address information request
798  */
799 static void
800 clients_handle_address_iterate (void *cls, struct GNUNET_SERVER_Client *client,
801                                 const struct GNUNET_MessageHeader *message)
802 {
803   struct GNUNET_SERVER_TransmitContext *tc;
804
805   GNUNET_SERVER_disable_receive_done_warning (client);
806   tc = GNUNET_SERVER_transmit_context_create (client);
807   GST_neighbours_iterate (&output_addresses, tc);
808   GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
809                                               GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
810   GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
811 }
812
813
814 /**
815  * Start handling requests from clients.
816  *
817  * @param server server used to accept clients from.
818  */
819 void
820 GST_clients_start (struct GNUNET_SERVER_Handle *server)
821 {
822   static const struct GNUNET_SERVER_MessageHandler handlers[] = {
823     {&clients_handle_start, NULL,
824      GNUNET_MESSAGE_TYPE_TRANSPORT_START, sizeof (struct StartMessage)},
825     {&clients_handle_hello, NULL,
826      GNUNET_MESSAGE_TYPE_HELLO, 0},
827     {&clients_handle_send, NULL,
828      GNUNET_MESSAGE_TYPE_TRANSPORT_SEND, 0},
829     {&clients_handle_request_connect, NULL,
830      GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT,
831      sizeof (struct TransportRequestConnectMessage)},
832     {&clients_handle_set_quota, NULL,
833      GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA, sizeof (struct QuotaSetMessage)},
834     {&clients_handle_address_lookup, NULL,
835      GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP, 0},
836     {&clients_handle_peer_address_lookup, NULL,
837      GNUNET_MESSAGE_TYPE_TRANSPORT_PEER_ADDRESS_LOOKUP,
838      sizeof (struct PeerAddressLookupMessage)},
839     {&clients_handle_address_iterate, NULL,
840      GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE,
841      sizeof (struct GNUNET_MessageHeader)},
842     {&GST_blacklist_handle_init, NULL,
843      GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_INIT,
844      sizeof (struct GNUNET_MessageHeader)},
845     {&GST_blacklist_handle_reply, NULL,
846      GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY,
847      sizeof (struct BlacklistMessage)},
848     {NULL, NULL, 0, 0}
849   };
850   GNUNET_SERVER_add_handlers (server, handlers);
851   GNUNET_SERVER_disconnect_notify (server, &client_disconnect_notification,
852                                    NULL);
853 }
854
855
856 /**
857  * Stop processing clients.
858  */
859 void
860 GST_clients_stop ()
861 {
862   /* nothing to do */
863 }
864
865
866 /**
867  * Broadcast the given message to all of our clients.
868  *
869  * @param msg message to broadcast
870  * @param may_drop GNUNET_YES if the message can be dropped
871  */
872 void
873 GST_clients_broadcast (const struct GNUNET_MessageHeader *msg, int may_drop)
874 {
875   struct TransportClient *tc;
876
877   for (tc = clients_head; tc != NULL; tc = tc->next)
878     unicast (tc, msg, may_drop);
879 }
880
881
882 /**
883  * Send the given message to a particular client
884  *
885  * @param client target of the message
886  * @param msg message to transmit
887  * @param may_drop GNUNET_YES if the message can be dropped
888  */
889 void
890 GST_clients_unicast (struct GNUNET_SERVER_Client *client,
891                      const struct GNUNET_MessageHeader *msg, int may_drop)
892 {
893   struct TransportClient *tc;
894
895   tc = lookup_client (client);
896   if (NULL == tc)
897     tc = setup_client (client);
898   unicast (tc, msg, may_drop);
899 }
900
901
902 /* end of file gnunet-service-transport_clients.c */