src/hostlist/hostlist-client.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2005, 2006, 2009 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 2, 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 hostlist/hostlist-client.c
  23  * @brief hostlist support.  Downloads HELLOs via HTTP.
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "hostlist-client.h"
  29 #include "gnunet_core_service.h"
  30 #include "gnunet_hello_lib.h"
  31 #include "gnunet_transport_service.h"
  32 #include <curl/curl.h>
  33
  34 /**
  35  * Number of connections that we must have to NOT download
  36  * hostlists anymore.
  37  */
  38 #define MIN_CONNECTIONS 4
  39
  40 /**
  41  * Our configuration.
  42  */
  43 static const struct GNUNET_CONFIGURATION_Handle *cfg;
  44
  45 /**
  46  * Our scheduler.
  47  */
  48 static struct GNUNET_SCHEDULER_Handle *sched;
  49
  50 /**
  51  * Statistics handle.
  52  */
  53 struct GNUNET_STATISTICS_Handle *stats;
  54
  55 /**
  56  * Transport handle.
  57  */
  58 struct GNUNET_TRANSPORT_Handle *transport;
  59
  60 /**
  61  * Proxy that we are using (can be NULL).
  62  */
  63 static char *proxy;
  64
  65 /**
  66  * Buffer for data downloaded via HTTP.
  67  */
  68 static char download_buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE];
  69
  70 /**
  71  * Number of bytes valid in 'download_buffer'.
  72  */
  73 static size_t download_pos;
  74
  75 /**
  76  * Current URL that we are using.
  77  */
  78 static char *current_url;
  79
  80 /**
  81  * Current CURL handle.
  82  */
  83 static CURL *curl;
  84
  85 /**
  86  * Current multi-CURL handle.
  87  */
  88 static CURLM *multi;
  89
  90 /**
  91  * ID of the current task scheduled.
  92  */
  93 static GNUNET_SCHEDULER_TaskIdentifier current_task;
  94
  95 /**
  96  * Amount of time we wait between hostlist downloads.
  97  */
  98 static struct GNUNET_TIME_Relative hostlist_delay;
  99
 100 /**
 101  * Set to GNUNET_YES if the current URL had some problems.
 102  */
 103 static int bogus_url;
 104
 105 /**
 106  * Number of active connections (according to core service).
 107  */
 108 static unsigned int connection_count;
 109
 110
 111 /**
 112  * Process downloaded bits by calling callback on each HELLO.
 113  *
 114  * @param ptr buffer with downloaded data
 115  * @param size size of a record
 116  * @param nmemb number of records downloaded
 117  * @param ctx unused
 118  * @return number of bytes that were processed (always size*nmemb)
 119  */
 120 static size_t
 121 download_hostlist_processor (void *ptr,
 122                              size_t size,
 123                              size_t nmemb,
 124                              void *ctx)
 125 {
 126   const char * cbuf = ptr;
 127   const struct GNUNET_MessageHeader *msg;
 128   size_t total;
 129   size_t cpy;
 130   size_t left;
 131   uint16_t msize;
 132
 133   total = size * nmemb;
 134   if ( (total == 0) || (bogus_url) )
 135     return total;  /* ok, no data or bogus data */
 136   left = total;
 137   while (left > 0)
 138     {
 139       cpy = GNUNET_MIN (total, GNUNET_SERVER_MAX_MESSAGE_SIZE - download_pos);
 140       GNUNET_assert (cpy > 0);
 141       memcpy (&download_buffer[download_pos],
 142               cbuf,
 143               cpy);
 144       cbuf += cpy;
 145       download_pos += cpy;
 146       left -= cpy;
 147       if (download_pos < sizeof(struct GNUNET_MessageHeader))
 148         break;
 149       msg = (const struct GNUNET_MessageHeader *) download_buffer;
 150       msize = ntohs(msg->size);
 151       if (msize < sizeof(struct GNUNET_MessageHeader))
 152         {
 153           GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 154                       _("Invalid `%s' message received from hostlist at `%s'\n"),
 155                       "HELLO",
 156                       current_url);
 157           bogus_url = 1;
 158           return total;
 159         }
 160       if (download_pos < msize)
 161         break;
 162       if (GNUNET_HELLO_size ((const struct GNUNET_HELLO_Message*)msg) == msize)
 163         {
 164           GNUNET_TRANSPORT_offer_hello (transport, msg);
 165         }
 166       else
 167         {
 168           GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 169                       _("Invalid `%s' message received from hostlist at `%s'\n"),
 170                       "HELLO",
 171                       current_url);
 172           bogus_url = 1;
 173           return total;
 174         }
 175       memmove (download_buffer,
 176                &download_buffer[msize],
 177                download_pos - msize);
 178       download_pos -= msize;
 179     }
 180   return total;
 181 }
 182
 183
 184 /**
 185  * Obtain a hostlist URL that we should use.
 186  *
 187  * @return NULL if there is no URL available
 188  */
 189 static char *
 190 get_url ()
 191 {
 192   char *servers;
 193   char *ret;
 194   size_t urls;
 195   size_t pos;
 196
 197   if (GNUNET_OK !=
 198       GNUNET_CONFIGURATION_get_value_string (cfg,
 199                                              "HOSTLIST",
 200                                              "SERVERS",
 201                                              &servers))
 202     {
 203       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 204                   _("No `%s' specified in `%s' configuration, will not bootstrap.\n"),
 205                   "SERVERS", "HOSTLIST");
 206       return NULL;
 207     }
 208
 209   urls = 0;
 210   if (strlen (servers) > 0)
 211     {
 212       urls++;
 213       pos = strlen (servers) - 1;
 214       while (pos > 0)
 215         {
 216           if (servers[pos] == ' ')
 217             urls++;
 218           pos--;
 219         }
 220     }
 221   if (urls == 0)
 222     {
 223       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 224                   _("No `%s' specified in `%s' configuration, will not bootstrap.\n"),
 225                   "SERVERS", "HOSTLIST");
 226       GNUNET_free (servers);
 227       return NULL;
 228     }
 229
 230   urls = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, urls) + 1;
 231   pos = strlen (servers) - 1;
 232   while (pos > 0)
 233     {
 234       if (servers[pos] == ' ')
 235         {
 236           urls--;
 237           servers[pos] = '\0';
 238         }
 239       if (urls == 0)
 240         {
 241           pos++;
 242           break;
 243         }
 244       pos--;
 245     }
 246   ret = GNUNET_strdup (&servers[pos]);
 247   GNUNET_free (servers);
 248   return ret;
 249 }
 250
 251
 252 #define CURL_EASY_SETOPT(c, a, b) do { ret = curl_easy_setopt(c, a, b); if (ret != CURLE_OK) GNUNET_log(GNUNET_ERROR_TYPE_WARNING, _("%s failed at %s:%d: `%s'\n"), "curl_easy_setopt", __FILE__, __LINE__, curl_easy_strerror(ret)); } while (0);
 253
 254
 255 /**
 256  * Schedule the background task that will (possibly)
 257  * download a hostlist.
 258  */
 259 static void
 260 schedule_hostlist_task (void);
 261
 262
 263 /**
 264  * Clean up the state from the task that downloaded the
 265  * hostlist and schedule the next task.
 266  */
 267 static void
 268 clean_up ()
 269 {
 270   CURLMcode mret;
 271
 272   if (multi != NULL)
 273     {
 274       mret = curl_multi_remove_handle (multi, curl);
 275       if (mret != CURLM_OK)
 276         {
 277           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 278                       _("%s failed at %s:%d: `%s'\n"),
 279                       "curl_multi_remove_handle", __FILE__, __LINE__,
 280                       curl_multi_strerror (mret));
 281         }
 282       mret = curl_multi_cleanup (multi);
 283       if (mret != CURLM_OK)
 284         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 285                     _("%s failed at %s:%d: `%s'\n"),
 286                     "curl_multi_cleanup", __FILE__, __LINE__,
 287                     curl_multi_strerror (mret));
 288       multi = NULL;
 289     }
 290   if (curl != NULL)
 291     {
 292       curl_easy_cleanup (curl);
 293       curl = NULL;
 294     }
 295   if (transport != NULL)
 296     {
 297       GNUNET_TRANSPORT_disconnect (transport);
 298       transport = NULL;
 299     }
 300   GNUNET_free_non_null (current_url);
 301   current_url = NULL;
 302   schedule_hostlist_task ();
 303 }
 304
 305
 306 /**
 307  * Task that is run when we are ready to receive more data from the hostlist
 308  * server.
 309  *
 310  * @param tc
 311  */
 312 static void
 313 multi_ready (void *cls,
 314              const struct GNUNET_SCHEDULER_TaskContext *tc)
 315 {
 316   int running;
 317   struct CURLMsg *msg;
 318   CURLMcode mret;
 319
 320   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_TIMEOUT))
 321     {
 322       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 323                   _("Timeout trying to download hostlist from `%s'\n"),
 324                   current_url);
 325       clean_up ();
 326       return;
 327     }
 328   do
 329     {
 330       running = 0;
 331       mret = curl_multi_perform (multi, &running);
 332       if (running == 0)
 333         {
 334           do
 335             {
 336               msg = curl_multi_info_read (multi, &running);
 337               GNUNET_break (msg != NULL);
 338               if (msg == NULL)
 339                 break;
 340               switch (msg->msg)
 341                 {
 342                 case CURLMSG_DONE:
 343                   if (msg->data.result != CURLE_OK)
 344                     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
 345                                _("%s failed at %s:%d: `%s'\n"),
 346                                "curl_multi_perform", __FILE__,
 347                                __LINE__,
 348                                curl_easy_strerror (msg->data.result));
 349                   break;
 350                 default:
 351                   break;
 352                 }
 353             }
 354           while (running > 0);
 355         }
 356     }
 357   while (mret == CURLM_CALL_MULTI_PERFORM);
 358   if (mret != CURLM_OK)
 359     {
 360       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 361                   _("%s failed at %s:%d: `%s'\n"),
 362                   "curl_multi_perform", __FILE__, __LINE__,
 363                   curl_multi_strerror (mret));
 364       clean_up ();
 365       return;
 366     }
 367   clean_up ();
 368 }
 369
 370
 371 /**
 372  * Ask CURL for the select set and then schedule the
 373  * receiving task with the scheduler.
 374  */
 375 static void
 376 run_multi ()
 377 {
 378   CURLMcode mret;
 379   fd_set rs;
 380   fd_set ws;
 381   fd_set es;
 382   int max;
 383
 384   max = 0;
 385   FD_ZERO (&rs);
 386   FD_ZERO (&ws);
 387   FD_ZERO (&es);
 388   mret = curl_multi_fdset (multi, &rs, &ws, &es, &max);
 389   if (mret != CURLM_OK)
 390     {
 391       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 392                   _("%s failed at %s:%d: `%s'\n"),
 393                   "curl_multi_fdset", __FILE__, __LINE__,
 394                   curl_multi_strerror (mret));
 395       clean_up ();
 396       return;
 397     }
 398   current_task
 399     = GNUNET_SCHEDULER_add_select (sched,
 400                                    GNUNET_NO,
 401                                    GNUNET_SCHEDULER_PRIORITY_DEFAULT,
 402                                    GNUNET_SCHEDULER_NO_TASK,
 403                                    GNUNET_TIME_UNIT_MINUTES,
 404                                    max,
 405                                    &rs,
 406                                    &ws,
 407                                    &multi_ready,
 408                                    multi);
 409 }
 410
 411
 412 /**
 413  * Main function that will download a hostlist and process its
 414  * data.
 415  */
 416 static void
 417 download_hostlist ()
 418 {
 419   CURLcode ret;
 420   CURLMcode mret;
 421
 422   curl = curl_easy_init ();
 423   multi = NULL;
 424   if (curl == NULL)
 425     {
 426       GNUNET_break (0);
 427       clean_up ();
 428       return;
 429     }
 430   transport = GNUNET_TRANSPORT_connect (sched, cfg, NULL, NULL, NULL, NULL);
 431   current_url = get_url ();
 432   GNUNET_log (GNUNET_ERROR_TYPE_INFO | GNUNET_ERROR_TYPE_BULK,
 433               _("Bootstrapping using hostlist at `%s'.\n"),
 434               current_url);
 435
 436   if (proxy != NULL)
 437     CURL_EASY_SETOPT (curl, CURLOPT_PROXY, proxy);
 438   download_pos = 0;
 439   bogus_url = 0;
 440   CURL_EASY_SETOPT (curl,
 441                     CURLOPT_WRITEFUNCTION,
 442                     &download_hostlist_processor);
 443   if (ret != CURLE_OK)
 444     {
 445       clean_up ();
 446       return;
 447     }
 448   CURL_EASY_SETOPT (curl,
 449                     CURLOPT_WRITEDATA,
 450                     NULL);
 451   if (ret != CURLE_OK)
 452     {
 453       clean_up ();
 454       return;
 455     }
 456   CURL_EASY_SETOPT (curl,
 457                     CURLOPT_URL,
 458                     current_url);
 459   if (ret != CURLE_OK)
 460     {
 461       clean_up ();
 462       return;
 463     }
 464   CURL_EASY_SETOPT (curl,
 465                     CURLOPT_FAILONERROR,
 466                     1);
 467   CURL_EASY_SETOPT (curl,
 468                     CURLOPT_BUFFERSIZE,
 469                     GNUNET_SERVER_MAX_MESSAGE_SIZE);
 470   if (0 == strncmp (current_url, "http", 4))
 471     CURL_EASY_SETOPT (curl, CURLOPT_USERAGENT, "GNUnet");
 472   CURL_EASY_SETOPT (curl,
 473                     CURLOPT_CONNECTTIMEOUT,
 474                     150L);
 475   CURL_EASY_SETOPT (curl,
 476                     CURLOPT_NOSIGNAL,
 477                     1);
 478   multi = curl_multi_init ();
 479   if (multi == NULL)
 480     {
 481       GNUNET_break (0);
 482       clean_up ();
 483       return;
 484     }
 485   mret = curl_multi_add_handle (multi, curl);
 486   if (mret != CURLM_OK)
 487     {
 488       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 489                   _("%s failed at %s:%d: `%s'\n"),
 490                   "curl_multi_add_handle", __FILE__, __LINE__,
 491                   curl_multi_strerror (mret));
 492       mret = curl_multi_cleanup (multi);
 493       if (mret != CURLM_OK)
 494         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 495                     _("%s failed at %s:%d: `%s'\n"),
 496                     "curl_multi_cleanup", __FILE__, __LINE__,
 497                     curl_multi_strerror (mret));
 498       multi = NULL;
 499       clean_up ();
 500       return;
 501     }
 502   run_multi (multi);
 503 }
 504
 505
 506 /**
 507  * Task that checks if we should try to download a hostlist.
 508  * If so, we initiate the download, otherwise we schedule
 509  * this task again for a later time.
 510  */
 511 static void
 512 check_task (void *cls,
 513             const struct GNUNET_SCHEDULER_TaskContext *tc)
 514 {
 515   if (connection_count < MIN_CONNECTIONS)
 516     download_hostlist ();
 517   else
 518     schedule_hostlist_task ();
 519 }
 520
 521
 522 /**
 523  * Compute when we should check the next time about downloading
 524  * a hostlist; then schedule the task accordingly.
 525  */
 526 static void
 527 schedule_hostlist_task ()
 528 {
 529   struct GNUNET_TIME_Relative delay;
 530
 531   delay = hostlist_delay;
 532   if (hostlist_delay.value == 0)
 533     hostlist_delay = GNUNET_TIME_UNIT_SECONDS;
 534   else
 535     hostlist_delay = GNUNET_TIME_relative_multiply (hostlist_delay, 2);
 536   if (hostlist_delay.value > GNUNET_TIME_UNIT_HOURS.value * connection_count)
 537     hostlist_delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_DAYS,
 538                                                     connection_count);
 539   GNUNET_STATISTICS_set (stats,
 540                          gettext_noop("Minimum time between hostlist downloads"),
 541                          hostlist_delay.value,
 542                          GNUNET_YES);
 543   current_task = GNUNET_SCHEDULER_add_delayed (sched,
 544                                                GNUNET_NO,
 545                                                GNUNET_SCHEDULER_PRIORITY_IDLE,
 546                                                GNUNET_SCHEDULER_NO_TASK,
 547                                                delay,
 548                                                &check_task,
 549                                                NULL);
 550 }
 551
 552
 553 /**
 554  * Method called whenever a given peer connects.
 555  *
 556  * @param cls closure
 557  * @param peer peer identity this notification is about
 558  */
 559 static void
 560 connect_handler (void *cls,
 561                  const struct
 562                  GNUNET_PeerIdentity * peer)
 563 {
 564   connection_count++;
 565 }
 566
 567
 568 /**
 569  * Method called whenever a given peer connects.
 570  *
 571  * @param cls closure
 572  * @param peer peer identity this notification is about
 573  */
 574 static void
 575 disconnect_handler (void *cls,
 576                     const struct
 577                     GNUNET_PeerIdentity * peer)
 578 {
 579   connection_count--;
 580 }
 581
 582
 583 /**
 584  * Continuation called by the statistics code once
 585  * we go the stat.  Initiates hostlist download scheduling.
 586  *
 587  * @param cls closure
 588  * @param success GNUNET_OK if statistics were
 589  *        successfully obtained, GNUNET_SYSERR if not.
 590  */
 591 static void
 592 primary_task (void *cls, int success)
 593 {
 594   schedule_hostlist_task ();
 595 }
 596
 597
 598 static int
 599 process_stat (void *cls,
 600               const char *subsystem,
 601               const char *name,
 602               unsigned long long value,
 603               int is_persistent)
 604 {
 605   hostlist_delay.value = (uint64_t) value;
 606   return GNUNET_OK;
 607 }
 608
 609
 610 /**
 611  * Start downloading hostlists from hostlist servers as necessary.
 612  */
 613 int
 614 GNUNET_HOSTLIST_client_start (const struct GNUNET_CONFIGURATION_Handle *c,
 615                               struct GNUNET_SCHEDULER_Handle *s,
 616                               struct GNUNET_STATISTICS_Handle *st,
 617                               GNUNET_CORE_ClientEventHandler *ch,
 618                               GNUNET_CORE_ClientEventHandler *dh)
 619 {
 620   if (0 != curl_global_init (CURL_GLOBAL_WIN32))
 621     {
 622       GNUNET_break (0);
 623       return GNUNET_SYSERR;
 624     }
 625   cfg = c;
 626   sched = s;
 627   stats = st;
 628   proxy = NULL;
 629   GNUNET_CONFIGURATION_get_value_string (cfg,
 630                                          "HOSTLIST",
 631                                          "HTTP-PROXY",
 632                                          &proxy);
 633   *ch = &connect_handler;
 634   *dh = &disconnect_handler;
 635   GNUNET_STATISTICS_get (stats,
 636                          "hostlist",
 637                          gettext_noop("Minimum time between hostlist downloads"),
 638                          GNUNET_TIME_UNIT_MINUTES,
 639                          &primary_task,
 640                          &process_stat,
 641                          NULL);
 642   return GNUNET_OK;
 643 }
 644
 645
 646 /**
 647  * Stop downloading hostlists from hostlist servers as necessary.
 648  */
 649 void
 650 GNUNET_HOSTLIST_client_stop ()
 651 {
 652   GNUNET_SCHEDULER_cancel (sched,
 653                            current_task);
 654   GNUNET_free_non_null (proxy);
 655   proxy = NULL;
 656   if (sched != NULL)
 657     curl_global_cleanup ();
 658   cfg = NULL;
 659   sched = NULL;
 660 }
 661
 662 /* end of hostlist-client.c */