path: root/src/gns/gns_api.c

/*
     This file is part of GNUnet.
     (C) 2009, 2010, 2012 Christian Grothoff (and other contributing authors)

     GNUnet is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published
     by the Free Software Foundation; either version 3, or (at your
     option) any later version.

     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     General Public License for more details.

     You should have received a copy of the GNU General Public License
     along with GNUnet; see the file COPYING.  If not, write to the
     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
     Boston, MA 02111-1307, USA.
*/
/**
 * @file gns/gns_api.c
 * @brief library to access the GNS service
 * @author Martin Schanzenbach
 * @author Christian Grothoff
 */
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_constants.h"
#include "gnunet_arm_service.h"
#include "gnunet_hello_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_dht_service.h"
#include "gns.h"
#include "gnunet_gns_service.h"


/**
 * Handle to a lookup request
 */
struct GNUNET_GNS_LookupRequest
{

  /**
   * DLL
   */
  struct GNUNET_GNS_LookupRequest *next;
  
  /**
   * DLL
   */
  struct GNUNET_GNS_LookupRequest *prev;
  
  /**
   * handle to gns 
   */
  struct GNUNET_GNS_Handle *gns_handle;
  
  /**
   * processor to call on lookup result 
   */
  GNUNET_GNS_LookupResultProcessor lookup_proc;

  /**
   * processor closure 
   */
  void *proc_cls;
 
  /**
   * request id 
   */
  uint64_t r_id;
 
};


/**
 * Handle to a shorten request
 */
struct GNUNET_GNS_ShortenRequest
{
  /**
   * DLL
   */
  struct GNUNET_GNS_ShortenRequest *next;
  
  /**
   * DLL
   */
  struct GNUNET_GNS_ShortenRequest *prev;

  /* handle to gns */
  struct GNUNET_GNS_Handle *gns_handle;
  
  /* processor to call on shorten result */
  GNUNET_GNS_ShortenResultProcessor shorten_proc;
  
  /* processor closure */
  void *proc_cls;

  /* request id */
  uint64_t r_id;
  
  
};


/**
 * Handle to GetAuthorityRequest
 */
struct GNUNET_GNS_GetAuthRequest
{
  /**
   * DLL
   */
  struct GNUNET_GNS_GetAuthRequest *next;
  
  /**
   * DLL
   */
  struct GNUNET_GNS_GetAuthRequest *prev;

  /* handle to gns */
  struct GNUNET_GNS_Handle *gns_handle;
  
  /* processor to call on authority lookup result */
  GNUNET_GNS_GetAuthResultProcessor auth_proc;
  
  /* processor closure */
  void *proc_cls;
  
  /* request id */
  uint32_t r_id;
  
};


/**
 * Entry in our list of messages to be (re-)transmitted.
 */
struct PendingMessage
{
  /**
   * This is a doubly-linked list.
   */
  struct PendingMessage *prev;

  /**
   * This is a doubly-linked list.
   */
  struct PendingMessage *next;

  /**
   * request id
   */
  uint64_t r_id;

  /**
   * Size of the message.
   */
  size_t size;

};


/**
 * Connection to the GNS service.
 */
struct GNUNET_GNS_Handle
{

  /**
   * Configuration to use.
   */
  const struct GNUNET_CONFIGURATION_Handle *cfg;

  /**
   * Socket (if available).
   */
  struct GNUNET_CLIENT_Connection *client;

  /**
   * Currently pending transmission request (or NULL).
   */
  struct GNUNET_CLIENT_TransmitHandle *th;
  
  /**
   * Head of linked list of shorten messages we would like to transmit.
   */
  struct PendingMessage *pending_head;

  /**
   * Tail of linked list of shorten messages we would like to transmit.
   */
  struct PendingMessage *pending_tail;
  
  /**
   * Head of linked list of shorten messages we would like to transmit.
   */
  struct GNUNET_GNS_ShortenRequest *shorten_head;

  /**
   * Tail of linked list of shorten messages we would like to transmit.
   */
  struct GNUNET_GNS_ShortenRequest *shorten_tail;
  
  /**
   * Head of linked list of lookup messages we would like to transmit.
   */
  struct GNUNET_GNS_LookupRequest *lookup_head;

  /**
   * Tail of linked list of lookup messages we would like to transmit.
   */
  struct GNUNET_GNS_LookupRequest *lookup_tail;
  
  /**
   * Head of linked list of authority lookup messages we would like to transmit.
   */
  struct GNUNET_GNS_GetAuthRequest *get_auth_head;

  /**
   * Tail of linked list of authority lookup messages we would like to transmit.
   */
  struct GNUNET_GNS_GetAuthRequest *get_auth_tail;

  /**
   * Reconnect task
   */
  GNUNET_SCHEDULER_TaskIdentifier reconnect_task;

  uint32_t r_id;
  
  /**
   * Did we start our receive loop yet?
   */
  int in_receive;

};


/**
 * Try to send messages from list of messages to send
 * @param handle GNS_Handle
 */
static void
process_pending_messages (struct GNUNET_GNS_Handle *handle);


/**
 * Reconnect to GNS service.
 *
 * @param h the handle to the GNS service
 */
static void
reconnect (struct GNUNET_GNS_Handle *h)
{
  GNUNET_assert (NULL == h->client);
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
	      "Trying to connect to GNS\n");
  h->client = GNUNET_CLIENT_connect ("gns", h->cfg);
  GNUNET_assert (NULL != h->client);
  process_pending_messages (h);
}


/**
 * Reconnect to GNS
 *
 * @param cls the handle
 * @param tc task context
 */
static void
reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
  struct GNUNET_GNS_Handle *h = cls;

  h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
  reconnect (h);
}


/**
 * Disconnect from service and then reconnect.
 *
 * @param h our handle
 */
static void
force_reconnect (struct GNUNET_GNS_Handle *h)
{
  GNUNET_CLIENT_disconnect (h->client);
  h->client = NULL;
  h->in_receive = GNUNET_NO;
  /* FIXME: 1s too long, exponential-backoff, starting at 1ms! (max = 1s might be OK) */
  h->reconnect_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
                                                    &reconnect_task,
                                                    h);
}


/**
 * Transmit the next pending message, called by notify_transmit_ready
 *
 * @param fixme
 */
static size_t
transmit_pending (void *cls, size_t size, void *buf);


/**
 * Handler for messages received from the GNS service
 *
 * @param cls the 'struct GNUNET_GNS_Handle'
 * @param msg the incoming message
 */
static void
process_message (void *cls, const struct GNUNET_MessageHeader *msg);


/**
 * Try to send messages from list of messages to send
 *
 * @param fixme
 */
static void
process_pending_messages (struct GNUNET_GNS_Handle *handle)
{
  struct PendingMessage *p;

  if (NULL == handle->client)
    return; /* wait for reconnect */ 
  if (NULL != handle->th)
    return; /* transmission request already pending */ 
  if (NULL == (p = handle->pending_head))
    return; /* no messages pending */  
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
	      "Trying to transmit %u bytes\n", 
	      (unsigned int) p->size);
  handle->th =
    GNUNET_CLIENT_notify_transmit_ready (handle->client,
                                         p->size,
                                         GNUNET_TIME_UNIT_FOREVER_REL,
                                         GNUNET_NO, &transmit_pending,
                                         handle);
  GNUNET_break (NULL != handle->th);
}


/**
 * Transmit the next pending message, called by notify_transmit_ready
 *
 * @param fixme
 */
static size_t
transmit_pending (void *cls, size_t size, void *buf)
{
  struct GNUNET_GNS_Handle *handle = cls;
  char *cbuf = buf;
  struct PendingMessage *p;
  size_t tsize;

  handle->th = NULL;  
  if ((0 == size) || (NULL == buf))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
		"Transmission to GNS service failed!\n");
    force_reconnect(handle);
    return 0;
  }  
  if (NULL == (p = handle->pending_head))
    return 0;

  tsize = 0;
  while ((NULL != (p = handle->pending_head)) && (p->size <= size))
  {
    memcpy (&cbuf[tsize], &p[1], p->size);
    tsize += p->size;
    size -= p->size;
    GNUNET_CONTAINER_DLL_remove (handle->pending_head, handle->pending_tail, p);
    if (GNUNET_YES != handle->in_receive)
    {
      GNUNET_CLIENT_receive (handle->client, &process_message, handle,
                             GNUNET_TIME_UNIT_FOREVER_REL);
      handle->in_receive = GNUNET_YES;
    }
    GNUNET_free (p);
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Sending %u bytes\n",
	      (unsigned int) tsize);
  process_pending_messages (handle);
  return tsize;
}


/**
 * Process a given reply that might match the given
 * request.
 *
 * @param qe a queue entry
 * @param msg the shorten msg received
 */
static void
process_shorten_reply (struct GNUNET_GNS_ShortenRequest *qe,
                       const struct GNUNET_GNS_ClientShortenResultMessage *msg)
{
  struct GNUNET_GNS_Handle *h = qe->gns_handle;
  const char *short_name;
  size_t mlen;

  GNUNET_CONTAINER_DLL_remove (h->shorten_head, h->shorten_tail, qe);
  mlen = ntohs (msg->header.size);
  short_name = (const char *) &msg[1];

  if ( (ntohs (msg->header.size) <= sizeof (struct GNUNET_GNS_ClientShortenResultMessage)) ||
       ('\0' != short_name[mlen - sizeof (struct GNUNET_GNS_ClientShortenResultMessage) - 1]) )
  {
    GNUNET_break (0);
    // FIXME: reconnect and queue management logic is broken...
    qe->shorten_proc (qe->proc_cls, NULL);
    GNUNET_free (qe);
    force_reconnect (h);
    return;
  } 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Received shortened reply `%s' from GNS service\n",
              short_name);  
  qe->shorten_proc (qe->proc_cls, short_name);
  GNUNET_free (qe);
}


/**
 * Process a given reply that might match the given
 * request.
 *
 * @param qe the handle to the request
 * @param msg the message to process
 */
static void
process_get_auth_reply (struct GNUNET_GNS_GetAuthRequest *qe,
                       const struct GNUNET_GNS_ClientGetAuthResultMessage *msg)
{
  struct GNUNET_GNS_Handle *h = qe->gns_handle;
  const char *auth_name;

  GNUNET_CONTAINER_DLL_remove (h->get_auth_head, h->get_auth_tail, qe);
  auth_name = (char*)&msg[1];

  if (ntohs (((struct GNUNET_MessageHeader*)msg)->size) <
      sizeof (struct GNUNET_GNS_ClientGetAuthResultMessage))
  {
    GNUNET_free(qe);
    GNUNET_break (0);
    force_reconnect (h);
    return;
  }
  
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Received GET_AUTH reply `%s' from GNS service\n",
              auth_name);
  qe->auth_proc (qe->proc_cls, auth_name);
  GNUNET_free (qe);
}


/**
 * Process a given reply to the lookup request
 *
 * @param qe a queue entry
 * @param msg the lookup message received
 */
static void
process_lookup_reply (struct GNUNET_GNS_LookupRequest *qe,
                      const struct GNUNET_GNS_ClientLookupResultMessage *msg)
{
  struct GNUNET_GNS_Handle *h = qe->gns_handle;
  int rd_count = ntohl(msg->rd_count);
  size_t len = ntohs (((struct GNUNET_MessageHeader*)msg)->size);
  struct GNUNET_NAMESTORE_RecordData rd[rd_count];

  GNUNET_CONTAINER_DLL_remove (h->lookup_head, h->lookup_tail, qe);

  if (len < sizeof (struct GNUNET_GNS_ClientLookupResultMessage))
  {
    GNUNET_free(qe);
    GNUNET_break (0);
    force_reconnect (h);
    return;
  }

  len -= sizeof (struct GNUNET_GNS_ClientLookupResultMessage);
  if (GNUNET_SYSERR == GNUNET_NAMESTORE_records_deserialize (len,
                                                             (char*)&msg[1],
                                                             rd_count,
                                                             rd))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Failed to serialize lookup reply from GNS service!\n");
    qe->lookup_proc (qe->proc_cls, 0, NULL);
  }
  else
  {
  
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Received lookup reply from GNS service (count=%d)\n",
                ntohl (msg->rd_count));
    qe->lookup_proc (qe->proc_cls, rd_count, rd);
  }
  GNUNET_free (qe);
}

/**
 * Handler for messages received from the GNS service
 *
 * @param cls the 'struct GNUNET_GNS_Handle'
 * @param msg the incoming message
 */
static void
process_message (void *cls, const struct GNUNET_MessageHeader *msg)
{
  struct GNUNET_GNS_Handle *handle = cls;
  struct GNUNET_GNS_LookupRequest *lr;
  struct GNUNET_GNS_ShortenRequest *sr;
  struct GNUNET_GNS_GetAuthRequest *gar;
  const struct GNUNET_GNS_ClientLookupResultMessage *lookup_msg;
  const struct GNUNET_GNS_ClientShortenResultMessage *shorten_msg;
  const struct GNUNET_GNS_ClientGetAuthResultMessage *get_auth_msg;
  uint64_t r_id;
  
  if (NULL == msg)
  {
    force_reconnect (handle);
    return;
  }
  switch (ntohs (msg->type))
  {
  case GNUNET_MESSAGE_TYPE_GNS_LOOKUP_RESULT:
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Got LOOKUP_RESULT msg\n");
    if (ntohs (msg->size) < sizeof (struct GNUNET_GNS_ClientLookupResultMessage))
      {
	GNUNET_break (0);
	force_reconnect (handle);
	return;
      }
    lookup_msg = (const struct GNUNET_GNS_ClientLookupResultMessage *) msg;
    r_id = ntohl (lookup_msg->id);   
    for (lr = handle->lookup_head; NULL != lr; lr = lr->next)    
      if (lr->r_id == r_id)
	{
	  process_lookup_reply(lr, lookup_msg);    
	  break;
	}
    break;
  case GNUNET_MESSAGE_TYPE_GNS_SHORTEN_RESULT:  
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Got SHORTEN_RESULT msg\n");
    if (ntohs (msg->size) < sizeof (struct GNUNET_GNS_ClientShortenResultMessage))
      {
	GNUNET_break (0);
	force_reconnect (handle);
	return;
      }
    shorten_msg = (const struct GNUNET_GNS_ClientShortenResultMessage *) msg;   
    r_id = ntohl (shorten_msg->id);
    for (sr = handle->shorten_head; NULL != sr; sr = sr->next)    
      if (sr->r_id == r_id)
	{
	  process_shorten_reply (sr, shorten_msg);
	  break;
	}
    break;
  case GNUNET_MESSAGE_TYPE_GNS_GET_AUTH_RESULT:  
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Got GET_AUTH_RESULT msg\n");
    if (ntohs (msg->size) < sizeof (struct GNUNET_GNS_ClientGetAuthResultMessage))
      {
	GNUNET_break (0);
	force_reconnect (handle);
	return;
      }
    get_auth_msg = (const struct GNUNET_GNS_ClientGetAuthResultMessage *) msg;
    r_id = ntohl (get_auth_msg->id);
    for (gar = handle->get_auth_head; NULL != gar; gar = gar->next)
      if (gar->r_id == r_id)
	{
	  process_get_auth_reply (gar, get_auth_msg);
	  break;
	}
    break;
  default:
    GNUNET_break (0);
    force_reconnect (handle);
    return;
  }
  GNUNET_CLIENT_receive (handle->client, &process_message, handle,
			 GNUNET_TIME_UNIT_FOREVER_REL);
}


/**
 * Initialize the connection with the GNS service.
 *
 * @param cfg configuration to use
 * @return handle to the GNS service, or NULL on error
 */
struct GNUNET_GNS_Handle *
GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
{
  struct GNUNET_GNS_Handle *handle;

  handle = GNUNET_malloc (sizeof (struct GNUNET_GNS_Handle));
  handle->cfg = cfg;
  reconnect (handle);
  return handle;
}


/**
 * Shutdown connection with the GNS service.
 *
 * @param handle handle of the GNS connection to stop
 */
void
GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle)
{
  GNUNET_CLIENT_disconnect (handle->client);
  if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
  {
    GNUNET_SCHEDULER_cancel (handle->reconnect_task);
    handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
  }
  GNUNET_assert (NULL == handle->lookup_head);
  GNUNET_assert (NULL == handle->shorten_head);
  GNUNET_assert (NULL == handle->get_auth_head);
  GNUNET_free(handle);
  /* disco from GNS */
}


/**
 * Cancel pending lookup request
 *
 * @param lr the lookup request to cancel
 */
void
GNUNET_GNS_cancel_lookup_request (struct GNUNET_GNS_LookupRequest *lr)
{
  struct PendingMessage *tmp;

  GNUNET_assert (NULL != lr->gns_handle); 
  for (tmp = lr->gns_handle->pending_head;
       NULL != tmp; tmp = tmp->next)
  {
    if (tmp->r_id == lr->r_id)
      break;
  }

  if (NULL != tmp)
  {
    GNUNET_CONTAINER_DLL_remove (lr->gns_handle->pending_head,
                                 lr->gns_handle->pending_tail,
                                 tmp);
    GNUNET_free (tmp);
  }

  GNUNET_CONTAINER_DLL_remove (lr->gns_handle->lookup_head,
                               lr->gns_handle->lookup_tail,
                               lr);

  GNUNET_free (lr);
}


/**
 * Cancel pending shorten request
 *
 * @param sr the lookup request to cancel
 */
void
GNUNET_GNS_cancel_shorten_request (struct GNUNET_GNS_ShortenRequest *sr)
{
  struct PendingMessage *tmp;

  GNUNET_assert (NULL != sr->gns_handle);
  for (tmp = sr->gns_handle->pending_head;
       NULL != tmp; tmp = tmp->next)
  {
    if (tmp->r_id == sr->r_id)
      break;
  }

  if (NULL != tmp)
  {
    GNUNET_CONTAINER_DLL_remove (sr->gns_handle->pending_head,
                                 sr->gns_handle->pending_tail,
                                 tmp);
    GNUNET_free (tmp);
  }

  GNUNET_CONTAINER_DLL_remove (sr->gns_handle->shorten_head,
                               sr->gns_handle->shorten_tail,
                               sr);

  GNUNET_free (sr);
}


/**
 * Cancel pending get auth  request
 *
 * @param gar the lookup request to cancel
 */
void
GNUNET_GNS_cancel_get_auth_request (struct GNUNET_GNS_GetAuthRequest *gar)
{
  struct PendingMessage *tmp;

  GNUNET_assert (NULL != gar->gns_handle); 
  for (tmp = gar->gns_handle->pending_head;
       NULL != tmp; tmp = tmp->next)
  {
    if (tmp->r_id == gar->r_id)
      break;
  }

  if (NULL != tmp)
  {
    GNUNET_CONTAINER_DLL_remove (gar->gns_handle->pending_head,
                                 gar->gns_handle->pending_tail,
                                 tmp);
    GNUNET_free (tmp);
  }

  GNUNET_CONTAINER_DLL_remove (gar->gns_handle->get_auth_head,
                               gar->gns_handle->get_auth_tail,
                               gar);

  GNUNET_free (gar);
}


/**
 * Perform an asynchronous Lookup operation on the GNS.
 *
 * @param handle handle to the GNS service
 * @param name the name to look up
 * @param zone the zone to start the resolution in
 * @param type the record type to look up
 * @param only_cached GNUNET_YES to only check locally not DHT for performance
 * @param shorten_key the private key of the shorten zone (can be NULL)
 * @param proc processor to call on result
 * @param proc_cls closure for processor
 * @return handle to the get request
 */
struct GNUNET_GNS_LookupRequest*
GNUNET_GNS_lookup_zone (struct GNUNET_GNS_Handle *handle,
                   const char * name,
                   struct GNUNET_CRYPTO_ShortHashCode *zone,
                   enum GNUNET_GNS_RecordType type,
                   int only_cached,
                   struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key,
                   GNUNET_GNS_LookupResultProcessor proc,
                   void *proc_cls)
{
  /* IPC to shorten gns names, return shorten_handle */
  struct GNUNET_GNS_ClientLookupMessage *lookup_msg;
  struct GNUNET_GNS_LookupRequest *lr;
  size_t msize;
  struct PendingMessage *pending;
  struct GNUNET_CRYPTO_RsaPrivateKeyBinaryEncoded *pkey_enc;
  size_t key_len;
  char* pkey_tmp;

  if (NULL == name)
  {
    GNUNET_break (0);
    return NULL;
  }
  
  if (NULL != shorten_key)
  {
    pkey_enc = GNUNET_CRYPTO_rsa_encode_key (shorten_key);
    GNUNET_assert (pkey_enc != NULL);
    key_len = ntohs (pkey_enc->len);
  }
  else
  {
    pkey_enc = NULL;
    key_len = 0;
  }

  msize = sizeof (struct GNUNET_GNS_ClientLookupMessage)
    + key_len + strlen (name) + 1;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
	      "Trying to lookup %s in GNS\n", 
	      name);
  lr = GNUNET_malloc (sizeof (struct GNUNET_GNS_LookupRequest));
  lr->gns_handle = handle;
  lr->lookup_proc = proc;
  lr->proc_cls = proc_cls;
  lr->r_id = handle->r_id++;
  GNUNET_CONTAINER_DLL_insert_tail (handle->lookup_head,
                                    handle->lookup_tail, lr);

  pending = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
  pending->size = msize;
  pending->r_id = lr->r_id;

  lookup_msg = (struct GNUNET_GNS_ClientLookupMessage *) &pending[1];
  lookup_msg->header.type = htons (GNUNET_MESSAGE_TYPE_GNS_LOOKUP);
  lookup_msg->header.size = htons (msize);
  lookup_msg->id = htonl (lr->r_id);
  lookup_msg->only_cached = htonl (only_cached);
  if (NULL != zone)
  {
    lookup_msg->use_default_zone = htonl (GNUNET_NO);
    memcpy (&lookup_msg->zone, zone, sizeof (struct GNUNET_CRYPTO_ShortHashCode));
  }
  else
  {
    lookup_msg->use_default_zone = htonl (GNUNET_YES);
    memset (&lookup_msg->zone, 0, sizeof(struct GNUNET_CRYPTO_ShortHashCode));
  }  
  lookup_msg->type = htonl (type);
  pkey_tmp = (char *) &lookup_msg[1];  
  if (pkey_enc != NULL)
  {
    lookup_msg->have_key = htonl (GNUNET_YES);
    memcpy (pkey_tmp, pkey_enc, key_len);
  }
  else
    lookup_msg->have_key = htonl (GNUNET_NO);
  GNUNET_free_non_null (pkey_enc);
  memcpy (&pkey_tmp[key_len], name, strlen (name) + 1);

  GNUNET_CONTAINER_DLL_insert_tail (handle->pending_head,
				    handle->pending_tail,
				    pending);
  process_pending_messages (handle);
  return lr;
}


/**
 * Perform an asynchronous Lookup operation on the GNS.
 *
 * @param handle handle to the GNS service
 * @param name the name to look up
 * @param type the record type to look up
 * @param only_cached GNUNET_YES to only check locally not DHT for performance
 * @param shorten_key the private key of the shorten zone (can be NULL)
 * @param proc processor to call on result
 * @param proc_cls closure for processor
 * @return handle to the lookup request
 */
struct GNUNET_GNS_LookupRequest*
GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
                   const char * name,
                   enum GNUNET_GNS_RecordType type,
                   int only_cached,
                   struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key,
                   GNUNET_GNS_LookupResultProcessor proc,
                   void *proc_cls)
{
  return GNUNET_GNS_lookup_zone (handle, name,
                                 NULL,
                                 type, only_cached,
                                 shorten_key,
                                 proc, proc_cls);
}


/**
 * Perform a name shortening operation on the GNS.
 *
 * @param handle handle to the GNS service
 * @param name the name to look up
 * @param private_zone the public zone of the private zone
 * @param shorten_zone the public zone of the shorten zone
 * @param zone the zone to start the resolution in
 * @param proc function to call on result
 * @param proc_cls closure for processor
 * @return handle to the operation
 */
struct GNUNET_GNS_ShortenRequest*
GNUNET_GNS_shorten_zone (struct GNUNET_GNS_Handle *handle,
                         const char * name,
                         struct GNUNET_CRYPTO_ShortHashCode *private_zone,
                         struct GNUNET_CRYPTO_ShortHashCode *shorten_zone,
                         struct GNUNET_CRYPTO_ShortHashCode *zone,
                         GNUNET_GNS_ShortenResultProcessor proc,
                         void *proc_cls)
{
  /* IPC to shorten gns names, return shorten_handle */
  struct GNUNET_GNS_ClientShortenMessage *shorten_msg;
  struct GNUNET_GNS_ShortenRequest *sr;
  size_t msize;
  struct PendingMessage *pending;

  if (NULL == name)
  {
    GNUNET_break (0);
    return NULL;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Trying to shorten %s in GNS\n", name);

  msize = sizeof (struct GNUNET_GNS_ClientShortenMessage) + strlen(name) + 1;
  sr = GNUNET_malloc (sizeof (struct GNUNET_GNS_ShortenRequest));
  sr->gns_handle = handle;
  sr->shorten_proc = proc;
  sr->proc_cls = proc_cls;
  sr->r_id = handle->r_id++;
  GNUNET_CONTAINER_DLL_insert_tail (handle->shorten_head,
                                    handle->shorten_tail, sr);

  pending = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
  pending->size = msize;
  pending->r_id = sr->r_id;

  shorten_msg = (struct GNUNET_GNS_ClientShortenMessage *) &pending[1];
  shorten_msg->header.type = htons (GNUNET_MESSAGE_TYPE_GNS_SHORTEN);
  shorten_msg->header.size = htons (msize);
  shorten_msg->id = htonl (sr->r_id);
  shorten_msg->private_zone = *private_zone;
  shorten_msg->shorten_zone = *shorten_zone;
  
  if (NULL != zone)
  {
    shorten_msg->use_default_zone = htonl (GNUNET_NO);
    memcpy (&shorten_msg->zone, zone,
            sizeof (struct GNUNET_CRYPTO_ShortHashCode));
  }
  else
  {
    shorten_msg->use_default_zone = htonl (GNUNET_YES);
    memset (&shorten_msg->zone, 0, sizeof (struct GNUNET_CRYPTO_ShortHashCode));
  }
  
  memcpy (&shorten_msg[1], name, strlen (name) + 1);

  GNUNET_CONTAINER_DLL_insert_tail (handle->pending_head, handle->pending_tail,
                               pending);
  
  process_pending_messages (handle);
  return sr;
}


/**
 * Perform a name shortening operation on the GNS.
 *
 * @param handle handle to the GNS service
 * @param name the name to look up
 * @param private_zone the public zone of the private zone
 * @param shorten_zone the public zone of the shorten zone
 * @param proc function to call on result
 * @param proc_cls closure for processor
 * @return handle to the operation
 */
struct GNUNET_GNS_ShortenRequest*
GNUNET_GNS_shorten (struct GNUNET_GNS_Handle *handle,
                    const char * name,
                    struct GNUNET_CRYPTO_ShortHashCode *private_zone,
                    struct GNUNET_CRYPTO_ShortHashCode *shorten_zone,
                    GNUNET_GNS_ShortenResultProcessor proc,
                    void *proc_cls)
{
  return GNUNET_GNS_shorten_zone (handle, name,
                                  private_zone, shorten_zone,
                                  NULL, proc, proc_cls);
}


/**
 * Perform an authority lookup for a given name.
 *
 * @param handle handle to the GNS service
 * @param name the name to look up authority for
 * @param proc function to call on result
 * @param proc_cls closure for processor
 * @return handle to the operation
 */
struct GNUNET_GNS_GetAuthRequest*
GNUNET_GNS_get_authority (struct GNUNET_GNS_Handle *handle,
                    const char * name,
                    GNUNET_GNS_GetAuthResultProcessor proc,
                    void *proc_cls)
{
  struct GNUNET_GNS_ClientGetAuthMessage *get_auth_msg;
  struct GNUNET_GNS_GetAuthRequest *gar;
  size_t msize;
  struct PendingMessage *pending;

  if (NULL == name)
  {
    GNUNET_break (0);
    return NULL;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Trying to look up authority for %s in GNS\n", name);

  msize = sizeof (struct GNUNET_GNS_ClientGetAuthMessage) + strlen (name) + 1;
  gar = GNUNET_malloc (sizeof (struct GNUNET_GNS_GetAuthRequest));
  gar->gns_handle = handle;
  gar->auth_proc = proc;
  gar->proc_cls = proc_cls;
  gar->r_id = handle->r_id++;
  GNUNET_CONTAINER_DLL_insert_tail (handle->get_auth_head,
                                    handle->get_auth_tail, gar);

  pending = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
  pending->size = msize;
  pending->r_id = gar->r_id;
  get_auth_msg = (struct GNUNET_GNS_ClientGetAuthMessage *) &pending[1];
  get_auth_msg->header.type = htons (GNUNET_MESSAGE_TYPE_GNS_GET_AUTH);
  get_auth_msg->header.size = htons (msize);
  get_auth_msg->id = htonl (gar->r_id);
  memcpy (&get_auth_msg[1], name, strlen(name) + 1);

  GNUNET_CONTAINER_DLL_insert_tail (handle->pending_head, 
				    handle->pending_tail,
				    pending);
  process_pending_messages (handle);
  return gar;
}


/* end of gns_api.c */