-makefile for new test_stream_local (commented)
[oweals/gnunet.git] / src / transport / gnunet-service-transport_clients.c
index aee592d2954c125d54005e27ed2ed1c42ffcf6a8..227f4f093c782393d54a8393f7e0bb34f28a7609 100644 (file)
@@ -116,6 +116,35 @@ struct TransportClient
 };
 
 
+/**
+ * Client monitoring changes of active addresses of our neighbours.
+ */
+struct MonitoringClient
+{
+  /**
+   * This is a doubly-linked list.
+   */
+  struct MonitoringClient *next;
+
+  /**
+   * This is a doubly-linked list.
+   */
+  struct MonitoringClient *prev;
+
+  /**
+   * Handle to the client.
+   */
+  struct GNUNET_SERVER_Client *client;
+
+  /**
+   * Peer identity to monitor the addresses of.
+   * Zero to monitor all neighrours.
+   */
+  struct GNUNET_PeerIdentity peer;
+
+};
+
+
 /**
  * Head of linked list of all clients to this service.
  */
@@ -126,6 +155,23 @@ static struct TransportClient *clients_head;
  */
 static struct TransportClient *clients_tail;
 
+/**
+ * Head of linked list of monitoring clients.
+ */
+static struct MonitoringClient *monitoring_clients_head;
+
+/**
+ * Tail of linked list of monitoring clients.
+ */
+static struct MonitoringClient *monitoring_clients_tail;
+
+/**
+ * Notification context, to send updates on changes to active addresses
+ * of our neighbours.
+ */
+struct GNUNET_SERVER_NotificationContext *nc = NULL;
+
+
 /**
  * Find the internal handle associated with the given client handle
  *
@@ -162,15 +208,68 @@ setup_client (struct GNUNET_SERVER_Client *client)
   GNUNET_assert (lookup_client (client) == NULL);
   tc = GNUNET_malloc (sizeof (struct TransportClient));
   tc->client = client;
-  GNUNET_CONTAINER_DLL_insert (clients_head, clients_tail, tc);
 
 #if DEBUG_TRANSPORT
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Client %X connected\n", tc);
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Client %p connected\n", tc);
 #endif
   return tc;
 }
 
 
+/**
+ * Find the handle to the monitoring client associated with the given
+ * client handle
+ *
+ * @param client server's client handle to look up
+ * @return handle to the monitoring client
+ */
+static struct MonitoringClient *
+lookup_monitoring_client (struct GNUNET_SERVER_Client *client)
+{
+  struct MonitoringClient *mc;
+
+  mc = monitoring_clients_head;
+  while (mc != NULL)
+  {
+    if (mc->client == client)
+      return mc;
+    mc = mc->next;
+  }
+  return NULL;
+}
+
+
+/**
+ * Setup a new monitoring client using the given server client handle and
+ * the peer identity.
+ *
+ * @param client server's client handle to create our internal handle for
+ * @param peer identity of the peer to monitor the addresses of,
+ *             zero to monitor all neighrours.
+ * @return handle to the new monitoring client
+ */
+static struct MonitoringClient *
+setup_monitoring_client (struct GNUNET_SERVER_Client *client,
+                         struct GNUNET_PeerIdentity *peer)
+{
+  struct MonitoringClient *mc;
+
+  GNUNET_assert (lookup_monitoring_client (client) == NULL);
+  mc = GNUNET_malloc (sizeof (struct MonitoringClient));
+  mc->client = client;
+  mc->peer = *peer;
+  GNUNET_CONTAINER_DLL_insert (monitoring_clients_head,
+                               monitoring_clients_tail,
+                               mc);
+  GNUNET_SERVER_notification_context_add (nc, client);
+
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "Client %p started monitoring of the peer `%s'\n",
+              mc, GNUNET_i2s (peer));
+  return mc;
+}
+
+
 /**
  * Function called to notify a client about the socket being ready to
  * queue more data.  "buf" will be NULL and "size" zero if the socket
@@ -210,7 +309,7 @@ transmit_to_client_callback (void *cls, size_t size, void *buf)
       break;
 #if DEBUG_TRANSPORT
     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-                "Transmitting message of type %u to client %X.\n",
+                "Transmitting message of type %u to client %p.\n",
                 ntohs (msg->type), tc);
 #endif
     GNUNET_CONTAINER_DLL_remove (tc->message_queue_head, tc->message_queue_tail,
@@ -288,16 +387,25 @@ static void
 client_disconnect_notification (void *cls, struct GNUNET_SERVER_Client *client)
 {
   struct TransportClient *tc;
+  struct MonitoringClient *mc;
   struct ClientMessageQueueEntry *mqe;
 
   if (client == NULL)
     return;
+  mc = lookup_monitoring_client (client);
+  if (mc != NULL)
+  {
+    GNUNET_CONTAINER_DLL_remove (monitoring_clients_head,
+                                 monitoring_clients_tail,
+                                 mc);
+    GNUNET_free (mc);
+  }
   tc = lookup_client (client);
   if (tc == NULL)
     return;
 #if DEBUG_TRANSPORT
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
-              "Client %X disconnected, cleaning up.\n", tc);
+              "Client %p disconnected, cleaning up.\n", tc);
 #endif
   while (NULL != (mqe = tc->message_queue_head))
   {
@@ -331,8 +439,8 @@ static void
 notify_client_about_neighbour (void *cls,
                                const struct GNUNET_PeerIdentity *peer,
                                const struct GNUNET_ATS_Information *ats,
-                               uint32_t ats_count, 
-                              const struct GNUNET_HELLO_Address *address)
+                               uint32_t ats_count,
+                               const struct GNUNET_HELLO_Address *address)
 {
   struct TransportClient *tc = cls;
   struct ConnectInfoMessage *cim;
@@ -374,19 +482,15 @@ clients_handle_start (void *cls, struct GNUNET_SERVER_Client *client,
   tc = lookup_client (client);
 
 #if DEBUG_TRANSPORT
-  if (tc != NULL)
-    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
-                "Client %X sent START\n", tc);
-  else
-    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
-                "Client %X sent START\n", tc);
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
+              "Client %p sent START\n", tc);
 #endif
   if (tc != NULL)
   {
     /* got 'start' twice from the same client, not allowed */
 #if DEBUG_TRANSPORT
     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
-                "TransportClient %X ServerClient %X  sent multiple START messages\n",
+                "TransportClient %p ServerClient %p sent multiple START messages\n",
                 tc, tc->client);
 #endif
     GNUNET_break (0);
@@ -412,6 +516,7 @@ clients_handle_start (void *cls, struct GNUNET_SERVER_Client *client,
   tc->send_payload = (0 != (2 & options));
   unicast (tc, GST_hello_get (), GNUNET_NO);
   GST_neighbours_iterate (&notify_client_about_neighbour, tc);
+  GNUNET_CONTAINER_DLL_insert (clients_head, clients_tail, tc);
   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 }
 
@@ -606,7 +711,7 @@ clients_handle_request_connect (void *cls, struct GNUNET_SERVER_Client *client,
  * the client.
  *
  * @param cls the transmission context used ('struct GNUNET_SERVER_TransmitContext*')
- * @param address the resolved name, NULL to indicate the last response
+ * @param buf text to transmit
  */
 static void
 transmit_address_to_client (void *cls, const char *buf)
@@ -616,36 +721,12 @@ transmit_address_to_client (void *cls, const char *buf)
   if (NULL == buf)
   {
     GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
-                                                GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
+                                                GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
     GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
     return;
   }
   GNUNET_SERVER_transmit_context_append_data (tc, buf, strlen (buf) + 1,
-                                              GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
-}
-
-
-/**
- * Take the given address and append it to the set of results sent back to
- * the client.
- *
- * @param cls the transmission context used ('struct GNUNET_SERVER_TransmitContext*')
- * @param address the resolved name, NULL to indicate the last response
- */
-static void
-transmit_binary_to_client (void *cls, void *buf, size_t size)
-{
-  struct GNUNET_SERVER_TransmitContext *tc = cls;
-
-  if (NULL == buf)
-  {
-    GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
-                                                GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
-    GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
-    return;
-  }
-  GNUNET_SERVER_transmit_context_append_data (tc, buf, size,
-                                              GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
+                                              GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
 }
 
 
@@ -657,8 +738,9 @@ transmit_binary_to_client (void *cls, void *buf, size_t size)
  * @param message the resolution request
  */
 static void
-clients_handle_address_lookup (void *cls, struct GNUNET_SERVER_Client *client,
-                               const struct GNUNET_MessageHeader *message)
+clients_handle_address_to_string (void *cls,
+                                  struct GNUNET_SERVER_Client *client,
+                                  const struct GNUNET_MessageHeader *message)
 {
   const struct AddressLookupMessage *alum;
   struct GNUNET_TRANSPORT_PluginFunctions *papi;
@@ -678,7 +760,7 @@ clients_handle_address_lookup (void *cls, struct GNUNET_SERVER_Client *client,
     return;
   }
   alum = (const struct AddressLookupMessage *) message;
-  address_len = ntohl (alum->addrlen);
+  address_len = ntohs (alum->addrlen);
   if (size <= sizeof (struct AddressLookupMessage) + address_len)
   {
     GNUNET_break (0);
@@ -695,17 +777,21 @@ clients_handle_address_lookup (void *cls, struct GNUNET_SERVER_Client *client,
     return;
   }
   rtimeout = GNUNET_TIME_relative_ntoh (alum->timeout);
-  numeric = ntohl (alum->numeric_only);
+  numeric = ntohs (alum->numeric_only);
   tc = GNUNET_SERVER_transmit_context_create (client);
   papi = GST_plugins_find (plugin_name);
   if (NULL == papi)
   {
     GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
-                                                GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
+                                                GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
     GNUNET_SERVER_transmit_context_run (tc, rtimeout);
     return;
   }
   GNUNET_SERVER_disable_receive_done_warning (client);
+  if ((NULL == address) || (0 == address_len))
+  {
+    GNUNET_break_op (0);
+  }
   papi->address_pretty_printer (papi->cls, plugin_name, address, address_len,
                                 numeric, rtimeout, &transmit_address_to_client,
                                 tc);
@@ -713,65 +799,48 @@ clients_handle_address_lookup (void *cls, struct GNUNET_SERVER_Client *client,
 
 
 /**
- * Send an address to the client.
- *
- * @param cls our 'struct GNUNET_SERVER_TransmitContext' (for sending)
- * @param public_key public key for the peer, never NULL
- * @param valid_until until what time do we consider the address valid?
- * @param validation_block  is FOREVER if the address is for an unsupported plugin (from PEERINFO)
- *                          is ZERO if the address is considered valid (no validation needed)
- *                          is a time in the future if we're currently denying re-validation
- * @param address address to transmit
- */
-static void
-send_address_to_client (void *cls,
-                        const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
-                        *public_key,
-                        struct GNUNET_TIME_Absolute valid_until,
-                        struct GNUNET_TIME_Absolute validation_block,
-                        const struct GNUNET_HELLO_Address *address)
-{
-  struct GNUNET_SERVER_TransmitContext *tc = cls;
-  char *addr_buf;
-
-  /* FIXME: move to a binary format!!! */
-  GNUNET_asprintf (&addr_buf, "%s --- %s, %s",
-                   GST_plugins_a2s (address),
-                   (GNUNET_YES ==
-                    GST_neighbours_test_connected (&address->peer)) ? "CONNECTED" :
-                   "DISCONNECTED",
-                   (GNUNET_TIME_absolute_get_remaining (valid_until).rel_value >
-                    0) ? "VALIDATED" : "UNVALIDATED");
-  transmit_address_to_client (tc, addr_buf);
-  GNUNET_free (addr_buf);
-}
-
-
-/**
- * Client asked to obtain information about a peer's addresses.
- * Process the request.
- * FIXME: use better name!
+ * Compose AddressIterateResponseMessage using the given peer and address.
  *
- * @param cls unused
- * @param client the client
- * @param message the peer address information request
+ * @param peer identity of the peer
+ * @param address the address, NULL on disconnect
+ * @return composed message
  */
-static void
-clients_handle_peer_address_lookup (void *cls,
-                                    struct GNUNET_SERVER_Client *client,
-                                    const struct GNUNET_MessageHeader *message)
+static struct AddressIterateResponseMessage *
+compose_address_iterate_response_message (const struct GNUNET_PeerIdentity
+                                          *peer,
+                                          const struct GNUNET_HELLO_Address
+                                          *address)
 {
-  const struct PeerAddressLookupMessage *peer_address_lookup;
-  struct GNUNET_SERVER_TransmitContext *tc;
+  struct AddressIterateResponseMessage *msg;
+  size_t size;
+  size_t tlen;
+  size_t alen;
+  char *addr;
 
-  peer_address_lookup = (const struct PeerAddressLookupMessage *) message;
-  GNUNET_break (ntohl (peer_address_lookup->reserved) == 0);
-  tc = GNUNET_SERVER_transmit_context_create (client);
-  GST_validation_get_addresses (&peer_address_lookup->peer,
-                                &send_address_to_client, tc);
-  GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
-                                              GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
-  GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
+  GNUNET_assert (NULL != peer);
+  if (NULL != address)
+  {
+    tlen = strlen (address->transport_name) + 1;
+    alen = address->address_length;
+  }
+  else
+    tlen = alen = 0;
+  size = (sizeof (struct AddressIterateResponseMessage) + alen + tlen);
+  msg = GNUNET_malloc (size);
+  msg->header.size = htons (size);
+  msg->header.type =
+      htons (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE_RESPONSE);
+  msg->reserved = htonl (0);
+  msg->peer = *peer;
+  msg->addrlen = htonl (alen);
+  msg->pluginlen = htonl (tlen);
+  if (NULL != address)
+  {
+    addr = (char *) &msg[1];
+    memcpy (addr, address->address, alen);
+    memcpy (&addr[alen], address->transport_name, tlen);
+  }
+  return msg;
 }
 
 
@@ -779,37 +848,29 @@ clients_handle_peer_address_lookup (void *cls,
  * Output the active address of connected neighbours to the given client.
  *
  * @param cls the 'struct GNUNET_SERVER_TransmitContext' for transmission to the client
- * @param neighbour identity of the neighbour
+ * @param peer identity of the neighbour
  * @param ats performance data
  * @param ats_count number of entries in ats (excluding 0-termination)
  * @param address the address
  */
 static void
-output_addresses (void *cls, const struct GNUNET_PeerIdentity *peer,
-                  const struct GNUNET_ATS_Information *ats, uint32_t ats_count,
-                  const struct GNUNET_HELLO_Address *address)
+output_address (void *cls, const struct GNUNET_PeerIdentity *peer,
+                const struct GNUNET_ATS_Information *ats, uint32_t ats_count,
+                const struct GNUNET_HELLO_Address *address)
 {
   struct GNUNET_SERVER_TransmitContext *tc = cls;
   struct AddressIterateResponseMessage *msg;
-  size_t size;
-  size_t slen;
 
-  slen = strlen (address->transport_name) + 1;
-  size = (sizeof (struct AddressIterateResponseMessage) + slen);
-  msg = GNUNET_malloc (size);
-  memcpy (&msg->peer, peer, sizeof (struct GNUNET_PeerIdentity));
-  memcpy (&msg[0], address->transport_name, slen);
-  msg->addrlen = ntohs (address->address_length);
-  msg->pluginlen = ntohs (slen);
-  // FIXME: what about 'address->address'!?
-  transmit_binary_to_client (tc, msg, size);
+  msg = compose_address_iterate_response_message (peer, address);
+  GNUNET_SERVER_transmit_context_append_message (tc, &msg->header);
   GNUNET_free (msg);
 }
 
 
 /**
- * Client asked to obtain information about all actively used addresses.
- * Process the request.  FIXME: use better name!
+ * Client asked to obtain information about all actively used addresses
+ * of connected peers
+ * Process the request.
  *
  * @param cls unused
  * @param client the client
@@ -819,13 +880,53 @@ static void
 clients_handle_address_iterate (void *cls, struct GNUNET_SERVER_Client *client,
                                 const struct GNUNET_MessageHeader *message)
 {
+  static struct GNUNET_PeerIdentity all_zeros;
   struct GNUNET_SERVER_TransmitContext *tc;
+  struct AddressIterateMessage *msg;
+  struct GNUNET_HELLO_Address *address;
 
+  if (ntohs (message->type) != GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE)
+  {
+    GNUNET_break (0);
+    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
+    return;
+  }
+  if (ntohs (message->size) != sizeof (struct AddressIterateMessage))
+  {
+    GNUNET_break (0);
+    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
+    return;
+  }
+  msg = (struct AddressIterateMessage *) message;
+  if ( (GNUNET_YES != ntohl (msg->one_shot)) &&
+       (NULL != lookup_monitoring_client (client)) )
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
+               "ServerClient %p tried to start monitoring twice\n",
+               client);
+    GNUNET_break (0);
+    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
+    return;
+  }
   GNUNET_SERVER_disable_receive_done_warning (client);
   tc = GNUNET_SERVER_transmit_context_create (client);
-  GST_neighbours_iterate (&output_addresses, tc);
-  GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
-                                              GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
+  if (0 == memcmp (&msg->peer, &all_zeros, sizeof (struct GNUNET_PeerIdentity)))
+  {
+    /* iterate over all neighbours */
+    GST_neighbours_iterate (&output_address, tc);
+  }
+  else
+  {
+    /* just return one neighbour */
+    address = GST_neighbour_get_current_address (&msg->peer);
+    if (address != NULL)
+      output_address (tc, &msg->peer, NULL, 0, address);
+  }
+  if (GNUNET_YES != ntohl (msg->one_shot))
+    setup_monitoring_client (client, &msg->peer);
+  else
+    GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
+                                               GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE_RESPONSE);  
   GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
 }
 
@@ -848,11 +949,8 @@ GST_clients_start (struct GNUNET_SERVER_Handle *server)
     {&clients_handle_request_connect, NULL,
      GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT,
      sizeof (struct TransportRequestConnectMessage)},
-    {&clients_handle_address_lookup, NULL,
-     GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP, 0},
-    {&clients_handle_peer_address_lookup, NULL,
-     GNUNET_MESSAGE_TYPE_TRANSPORT_PEER_ADDRESS_LOOKUP,
-     sizeof (struct PeerAddressLookupMessage)},
+    {&clients_handle_address_to_string, NULL,
+     GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING, 0},
     {&clients_handle_address_iterate, NULL,
      GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE,
      sizeof (struct AddressIterateMessage)},
@@ -864,6 +962,7 @@ GST_clients_start (struct GNUNET_SERVER_Handle *server)
      sizeof (struct BlacklistMessage)},
     {NULL, NULL, 0, 0}
   };
+  nc = GNUNET_SERVER_notification_context_create (server, 0);
   GNUNET_SERVER_add_handlers (server, handlers);
   GNUNET_SERVER_disconnect_notify (server, &client_disconnect_notification,
                                    NULL);
@@ -876,7 +975,11 @@ GST_clients_start (struct GNUNET_SERVER_Handle *server)
 void
 GST_clients_stop ()
 {
-  /* nothing to do */
+  if (NULL != nc)
+  {
+    GNUNET_SERVER_notification_context_destroy (nc);
+    nc = NULL;
+  }
 }
 
 
@@ -920,4 +1023,39 @@ GST_clients_unicast (struct GNUNET_SERVER_Client *client,
 }
 
 
+/**
+ * Broadcast the new active address to all clients monitoring the peer.
+ *
+ * @param peer peer this update is about (never NULL)
+ * @param address address, NULL on disconnect
+ */
+void
+GST_clients_broadcast_address_notification (const struct GNUNET_PeerIdentity
+                                            *peer,
+                                            const struct GNUNET_HELLO_Address
+                                            *address)
+{
+  struct AddressIterateResponseMessage *msg;
+  struct MonitoringClient *mc;
+  static struct GNUNET_PeerIdentity all_zeros;
+
+  msg = compose_address_iterate_response_message (peer, address);
+  mc = monitoring_clients_head;
+  while (mc != NULL)
+  {
+    if ((0 == memcmp (&mc->peer, &all_zeros,
+                      sizeof (struct GNUNET_PeerIdentity))) ||
+        (0 == memcmp (&mc->peer, peer,
+                      sizeof (struct GNUNET_PeerIdentity))))
+    {
+      GNUNET_SERVER_notification_context_unicast (nc, mc->client,
+                                                  &msg->header, GNUNET_NO);
+    }
+
+    mc = mc->next;
+  }
+  GNUNET_free (msg);
+}
+
+
 /* end of file gnunet-service-transport_clients.c */