src/util/strings.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2005-2013 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 util/strings.c
  23  * @brief string functions
  24  * @author Nils Durner
  25  * @author Christian Grothoff
  26  */
  27
  28 #include "platform.h"
  29 #if HAVE_ICONV
  30 #include <iconv.h>
  31 #endif
  32 #include "gnunet_util_lib.h"
  33 #include <unicase.h>
  34 #include <unistr.h>
  35 #include <uniconv.h>
  36
  37 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
  38
  39 #define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util", syscall)
  40
  41
  42 /**
  43  * Fill a buffer of the given size with
  44  * count 0-terminated strings (given as varargs).
  45  * If "buffer" is NULL, only compute the amount of
  46  * space required (sum of "strlen(arg)+1").
  47  *
  48  * Unlike using "snprintf" with "%s", this function
  49  * will add 0-terminators after each string.  The
  50  * "GNUNET_string_buffer_tokenize" function can be
  51  * used to parse the buffer back into individual
  52  * strings.
  53  *
  54  * @param buffer the buffer to fill with strings, can
  55  *               be NULL in which case only the necessary
  56  *               amount of space will be calculated
  57  * @param size number of bytes available in buffer
  58  * @param count number of strings that follow
  59  * @param ... count 0-terminated strings to copy to buffer
  60  * @return number of bytes written to the buffer
  61  *         (or number of bytes that would have been written)
  62  */
  63 size_t
  64 GNUNET_STRINGS_buffer_fill (char *buffer, size_t size, unsigned int count, ...)
  65 {
  66   size_t needed;
  67   size_t slen;
  68   const char *s;
  69   va_list ap;
  70
  71   needed = 0;
  72   va_start (ap, count);
  73   while (count > 0)
  74   {
  75     s = va_arg (ap, const char *);
  76
  77     slen = strlen (s) + 1;
  78     if (buffer != NULL)
  79     {
  80       GNUNET_assert (needed + slen <= size);
  81       memcpy (&buffer[needed], s, slen);
  82     }
  83     needed += slen;
  84     count--;
  85   }
  86   va_end (ap);
  87   return needed;
  88 }
  89
  90
  91 /**
  92  * Given a buffer of a given size, find "count"
  93  * 0-terminated strings in the buffer and assign
  94  * the count (varargs) of type "const char**" to the
  95  * locations of the respective strings in the
  96  * buffer.
  97  *
  98  * @param buffer the buffer to parse
  99  * @param size size of the buffer
 100  * @param count number of strings to locate
 101  * @return offset of the character after the last 0-termination
 102  *         in the buffer, or 0 on error.
 103  */
 104 unsigned int
 105 GNUNET_STRINGS_buffer_tokenize (const char *buffer, size_t size,
 106                                 unsigned int count, ...)
 107 {
 108   unsigned int start;
 109   unsigned int needed;
 110   const char **r;
 111   va_list ap;
 112
 113   needed = 0;
 114   va_start (ap, count);
 115   while (count > 0)
 116   {
 117     r = va_arg (ap, const char **);
 118
 119     start = needed;
 120     while ((needed < size) && (buffer[needed] != '\0'))
 121       needed++;
 122     if (needed == size)
 123     {
 124       va_end (ap);
 125       return 0;                 /* error */
 126     }
 127     *r = &buffer[start];
 128     needed++;                   /* skip 0-termination */
 129     count--;
 130   }
 131   va_end (ap);
 132   return needed;
 133 }
 134
 135
 136 /**
 137  * Convert a given filesize into a fancy human-readable format.
 138  *
 139  * @param size number of bytes
 140  * @return fancy representation of the size (possibly rounded) for humans
 141  */
 142 char *
 143 GNUNET_STRINGS_byte_size_fancy (unsigned long long size)
 144 {
 145   const char *unit = _( /* size unit */ "b");
 146   char *ret;
 147
 148   if (size > 5 * 1024)
 149   {
 150     size = size / 1024;
 151     unit = "KiB";
 152     if (size > 5 * 1024)
 153     {
 154       size = size / 1024;
 155       unit = "MiB";
 156       if (size > 5 * 1024)
 157       {
 158         size = size / 1024;
 159         unit = "GiB";
 160         if (size > 5 * 1024)
 161         {
 162           size = size / 1024;
 163           unit = "TiB";
 164         }
 165       }
 166     }
 167   }
 168   ret = GNUNET_malloc (32);
 169   GNUNET_snprintf (ret, 32, "%llu %s", size, unit);
 170   return ret;
 171 }
 172
 173
 174 /**
 175  * Unit conversion table entry for 'convert_with_table'.
 176  */
 177 struct ConversionTable
 178 {
 179   /**
 180    * Name of the unit (or NULL for end of table).
 181    */
 182   const char *name;
 183
 184   /**
 185    * Factor to apply for this unit.
 186    */
 187   unsigned long long value;
 188 };
 189
 190
 191 /**
 192  * Convert a string of the form "4 X 5 Y" into a numeric value
 193  * by interpreting "X" and "Y" as units and then multiplying
 194  * the numbers with the values associated with the respective
 195  * unit from the conversion table.
 196  *
 197  * @param input input string to parse
 198  * @param table table with the conversion of unit names to numbers
 199  * @param output where to store the result
 200  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 201  */
 202 static int
 203 convert_with_table (const char *input,
 204                     const struct ConversionTable *table,
 205                     unsigned long long *output)
 206 {
 207   unsigned long long ret;
 208   char *in;
 209   const char *tok;
 210   unsigned long long last;
 211   unsigned int i;
 212
 213   ret = 0;
 214   last = 0;
 215   in = GNUNET_strdup (input);
 216   for (tok = strtok (in, " "); tok != NULL; tok = strtok (NULL, " "))
 217   {
 218     do
 219     {
 220       i = 0;
 221       while ((table[i].name != NULL) && (0 != strcasecmp (table[i].name, tok)))
 222         i++;
 223       if (table[i].name != NULL)
 224       {
 225         last *= table[i].value;
 226         break; /* next tok */
 227       }
 228       else
 229       {
 230         char *endptr;
 231         ret += last;
 232         errno = 0;
 233         last = strtoull (tok, &endptr, 10);
 234         if ((0 != errno) || (endptr == tok))
 235         {
 236           GNUNET_free (in);
 237           return GNUNET_SYSERR;   /* expected number */
 238         }
 239         if ('\0' == endptr[0])
 240           break; /* next tok */
 241         else
 242           tok = endptr; /* and re-check (handles times like "10s") */
 243       }
 244     } while (GNUNET_YES);
 245   }
 246   ret += last;
 247   *output = ret;
 248   GNUNET_free (in);
 249   return GNUNET_OK;
 250 }
 251
 252
 253 /**
 254  * Convert a given fancy human-readable size to bytes.
 255  *
 256  * @param fancy_size human readable string (i.e. 1 MB)
 257  * @param size set to the size in bytes
 258  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 259  */
 260 int
 261 GNUNET_STRINGS_fancy_size_to_bytes (const char *fancy_size,
 262                                     unsigned long long *size)
 263 {
 264   static const struct ConversionTable table[] =
 265   {
 266     { "B", 1},
 267     { "KiB", 1024},
 268     { "kB", 1000},
 269     { "MiB", 1024 * 1024},
 270     { "MB", 1000 * 1000},
 271     { "GiB", 1024 * 1024 * 1024},
 272     { "GB", 1000 * 1000 * 1000},
 273     { "TiB", 1024LL * 1024LL * 1024LL * 1024LL},
 274     { "TB", 1000LL * 1000LL * 1000LL * 1024LL},
 275     { "PiB", 1024LL * 1024LL * 1024LL * 1024LL * 1024LL},
 276     { "PB", 1000LL * 1000LL * 1000LL * 1024LL * 1000LL},
 277     { "EiB", 1024LL * 1024LL * 1024LL * 1024LL * 1024LL * 1024LL},
 278     { "EB", 1000LL * 1000LL * 1000LL * 1024LL * 1000LL * 1000LL},
 279     { NULL, 0}
 280   };
 281
 282   return convert_with_table (fancy_size,
 283                              table,
 284                              size);
 285 }
 286
 287
 288 /**
 289  * Convert a given fancy human-readable time to our internal
 290  * representation.
 291  *
 292  * @param fancy_time human readable string (i.e. 1 minute)
 293  * @param rtime set to the relative time
 294  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 295  */
 296 int
 297 GNUNET_STRINGS_fancy_time_to_relative (const char *fancy_time,
 298                                        struct GNUNET_TIME_Relative *rtime)
 299 {
 300   static const struct ConversionTable table[] =
 301   {
 302     { "us", 1},
 303     { "ms", 1000 },
 304     { "s", 1000 * 1000LL },
 305     { "\"", 1000  * 1000LL },
 306     { "m", 60 * 1000  * 1000LL},
 307     { "min", 60 * 1000  * 1000LL},
 308     { "minutes", 60 * 1000  * 1000LL},
 309     { "'", 60 * 1000  * 1000LL},
 310     { "h", 60 * 60 * 1000  * 1000LL},
 311     { "d", 24 * 60 * 60 * 1000LL * 1000LL},
 312     { "day", 24 * 60 * 60 * 1000LL * 1000LL},
 313     { "days", 24 * 60 * 60 * 1000LL * 1000LL},
 314     { "week", 7 * 24 * 60 * 60 * 1000LL * 1000LL},
 315     { "weeks", 7 * 24 * 60 * 60 * 1000LL * 1000LL},
 316     { "a", 31536000000000LL /* year */ },
 317     { NULL, 0}
 318   };
 319   int ret;
 320   unsigned long long val;
 321
 322   if (0 == strcasecmp ("forever", fancy_time))
 323   {
 324     *rtime = GNUNET_TIME_UNIT_FOREVER_REL;
 325     return GNUNET_OK;
 326   }
 327   ret = convert_with_table (fancy_time,
 328                             table,
 329                             &val);
 330   rtime->rel_value_us = (uint64_t) val;
 331   return ret;
 332 }
 333
 334
 335 /**
 336  * Convert a given fancy human-readable time to our internal
 337  * representation. The human-readable time is expected to be
 338  * in local time, whereas the returned value will be in UTC.
 339  *
 340  * @param fancy_time human readable string (i.e. %Y-%m-%d %H:%M:%S)
 341  * @param atime set to the absolute time
 342  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 343  */
 344 int
 345 GNUNET_STRINGS_fancy_time_to_absolute (const char *fancy_time,
 346                                        struct GNUNET_TIME_Absolute *atime)
 347 {
 348   struct tm tv;
 349   time_t t;
 350
 351   if (0 == strcasecmp ("end of time", fancy_time))
 352   {
 353     *atime = GNUNET_TIME_UNIT_FOREVER_ABS;
 354     return GNUNET_OK;
 355   }
 356   memset (&tv, 0, sizeof (tv));
 357   if ( (NULL == strptime (fancy_time, "%a %b %d %H:%M:%S %Y", &tv)) &&
 358        (NULL == strptime (fancy_time, "%c", &tv)) &&
 359        (NULL == strptime (fancy_time, "%Ec", &tv)) &&
 360        (NULL == strptime (fancy_time, "%Y-%m-%d %H:%M:%S", &tv)) &&
 361        (NULL == strptime (fancy_time, "%Y-%m-%d %H:%M", &tv)) &&
 362        (NULL == strptime (fancy_time, "%x", &tv)) &&
 363        (NULL == strptime (fancy_time, "%Ex", &tv)) &&
 364        (NULL == strptime (fancy_time, "%Y-%m-%d", &tv)) &&
 365        (NULL == strptime (fancy_time, "%Y-%m", &tv)) &&
 366        (NULL == strptime (fancy_time, "%Y", &tv)) )
 367     return GNUNET_SYSERR;
 368   t = mktime (&tv);
 369   atime->abs_value_us = (uint64_t) ((uint64_t) t * 1000LL * 1000LL);
 370   return GNUNET_OK;
 371 }
 372
 373
 374 /**
 375  * Convert the len characters long character sequence
 376  * given in input that is in the given input charset
 377  * to a string in given output charset.
 378  *
 379  * @param input input string
 380  * @param len number of bytes in @a input
 381  * @param input_charset character set used for @a input
 382  * @param output_charset desired character set for the return value
 383  * @return the converted string (0-terminated),
 384  *  if conversion fails, a copy of the orignal
 385  *  string is returned.
 386  */
 387 char *
 388 GNUNET_STRINGS_conv (const char *input,
 389                      size_t len,
 390                      const char *input_charset,
 391                      const char *output_charset)
 392 {
 393   char *ret;
 394   uint8_t *u8_string;
 395   char *encoded_string;
 396   size_t u8_string_length;
 397   size_t encoded_string_length;
 398
 399   u8_string = u8_conv_from_encoding (input_charset,
 400                                      iconveh_error,
 401                                      input, len,
 402                                      NULL, NULL,
 403                                      &u8_string_length);
 404   if (NULL == u8_string)
 405   {
 406     LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "u8_conv_from_encoding");
 407     goto fail;
 408   }
 409   if (0 == strcmp (output_charset, "UTF-8"))
 410   {
 411     ret = GNUNET_malloc (u8_string_length + 1);
 412     memcpy (ret, u8_string, u8_string_length);
 413     ret[u8_string_length] = '\0';
 414     free (u8_string);
 415     return ret;
 416   }
 417   encoded_string = u8_conv_to_encoding (output_charset, iconveh_error,
 418                                         u8_string, u8_string_length,
 419                                         NULL, NULL,
 420                                         &encoded_string_length);
 421   free (u8_string);
 422   if (NULL == encoded_string)
 423   {
 424     LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "u8_conv_to_encoding");
 425     goto fail;
 426   }
 427   ret = GNUNET_malloc (encoded_string_length + 1);
 428   memcpy (ret, encoded_string, encoded_string_length);
 429   ret[encoded_string_length] = '\0';
 430   free (encoded_string);
 431   return ret;
 432  fail:
 433   LOG (GNUNET_ERROR_TYPE_WARNING,
 434        _("Character sets requested were `%s'->`%s'\n"),
 435        "UTF-8", output_charset);
 436   ret = GNUNET_malloc (len + 1);
 437   memcpy (ret, input, len);
 438   ret[len] = '\0';
 439   return ret;
 440 }
 441
 442
 443 /**
 444  * Convert the len characters long character sequence
 445  * given in input that is in the given charset
 446  * to UTF-8.
 447  *
 448  * @param input the input string (not necessarily 0-terminated)
 449  * @param len the number of bytes in the @a input
 450  * @param charset character set to convert from
 451  * @return the converted string (0-terminated),
 452  *  if conversion fails, a copy of the orignal
 453  *  string is returned.
 454  */
 455 char *
 456 GNUNET_STRINGS_to_utf8 (const char *input,
 457                         size_t len,
 458                         const char *charset)
 459 {
 460   return GNUNET_STRINGS_conv (input, len, charset, "UTF-8");
 461 }
 462
 463
 464 /**
 465  * Convert the len bytes-long UTF-8 string
 466  * given in input to the given charset.
 467  *
 468  * @param input the input string (not necessarily 0-terminated)
 469  * @param len the number of bytes in the @a input
 470  * @param charset character set to convert to
 471  * @return the converted string (0-terminated),
 472  *  if conversion fails, a copy of the orignal
 473  *  string is returned.
 474  */
 475 char *
 476 GNUNET_STRINGS_from_utf8 (const char *input,
 477                           size_t len,
 478                           const char *charset)
 479 {
 480   return GNUNET_STRINGS_conv (input, len, "UTF-8", charset);
 481 }
 482
 483
 484 /**
 485  * Convert the utf-8 input string to lowercase.
 486  * Output needs to be allocated appropriately.
 487  *
 488  * @param input input string
 489  * @param output output buffer
 490  */
 491 void
 492 GNUNET_STRINGS_utf8_tolower (const char *input,
 493                              char *output)
 494 {
 495   uint8_t *tmp_in;
 496   size_t len;
 497
 498   tmp_in = u8_tolower ((uint8_t*)input, strlen ((char *) input),
 499                        NULL, UNINORM_NFD, NULL, &len);
 500   memcpy(output, tmp_in, len);
 501   output[len] = '\0';
 502   free(tmp_in);
 503 }
 504
 505
 506 /**
 507  * Convert the utf-8 input string to uppercase.
 508  * Output needs to be allocated appropriately.
 509  *
 510  * @param input input string
 511  * @param output output buffer
 512  */
 513 void
 514 GNUNET_STRINGS_utf8_toupper(const char *input,
 515                             char *output)
 516 {
 517   uint8_t *tmp_in;
 518   size_t len;
 519
 520   tmp_in = u8_toupper ((uint8_t*)input, strlen ((char *) input),
 521                        NULL, UNINORM_NFD, NULL, &len);
 522   memcpy (output, tmp_in, len);
 523   output[len] = '\0';
 524   free (tmp_in);
 525 }
 526
 527
 528 /**
 529  * Complete filename (a la shell) from abbrevition.
 530  * @param fil the name of the file, may contain ~/ or
 531  *        be relative to the current directory
 532  * @returns the full file name,
 533  *          NULL is returned on error
 534  */
 535 char *
 536 GNUNET_STRINGS_filename_expand (const char *fil)
 537 {
 538   char *buffer;
 539 #ifndef MINGW
 540   size_t len;
 541   size_t n;
 542   char *fm;
 543   const char *fil_ptr;
 544 #else
 545   char *fn;
 546   long lRet;
 547 #endif
 548
 549   if (fil == NULL)
 550     return NULL;
 551
 552 #ifndef MINGW
 553   if (fil[0] == DIR_SEPARATOR)
 554     /* absolute path, just copy */
 555     return GNUNET_strdup (fil);
 556   if (fil[0] == '~')
 557   {
 558     fm = getenv ("HOME");
 559     if (fm == NULL)
 560     {
 561       LOG (GNUNET_ERROR_TYPE_WARNING,
 562            _("Failed to expand `$HOME': environment variable `HOME' not set"));
 563       return NULL;
 564     }
 565     fm = GNUNET_strdup (fm);
 566     /* do not copy '~' */
 567     fil_ptr = fil + 1;
 568
 569     /* skip over dir seperator to be consistent */
 570     if (fil_ptr[0] == DIR_SEPARATOR)
 571       fil_ptr++;
 572   }
 573   else
 574   {
 575     /* relative path */
 576     fil_ptr = fil;
 577     len = 512;
 578     fm = NULL;
 579     while (1)
 580     {
 581       buffer = GNUNET_malloc (len);
 582       if (getcwd (buffer, len) != NULL)
 583       {
 584         fm = buffer;
 585         break;
 586       }
 587       if ((errno == ERANGE) && (len < 1024 * 1024 * 4))
 588       {
 589         len *= 2;
 590         GNUNET_free (buffer);
 591         continue;
 592       }
 593       GNUNET_free (buffer);
 594       break;
 595     }
 596     if (fm == NULL)
 597     {
 598       LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "getcwd");
 599       buffer = getenv ("PWD");  /* alternative */
 600       if (buffer != NULL)
 601         fm = GNUNET_strdup (buffer);
 602     }
 603     if (fm == NULL)
 604       fm = GNUNET_strdup ("./");        /* give up */
 605   }
 606   n = strlen (fm) + 1 + strlen (fil_ptr) + 1;
 607   buffer = GNUNET_malloc (n);
 608   GNUNET_snprintf (buffer, n, "%s%s%s", fm,
 609                    (fm[strlen (fm) - 1] ==
 610                     DIR_SEPARATOR) ? "" : DIR_SEPARATOR_STR, fil_ptr);
 611   GNUNET_free (fm);
 612   return buffer;
 613 #else
 614   fn = GNUNET_malloc (MAX_PATH + 1);
 615
 616   if ((lRet = plibc_conv_to_win_path (fil, fn)) != ERROR_SUCCESS)
 617   {
 618     SetErrnoFromWinError (lRet);
 619     LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "plibc_conv_to_win_path");
 620     return NULL;
 621   }
 622   /* is the path relative? */
 623   if ((strncmp (fn + 1, ":\\", 2) != 0) && (strncmp (fn, "\\\\", 2) != 0))
 624   {
 625     char szCurDir[MAX_PATH + 1];
 626
 627     lRet = GetCurrentDirectory (MAX_PATH + 1, szCurDir);
 628     if (lRet + strlen (fn) + 1 > (MAX_PATH + 1))
 629     {
 630       SetErrnoFromWinError (ERROR_BUFFER_OVERFLOW);
 631       LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "GetCurrentDirectory");
 632       return NULL;
 633     }
 634     buffer = GNUNET_malloc (MAX_PATH + 1);
 635     GNUNET_snprintf (buffer, MAX_PATH + 1, "%s\\%s", szCurDir, fn);
 636     GNUNET_free (fn);
 637     fn = buffer;
 638   }
 639
 640   return fn;
 641 #endif
 642 }
 643
 644
 645 /**
 646  * Give relative time in human-readable fancy format.
 647  * This is one of the very few calls in the entire API that is
 648  * NOT reentrant!
 649  *
 650  * @param delta time in milli seconds
 651  * @param do_round are we allowed to round a bit?
 652  * @return time as human-readable string
 653  */
 654 const char *
 655 GNUNET_STRINGS_relative_time_to_string (struct GNUNET_TIME_Relative delta,
 656                                         int do_round)
 657 {
 658   static char buf[128];
 659   const char *unit = _( /* time unit */ "µs");
 660   uint64_t dval = delta.rel_value_us;
 661
 662   if (GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us == delta.rel_value_us)
 663     return _("forever");
 664   if (0 == delta.rel_value_us)
 665     return _("0 ms");
 666   if ( ( (GNUNET_YES == do_round) &&
 667          (dval > 5 * 1000) ) ||
 668        (0 == (dval % 1000) ))
 669   {
 670     dval = dval / 1000;
 671     unit = _( /* time unit */ "ms");
 672     if ( ( (GNUNET_YES == do_round) &&
 673            (dval > 5 * 1000) ) ||
 674          (0 == (dval % 1000) ))
 675     {
 676       dval = dval / 1000;
 677       unit = _( /* time unit */ "s");
 678       if ( ( (GNUNET_YES == do_round) &&
 679              (dval > 5 * 60) ) ||
 680            (0 == (dval % 60) ) )
 681       {
 682         dval = dval / 60;
 683         unit = _( /* time unit */ "m");
 684         if ( ( (GNUNET_YES == do_round) &&
 685                (dval > 5 * 60) ) ||
 686              (0 == (dval % 60) ))
 687         {
 688           dval = dval / 60;
 689           unit = _( /* time unit */ "h");
 690           if ( ( (GNUNET_YES == do_round) &&
 691                  (dval > 5 * 24) ) ||
 692                (0 == (dval % 24)) )
 693           {
 694             dval = dval / 24;
 695             if (1 == dval)
 696               unit = _( /* time unit */ "day");
 697             else
 698               unit = _( /* time unit */ "days");
 699           }
 700         }
 701       }
 702     }
 703   }
 704   GNUNET_snprintf (buf, sizeof (buf),
 705                    "%llu %s", dval, unit);
 706   return buf;
 707 }
 708
 709
 710 /**
 711  * "asctime", except for GNUnet time.  Converts a GNUnet internal
 712  * absolute time (which is in UTC) to a string in local time.
 713  * Note that the returned value will be overwritten if this function
 714  * is called again.
 715  *
 716  * @param t the absolute time to convert
 717  * @return timestamp in human-readable form in local time
 718  */
 719 const char *
 720 GNUNET_STRINGS_absolute_time_to_string (struct GNUNET_TIME_Absolute t)
 721 {
 722   static char buf[255];
 723   time_t tt;
 724   struct tm *tp;
 725
 726   if (t.abs_value_us == GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us)
 727     return _("end of time");
 728   tt = t.abs_value_us / 1000LL / 1000LL;
 729   tp = localtime (&tt);
 730   /* This is hacky, but i don't know a way to detect libc character encoding.
 731    * Just expect utf8 from glibc these days.
 732    * As for msvcrt, use the wide variant, which always returns utf16
 733    * (otherwise we'd have to detect current codepage or use W32API character
 734    * set conversion routines to convert to UTF8).
 735    */
 736 #ifndef WINDOWS
 737   strftime (buf, sizeof (buf), "%a %b %d %H:%M:%S %Y", tp);
 738 #else
 739   {
 740     static wchar_t wbuf[255];
 741     uint8_t *conved;
 742     size_t ssize;
 743
 744     wcsftime (wbuf, sizeof (wbuf) / sizeof (wchar_t),
 745         L"%a %b %d %H:%M:%S %Y", tp);
 746
 747     ssize = sizeof (buf);
 748     conved = u16_to_u8 (wbuf, sizeof (wbuf) / sizeof (wchar_t),
 749         (uint8_t *) buf, &ssize);
 750     if (conved != (uint8_t *) buf)
 751     {
 752       strncpy (buf, (char *) conved, sizeof (buf));
 753       buf[255 - 1] = '\0';
 754       free (conved);
 755     }
 756   }
 757 #endif
 758   return buf;
 759 }
 760
 761
 762 /**
 763  * "man basename"
 764  * Returns a pointer to a part of filename (allocates nothing)!
 765  *
 766  * @param filename filename to extract basename from
 767  * @return short (base) name of the file (that is, everything following the
 768  *         last directory separator in filename. If filename ends with a
 769  *         directory separator, the result will be a zero-length string.
 770  *         If filename has no directory separators, the result is filename
 771  *         itself.
 772  */
 773 const char *
 774 GNUNET_STRINGS_get_short_name (const char *filename)
 775 {
 776   const char *short_fn = filename;
 777   const char *ss;
 778   while (NULL != (ss = strstr (short_fn, DIR_SEPARATOR_STR))
 779       && (ss[1] != '\0'))
 780     short_fn = 1 + ss;
 781   return short_fn;
 782 }
 783
 784
 785 /**
 786  * Get the numeric value corresponding to a character.
 787  *
 788  * @param a a character
 789  * @return corresponding numeric value
 790  */
 791 static unsigned int
 792 getValue__ (unsigned char a)
 793 {
 794   if ((a >= '0') && (a <= '9'))
 795     return a - '0';
 796   if ((a >= 'A') && (a <= 'V'))
 797     return (a - 'A' + 10);
 798   if ((a >= 'a') && (a <= 'v'))
 799     return (a - 'a' + 10);
 800   return -1;
 801 }
 802
 803
 804 /**
 805  * Convert binary data to ASCII encoding using Base32Hex (RFC 4648).
 806  * Does not append 0-terminator, but returns a pointer to the place where
 807  * it should be placed, if needed.
 808  *
 809  * @param data data to encode
 810  * @param size size of data (in bytes)
 811  * @param out buffer to fill
 812  * @param out_size size of the buffer. Must be large enough to hold
 813  * ((size*8) + (((size*8) % 5) > 0 ? 5 - ((size*8) % 5) : 0)) / 5 bytes
 814  * @return pointer to the next byte in 'out' or NULL on error.
 815  */
 816 char *
 817 GNUNET_STRINGS_data_to_string (const void *data, size_t size, char *out, size_t out_size)
 818 {
 819   /**
 820    * 32 characters for encoding
 821    */
 822   static char *encTable__ = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
 823   unsigned int wpos;
 824   unsigned int rpos;
 825   unsigned int bits;
 826   unsigned int vbit;
 827   const unsigned char *udata;
 828
 829   GNUNET_assert (data != NULL);
 830   GNUNET_assert (out != NULL);
 831   udata = data;
 832   if (out_size < (((size*8) + ((size*8) % 5)) % 5))
 833   {
 834     GNUNET_break (0);
 835     return NULL;
 836   }
 837   vbit = 0;
 838   wpos = 0;
 839   rpos = 0;
 840   bits = 0;
 841   while ((rpos < size) || (vbit > 0))
 842   {
 843     if ((rpos < size) && (vbit < 5))
 844     {
 845       bits = (bits << 8) | udata[rpos++];   /* eat 8 more bits */
 846       vbit += 8;
 847     }
 848     if (vbit < 5)
 849     {
 850       bits <<= (5 - vbit);      /* zero-padding */
 851       GNUNET_assert (vbit == ((size * 8) % 5));
 852       vbit = 5;
 853     }
 854     if (wpos >= out_size)
 855     {
 856       GNUNET_break (0);
 857       return NULL;
 858     }
 859     out[wpos++] = encTable__[(bits >> (vbit - 5)) & 31];
 860     vbit -= 5;
 861   }
 862   GNUNET_assert (vbit == 0);
 863   if (wpos < out_size)
 864     out[wpos] = '\0';
 865   return &out[wpos];
 866 }
 867
 868
 869 /**
 870  * Convert Base32hex encoding back to data.
 871  * @a out_size must match exactly the size of the data before it was encoded.
 872  *
 873  * @param enc the encoding
 874  * @param enclen number of characters in @a enc (without 0-terminator, which can be missing)
 875  * @param out location where to store the decoded data
 876  * @param out_size size of the output buffer @a out
 877  * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
 878  */
 879 int
 880 GNUNET_STRINGS_string_to_data (const char *enc, size_t enclen,
 881                                void *out, size_t out_size)
 882 {
 883   unsigned int rpos;
 884   unsigned int wpos;
 885   unsigned int bits;
 886   unsigned int vbit;
 887   int ret;
 888   int shift;
 889   unsigned char *uout;
 890   unsigned int encoded_len = out_size * 8;
 891
 892   if (0 == enclen)
 893   {
 894     if (0 == out_size)
 895       return GNUNET_OK;
 896     return GNUNET_SYSERR;
 897   }
 898   uout = out;
 899   wpos = out_size;
 900   rpos = enclen;
 901   if ((encoded_len % 5) > 0)
 902   {
 903     vbit = encoded_len % 5; /* padding! */
 904     shift = 5 - vbit;
 905     bits = (ret = getValue__ (enc[--rpos])) >> (5 - (encoded_len % 5));
 906   }
 907   else
 908   {
 909     vbit = 5;
 910     shift = 0;
 911     bits = (ret = getValue__ (enc[--rpos]));
 912   }
 913   if ((encoded_len + shift) / 5 != enclen)
 914     return GNUNET_SYSERR;
 915   if (-1 == ret)
 916     return GNUNET_SYSERR;
 917   while (wpos > 0)
 918   {
 919     if (0 == rpos)
 920     {
 921       GNUNET_break (0);
 922       return GNUNET_SYSERR;
 923     }
 924     bits = ((ret = getValue__ (enc[--rpos])) << vbit) | bits;
 925     if (-1 == ret)
 926       return GNUNET_SYSERR;
 927     vbit += 5;
 928     if (vbit >= 8)
 929     {
 930       uout[--wpos] = (unsigned char) bits;
 931       bits >>= 8;
 932       vbit -= 8;
 933     }
 934   }
 935   if ( (0 != rpos) ||
 936        (0 != vbit) )
 937     return GNUNET_SYSERR;
 938   return GNUNET_OK;
 939 }
 940
 941
 942 /**
 943  * Parse a path that might be an URI.
 944  *
 945  * @param path path to parse. Must be NULL-terminated.
 946  * @param scheme_part a pointer to 'char *' where a pointer to a string that
 947  *        represents the URI scheme will be stored. Can be NULL. The string is
 948  *        allocated by the function, and should be freed by GNUNET_free() when
 949  *        it is no longer needed.
 950  * @param path_part a pointer to 'const char *' where a pointer to the path
 951  *        part of the URI will be stored. Can be NULL. Points to the same block
 952  *        of memory as 'path', and thus must not be freed. Might point to '\0',
 953  *        if path part is zero-length.
 954  * @return GNUNET_YES if it's an URI, GNUNET_NO otherwise. If 'path' is not
 955  *         an URI, '* scheme_part' and '*path_part' will remain unchanged
 956  *         (if they weren't NULL).
 957  */
 958 int
 959 GNUNET_STRINGS_parse_uri (const char *path, char **scheme_part,
 960     const char **path_part)
 961 {
 962   size_t len;
 963   int i, end;
 964   int pp_state = 0;
 965   const char *post_scheme_part = NULL;
 966   len = strlen (path);
 967   for (end = 0, i = 0; !end && i < len; i++)
 968   {
 969     switch (pp_state)
 970     {
 971     case 0:
 972       if (path[i] == ':' && i > 0)
 973       {
 974         pp_state += 1;
 975         continue;
 976       }
 977       if (!((path[i] >= 'A' && path[i] <= 'Z') || (path[i] >= 'a' && path[i] <= 'z')
 978           || (path[i] >= '0' && path[i] <= '9') || path[i] == '+' || path[i] == '-'
 979           || (path[i] == '.')))
 980         end = 1;
 981       break;
 982     case 1:
 983     case 2:
 984       if (path[i] == '/')
 985       {
 986         pp_state += 1;
 987         continue;
 988       }
 989       end = 1;
 990       break;
 991     case 3:
 992       post_scheme_part = &path[i];
 993       end = 1;
 994       break;
 995     default:
 996       end = 1;
 997     }
 998   }
 999   if (post_scheme_part == NULL)
1000     return GNUNET_NO;
1001   if (scheme_part)
1002   {
1003     *scheme_part = GNUNET_malloc (post_scheme_part - path + 1);
1004     memcpy (*scheme_part, path, post_scheme_part - path);
1005     (*scheme_part)[post_scheme_part - path] = '\0';
1006   }
1007   if (path_part)
1008     *path_part = post_scheme_part;
1009   return GNUNET_YES;
1010 }
1011
1012
1013 /**
1014  * Check whether @a filename is absolute or not, and if it's an URI
1015  *
1016  * @param filename filename to check
1017  * @param can_be_uri #GNUNET_YES to check for being URI, #GNUNET_NO - to
1018  *        assume it's not URI
1019  * @param r_is_uri a pointer to an int that is set to #GNUNET_YES if @a filename
1020  *        is URI and to #GNUNET_NO otherwise. Can be NULL. If @a can_be_uri is
1021  *        not #GNUNET_YES, `* r_is_uri` is set to #GNUNET_NO.
1022  * @param r_uri_scheme a pointer to a char * that is set to a pointer to URI scheme.
1023  *        The string is allocated by the function, and should be freed with
1024  *        GNUNET_free(). Can be NULL.
1025  * @return #GNUNET_YES if @a filename is absolute, #GNUNET_NO otherwise.
1026  */
1027 int
1028 GNUNET_STRINGS_path_is_absolute (const char *filename,
1029                                  int can_be_uri,
1030                                  int *r_is_uri,
1031                                  char **r_uri_scheme)
1032 {
1033 #if WINDOWS
1034   size_t len;
1035 #endif
1036   const char *post_scheme_path;
1037   int is_uri;
1038   char * uri;
1039   /* consider POSIX paths to be absolute too, even on W32,
1040    * as plibc expansion will fix them for us.
1041    */
1042   if (filename[0] == '/')
1043     return GNUNET_YES;
1044   if (can_be_uri)
1045   {
1046     is_uri = GNUNET_STRINGS_parse_uri (filename, &uri, &post_scheme_path);
1047     if (r_is_uri)
1048       *r_is_uri = is_uri;
1049     if (is_uri)
1050     {
1051       if (r_uri_scheme)
1052         *r_uri_scheme = uri;
1053       else
1054         GNUNET_free_non_null (uri);
1055 #if WINDOWS
1056       len = strlen(post_scheme_path);
1057       /* Special check for file:///c:/blah
1058        * We want to parse 'c:/', not '/c:/'
1059        */
1060       if (post_scheme_path[0] == '/' && len >= 3 && post_scheme_path[2] == ':')
1061         post_scheme_path = &post_scheme_path[1];
1062 #endif
1063       return GNUNET_STRINGS_path_is_absolute (post_scheme_path, GNUNET_NO, NULL, NULL);
1064     }
1065   }
1066   else
1067   {
1068     if (r_is_uri)
1069       *r_is_uri = GNUNET_NO;
1070   }
1071 #if WINDOWS
1072   len = strlen (filename);
1073   if (len >= 3 &&
1074       ((filename[0] >= 'A' && filename[0] <= 'Z')
1075       || (filename[0] >= 'a' && filename[0] <= 'z'))
1076       && filename[1] == ':' && (filename[2] == '/' || filename[2] == '\\'))
1077     return GNUNET_YES;
1078 #endif
1079   return GNUNET_NO;
1080 }
1081
1082 #if MINGW
1083 #define         _IFMT           0170000 /* type of file */
1084 #define         _IFLNK          0120000 /* symbolic link */
1085 #define  S_ISLNK(m)     (((m)&_IFMT) == _IFLNK)
1086 #endif
1087
1088
1089 /**
1090  * Perform @a checks on @a filename.
1091  *
1092  * @param filename file to check
1093  * @param checks checks to perform
1094  * @return #GNUNET_YES if all checks pass, #GNUNET_NO if at least one of them
1095  *         fails, #GNUNET_SYSERR when a check can't be performed
1096  */
1097 int
1098 GNUNET_STRINGS_check_filename (const char *filename,
1099                                enum GNUNET_STRINGS_FilenameCheck checks)
1100 {
1101   struct stat st;
1102   if ( (NULL == filename) || (filename[0] == '\0') )
1103     return GNUNET_SYSERR;
1104   if (0 != (checks & GNUNET_STRINGS_CHECK_IS_ABSOLUTE))
1105     if (!GNUNET_STRINGS_path_is_absolute (filename, GNUNET_NO, NULL, NULL))
1106       return GNUNET_NO;
1107   if (0 != (checks & (GNUNET_STRINGS_CHECK_EXISTS
1108                       | GNUNET_STRINGS_CHECK_IS_DIRECTORY
1109                       | GNUNET_STRINGS_CHECK_IS_LINK)))
1110   {
1111     if (0 != STAT (filename, &st))
1112     {
1113       if (0 != (checks & GNUNET_STRINGS_CHECK_EXISTS))
1114         return GNUNET_NO;
1115       else
1116         return GNUNET_SYSERR;
1117     }
1118   }
1119   if (0 != (checks & GNUNET_STRINGS_CHECK_IS_DIRECTORY))
1120     if (!S_ISDIR (st.st_mode))
1121       return GNUNET_NO;
1122   if (0 != (checks & GNUNET_STRINGS_CHECK_IS_LINK))
1123     if (!S_ISLNK (st.st_mode))
1124       return GNUNET_NO;
1125   return GNUNET_YES;
1126 }
1127
1128
1129 /**
1130  * Tries to convert 'zt_addr' string to an IPv6 address.
1131  * The string is expected to have the format "[ABCD::01]:80".
1132  *
1133  * @param zt_addr 0-terminated string. May be mangled by the function.
1134  * @param addrlen length of @a zt_addr (not counting 0-terminator).
1135  * @param r_buf a buffer to fill. Initially gets filled with zeroes,
1136  *        then its sin6_port, sin6_family and sin6_addr are set appropriately.
1137  * @return #GNUNET_OK if conversion succeded.
1138  *         #GNUNET_SYSERR otherwise, in which
1139  *         case the contents of @a r_buf are undefined.
1140  */
1141 int
1142 GNUNET_STRINGS_to_address_ipv6 (const char *zt_addr,
1143                                 uint16_t addrlen,
1144                                 struct sockaddr_in6 *r_buf)
1145 {
1146   char zbuf[addrlen + 1];
1147   int ret;
1148   char *port_colon;
1149   unsigned int port;
1150
1151   if (addrlen < 6)
1152     return GNUNET_SYSERR;
1153   memcpy (zbuf, zt_addr, addrlen);
1154   if ('[' != zbuf[0])
1155   {
1156     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1157                 _("IPv6 address did not start with `['\n"));
1158     return GNUNET_SYSERR;
1159   }
1160   zbuf[addrlen] = '\0';
1161   port_colon = strrchr (zbuf, ':');
1162   if (NULL == port_colon)
1163   {
1164     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1165                 _("IPv6 address did contain ':' to separate port number\n"));
1166     return GNUNET_SYSERR;
1167   }
1168   if (']' != *(port_colon - 1))
1169   {
1170     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1171                 _("IPv6 address did contain ']' before ':' to separate port number\n"));
1172     return GNUNET_SYSERR;
1173   }
1174   ret = SSCANF (port_colon, ":%u", &port);
1175   if ( (1 != ret) || (port > 65535) )
1176   {
1177     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1178                 _("IPv6 address did contain a valid port number after the last ':'\n"));
1179     return GNUNET_SYSERR;
1180   }
1181   *(port_colon-1) = '\0';
1182   memset (r_buf, 0, sizeof (struct sockaddr_in6));
1183   ret = inet_pton (AF_INET6, &zbuf[1], &r_buf->sin6_addr);
1184   if (ret <= 0)
1185   {
1186     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1187                 _("Invalid IPv6 address `%s': %s\n"),
1188                 &zbuf[1],
1189                 STRERROR (errno));
1190     return GNUNET_SYSERR;
1191   }
1192   r_buf->sin6_port = htons (port);
1193   r_buf->sin6_family = AF_INET6;
1194 #if HAVE_SOCKADDR_IN_SIN_LEN
1195   r_buf->sin6_len = (u_char) sizeof (struct sockaddr_in6);
1196 #endif
1197   return GNUNET_OK;
1198 }
1199
1200
1201 /**
1202  * Tries to convert 'zt_addr' string to an IPv4 address.
1203  * The string is expected to have the format "1.2.3.4:80".
1204  *
1205  * @param zt_addr 0-terminated string. May be mangled by the function.
1206  * @param addrlen length of @a zt_addr (not counting 0-terminator).
1207  * @param r_buf a buffer to fill.
1208  * @return #GNUNET_OK if conversion succeded.
1209  *         #GNUNET_SYSERR otherwise, in which case
1210  *         the contents of @a r_buf are undefined.
1211  */
1212 int
1213 GNUNET_STRINGS_to_address_ipv4 (const char *zt_addr, uint16_t addrlen,
1214                                 struct sockaddr_in *r_buf)
1215 {
1216   unsigned int temps[4];
1217   unsigned int port;
1218   unsigned int cnt;
1219
1220   if (addrlen < 9)
1221     return GNUNET_SYSERR;
1222   cnt = SSCANF (zt_addr, "%u.%u.%u.%u:%u", &temps[0], &temps[1], &temps[2], &temps[3], &port);
1223   if (5 != cnt)
1224     return GNUNET_SYSERR;
1225   for (cnt = 0; cnt < 4; cnt++)
1226     if (temps[cnt] > 0xFF)
1227       return GNUNET_SYSERR;
1228   if (port > 65535)
1229     return GNUNET_SYSERR;
1230   r_buf->sin_family = AF_INET;
1231   r_buf->sin_port = htons (port);
1232   r_buf->sin_addr.s_addr = htonl ((temps[0] << 24) + (temps[1] << 16) +
1233                                   (temps[2] << 8) + temps[3]);
1234 #if HAVE_SOCKADDR_IN_SIN_LEN
1235   r_buf->sin_len = (u_char) sizeof (struct sockaddr_in);
1236 #endif
1237   return GNUNET_OK;
1238 }
1239
1240
1241 /**
1242  * Tries to convert @a addr string to an IP (v4 or v6) address.
1243  * Will automatically decide whether to treat 'addr' as v4 or v6 address.
1244  *
1245  * @param addr a string, may not be 0-terminated.
1246  * @param addrlen number of bytes in @a addr (if addr is 0-terminated,
1247  *        0-terminator should not be counted towards addrlen).
1248  * @param r_buf a buffer to fill.
1249  * @return #GNUNET_OK if conversion succeded. GNUNET_SYSERR otherwise, in which
1250  *         case the contents of r_buf are undefined.
1251  */
1252 int
1253 GNUNET_STRINGS_to_address_ip (const char *addr,
1254                               uint16_t addrlen,
1255                               struct sockaddr_storage *r_buf)
1256 {
1257   if (addr[0] == '[')
1258     return GNUNET_STRINGS_to_address_ipv6 (addr,
1259                                            addrlen,
1260                                            (struct sockaddr_in6 *) r_buf);
1261   return GNUNET_STRINGS_to_address_ipv4 (addr,
1262                                          addrlen,
1263                                          (struct sockaddr_in *) r_buf);
1264 }
1265
1266
1267 /**
1268  * Makes a copy of argv that consists of a single memory chunk that can be
1269  * freed with a single call to GNUNET_free();
1270  */
1271 static char *const *
1272 _make_continuous_arg_copy (int argc,
1273                            char *const *argv)
1274 {
1275   size_t argvsize = 0;
1276   int i;
1277   char **new_argv;
1278   char *p;
1279   for (i = 0; i < argc; i++)
1280     argvsize += strlen (argv[i]) + 1 + sizeof (char *);
1281   new_argv = GNUNET_malloc (argvsize + sizeof (char *));
1282   p = (char *) &new_argv[argc + 1];
1283   for (i = 0; i < argc; i++)
1284   {
1285     new_argv[i] = p;
1286     strcpy (p, argv[i]);
1287     p += strlen (argv[i]) + 1;
1288   }
1289   new_argv[argc] = NULL;
1290   return (char *const *) new_argv;
1291 }
1292
1293
1294 /**
1295  * Returns utf-8 encoded arguments.
1296  * Does nothing (returns a copy of argc and argv) on any platform
1297  * other than W32.
1298  * Returned argv has u8argv[u8argc] == NULL.
1299  * Returned argv is a single memory block, and can be freed with a single
1300  *   GNUNET_free() call.
1301  *
1302  * @param argc argc (as given by main())
1303  * @param argv argv (as given by main())
1304  * @param u8argc a location to store new argc in (though it's th same as argc)
1305  * @param u8argv a location to store new argv in
1306  * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
1307  */
1308 int
1309 GNUNET_STRINGS_get_utf8_args (int argc, char *const *argv, int *u8argc, char *const **u8argv)
1310 {
1311 #if WINDOWS
1312   wchar_t *wcmd;
1313   wchar_t **wargv;
1314   int wargc;
1315   int i;
1316   char **split_u8argv;
1317
1318   wcmd = GetCommandLineW ();
1319   if (NULL == wcmd)
1320     return GNUNET_SYSERR;
1321   wargv = CommandLineToArgvW (wcmd, &wargc);
1322   if (NULL == wargv)
1323     return GNUNET_SYSERR;
1324
1325   split_u8argv = GNUNET_malloc (argc * sizeof (char *));
1326
1327   for (i = 0; i < wargc; i++)
1328   {
1329     size_t strl;
1330     /* Hopefully it will allocate us NUL-terminated strings... */
1331     split_u8argv[i] = (char *) u16_to_u8 (wargv[i], wcslen (wargv[i]) + 1, NULL, &strl);
1332     if (NULL == split_u8argv[i])
1333     {
1334       int j;
1335       for (j = 0; j < i; j++)
1336         free (split_u8argv[j]);
1337       GNUNET_free (split_u8argv);
1338       LocalFree (wargv);
1339       return GNUNET_SYSERR;
1340     }
1341   }
1342
1343   *u8argv = _make_continuous_arg_copy (wargc, split_u8argv);
1344   *u8argc = wargc;
1345
1346   for (i = 0; i < wargc; i++)
1347     free (split_u8argv[i]);
1348   free (split_u8argv);
1349   return GNUNET_OK;
1350 #else
1351   char *const *new_argv = (char *const *) _make_continuous_arg_copy (argc, argv);
1352   *u8argv = new_argv;
1353   *u8argc = argc;
1354   return GNUNET_OK;
1355 #endif
1356 }
1357
1358
1359 /**
1360  * Parse the given port policy.  The format is
1361  * "[!]SPORT[-DPORT]".
1362  *
1363  * @param port_policy string to parse
1364  * @param pp policy to fill in
1365  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
1366  *         @a port_policy is malformed
1367  */
1368 static int
1369 parse_port_policy (const char *port_policy,
1370                    struct GNUNET_STRINGS_PortPolicy *pp)
1371 {
1372   const char *pos;
1373   int s;
1374   int e;
1375   char eol[2];
1376
1377   pos = port_policy;
1378   if ('!' == *pos)
1379   {
1380     pp->negate_portrange = GNUNET_YES;
1381     pos++;
1382   }
1383   if (2 == sscanf (pos,
1384                    "%u-%u%1s",
1385                    &s, &e, eol))
1386   {
1387     if ( (0 == s) ||
1388          (s > 0xFFFF) ||
1389          (e < s) ||
1390          (e > 0xFFFF) )
1391     {
1392       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1393                   _("Port not in range\n"));
1394       return GNUNET_SYSERR;
1395     }
1396     pp->start_port = (uint16_t) s;
1397     pp->end_port = (uint16_t) e;
1398     return GNUNET_OK;
1399   }
1400   if (1 == sscanf (pos,
1401                    "%u%1s",
1402                    &s,
1403                    eol))
1404   {
1405     if ( (0 == s) ||
1406          (s > 0xFFFF) )
1407     {
1408       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1409                   _("Port not in range\n"));
1410       return GNUNET_SYSERR;
1411     }
1412
1413     pp->start_port = (uint16_t) s;
1414     pp->end_port = (uint16_t) s;
1415     return GNUNET_OK;
1416   }
1417   GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1418               _("Malformed port policy `%s'\n"),
1419               port_policy);
1420   return GNUNET_SYSERR;
1421 }
1422
1423
1424 /**
1425  * Parse an IPv4 network policy. The argument specifies a list of
1426  * subnets. The format is
1427  * <tt>(network[/netmask][:SPORT[-DPORT]];)*</tt> (no whitespace, must
1428  * be terminated with a semicolon). The network must be given in
1429  * dotted-decimal notation. The netmask can be given in CIDR notation
1430  * (/16) or in dotted-decimal (/255.255.0.0).
1431  *
1432  * @param routeListX a string specifying the IPv4 subnets
1433  * @return the converted list, terminated with all zeros;
1434  *         NULL if the synatx is flawed
1435  */
1436 struct GNUNET_STRINGS_IPv4NetworkPolicy *
1437 GNUNET_STRINGS_parse_ipv4_policy (const char *routeListX)
1438 {
1439   unsigned int count;
1440   unsigned int i;
1441   unsigned int j;
1442   unsigned int len;
1443   int cnt;
1444   unsigned int pos;
1445   unsigned int temps[8];
1446   int slash;
1447   struct GNUNET_STRINGS_IPv4NetworkPolicy *result;
1448   int colon;
1449   int end;
1450   char *routeList;
1451
1452   if (NULL == routeListX)
1453     return NULL;
1454   len = strlen (routeListX);
1455   if (0 == len)
1456     return NULL;
1457   routeList = GNUNET_strdup (routeListX);
1458   count = 0;
1459   for (i = 0; i < len; i++)
1460     if (routeList[i] == ';')
1461       count++;
1462   result = GNUNET_malloc (sizeof (struct GNUNET_STRINGS_IPv4NetworkPolicy) * (count + 1));
1463   i = 0;
1464   pos = 0;
1465   while (i < count)
1466   {
1467     for (colon = pos; ':' != routeList[colon]; colon++)
1468       if ( (';' == routeList[colon]) ||
1469            ('\0' == routeList[colon]) )
1470         break;
1471     for (end = colon; ';' != routeList[end]; end++)
1472       if ('\0' == routeList[end])
1473         break;
1474     if ('\0' == routeList[end])
1475       break;
1476     routeList[end] = '\0';
1477     if (':' == routeList[colon])
1478     {
1479       routeList[colon] = '\0';
1480       if (GNUNET_OK != parse_port_policy (&routeList[colon + 1],
1481                                           &result[i].pp))
1482         break;
1483     }
1484     cnt =
1485         SSCANF (&routeList[pos],
1486                 "%u.%u.%u.%u/%u.%u.%u.%u",
1487                 &temps[0],
1488                 &temps[1],
1489                 &temps[2],
1490                 &temps[3],
1491                 &temps[4],
1492                 &temps[5],
1493                 &temps[6],
1494                 &temps[7]);
1495     if (8 == cnt)
1496     {
1497       for (j = 0; j < 8; j++)
1498         if (temps[j] > 0xFF)
1499         {
1500           LOG (GNUNET_ERROR_TYPE_WARNING,
1501                _("Invalid format for IP: `%s'\n"),
1502                &routeList[pos]);
1503           GNUNET_free (result);
1504           GNUNET_free (routeList);
1505           return NULL;
1506         }
1507       result[i].network.s_addr =
1508           htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
1509                  temps[3]);
1510       result[i].netmask.s_addr =
1511           htonl ((temps[4] << 24) + (temps[5] << 16) + (temps[6] << 8) +
1512                  temps[7]);
1513       pos = end + 1;
1514       i++;
1515       continue;
1516     }
1517     /* try second notation */
1518     cnt =
1519         SSCANF (&routeList[pos],
1520                 "%u.%u.%u.%u/%u",
1521                 &temps[0],
1522                 &temps[1],
1523                 &temps[2],
1524                 &temps[3],
1525                 &slash);
1526     if (5 == cnt)
1527     {
1528       for (j = 0; j < 4; j++)
1529         if (temps[j] > 0xFF)
1530         {
1531           LOG (GNUNET_ERROR_TYPE_WARNING,
1532                _("Invalid format for IP: `%s'\n"),
1533                &routeList[pos]);
1534           GNUNET_free (result);
1535           GNUNET_free (routeList);
1536           return NULL;
1537         }
1538       result[i].network.s_addr =
1539           htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
1540                  temps[3]);
1541       if ((slash <= 32) && (slash >= 0))
1542       {
1543         result[i].netmask.s_addr = 0;
1544         while (slash > 0)
1545         {
1546           result[i].netmask.s_addr =
1547               (result[i].netmask.s_addr >> 1) + 0x80000000;
1548           slash--;
1549         }
1550         result[i].netmask.s_addr = htonl (result[i].netmask.s_addr);
1551         pos = end + 1;
1552         i++;
1553         continue;
1554       }
1555       else
1556       {
1557         LOG (GNUNET_ERROR_TYPE_WARNING,
1558              _("Invalid network notation ('/%d' is not legal in IPv4 CIDR)."),
1559              slash);
1560         GNUNET_free (result);
1561           GNUNET_free (routeList);
1562         return NULL;            /* error */
1563       }
1564     }
1565     /* try third notation */
1566     slash = 32;
1567     cnt =
1568         SSCANF (&routeList[pos],
1569                 "%u.%u.%u.%u",
1570                 &temps[0],
1571                 &temps[1],
1572                 &temps[2],
1573                 &temps[3]);
1574     if (4 == cnt)
1575     {
1576       for (j = 0; j < 4; j++)
1577         if (temps[j] > 0xFF)
1578         {
1579           LOG (GNUNET_ERROR_TYPE_WARNING,
1580                _("Invalid format for IP: `%s'\n"),
1581                &routeList[pos]);
1582           GNUNET_free (result);
1583           GNUNET_free (routeList);
1584           return NULL;
1585         }
1586       result[i].network.s_addr =
1587           htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
1588                  temps[3]);
1589       result[i].netmask.s_addr = 0;
1590       while (slash > 0)
1591       {
1592         result[i].netmask.s_addr = (result[i].netmask.s_addr >> 1) + 0x80000000;
1593         slash--;
1594       }
1595       result[i].netmask.s_addr = htonl (result[i].netmask.s_addr);
1596       pos = end + 1;
1597       i++;
1598       continue;
1599     }
1600     LOG (GNUNET_ERROR_TYPE_WARNING,
1601          _("Invalid format for IP: `%s'\n"),
1602          &routeList[pos]);
1603     GNUNET_free (result);
1604     GNUNET_free (routeList);
1605     return NULL;                /* error */
1606   }
1607   if (pos < strlen (routeList))
1608   {
1609     LOG (GNUNET_ERROR_TYPE_WARNING,
1610          _("Invalid format: `%s'\n"),
1611          &routeListX[pos]);
1612     GNUNET_free (result);
1613     GNUNET_free (routeList);
1614     return NULL;                /* oops */
1615   }
1616   GNUNET_free (routeList);
1617   return result;                /* ok */
1618 }
1619
1620
1621 /**
1622  * Parse an IPv6 network policy. The argument specifies a list of
1623  * subnets. The format is <tt>(network[/netmask[:SPORT[-DPORT]]];)*</tt>
1624  * (no whitespace, must be terminated with a semicolon). The network
1625  * must be given in colon-hex notation.  The netmask must be given in
1626  * CIDR notation (/16) or can be omitted to specify a single host.
1627  * Note that the netmask is mandatory if ports are specified.
1628  *
1629  * @param routeListX a string specifying the policy
1630  * @return the converted list, 0-terminated, NULL if the synatx is flawed
1631  */
1632 struct GNUNET_STRINGS_IPv6NetworkPolicy *
1633 GNUNET_STRINGS_parse_ipv6_policy (const char *routeListX)
1634 {
1635   unsigned int count;
1636   unsigned int i;
1637   unsigned int len;
1638   unsigned int pos;
1639   int start;
1640   int slash;
1641   int ret;
1642   char *routeList;
1643   struct GNUNET_STRINGS_IPv6NetworkPolicy *result;
1644   unsigned int bits;
1645   unsigned int off;
1646   int save;
1647   int colon;
1648
1649   if (NULL == routeListX)
1650     return NULL;
1651   len = strlen (routeListX);
1652   if (0 == len)
1653     return NULL;
1654   routeList = GNUNET_strdup (routeListX);
1655   count = 0;
1656   for (i = 0; i < len; i++)
1657     if (';' == routeList[i])
1658       count++;
1659   if (';' != routeList[len - 1])
1660   {
1661     LOG (GNUNET_ERROR_TYPE_WARNING,
1662          _("Invalid network notation (does not end with ';': `%s')\n"),
1663          routeList);
1664     GNUNET_free (routeList);
1665     return NULL;
1666   }
1667
1668   result = GNUNET_malloc (sizeof (struct GNUNET_STRINGS_IPv6NetworkPolicy) * (count + 1));
1669   i = 0;
1670   pos = 0;
1671   while (i < count)
1672   {
1673     start = pos;
1674     while (';' != routeList[pos])
1675       pos++;
1676     slash = pos;
1677     while ((slash >= start) && (routeList[slash] != '/'))
1678       slash--;
1679
1680     if (slash < start)
1681     {
1682       memset (&result[i].netmask,
1683               0xFF,
1684               sizeof (struct in6_addr));
1685       slash = pos;
1686     }
1687     else
1688     {
1689       routeList[pos] = '\0';
1690       for (colon = pos; ':' != routeList[colon]; colon--)
1691         if ('/' == routeList[colon])
1692           break;
1693       if (':' == routeList[colon])
1694       {
1695         routeList[colon] = '\0';
1696         if (GNUNET_OK != parse_port_policy (&routeList[colon + 1],
1697                                             &result[i].pp))
1698         {
1699           GNUNET_free (result);
1700           GNUNET_free (routeList);
1701           return NULL;
1702         }
1703       }
1704       ret = inet_pton (AF_INET6, &routeList[slash + 1], &result[i].netmask);
1705       if (ret <= 0)
1706       {
1707         save = errno;
1708         if ((1 != SSCANF (&routeList[slash + 1], "%u", &bits)) || (bits > 128))
1709         {
1710           if (0 == ret)
1711             LOG (GNUNET_ERROR_TYPE_WARNING,
1712                  _("Wrong format `%s' for netmask\n"),
1713                  &routeList[slash + 1]);
1714           else
1715           {
1716             errno = save;
1717             LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "inet_pton");
1718           }
1719           GNUNET_free (result);
1720           GNUNET_free (routeList);
1721           return NULL;
1722         }
1723         off = 0;
1724         while (bits > 8)
1725         {
1726           result[i].netmask.s6_addr[off++] = 0xFF;
1727           bits -= 8;
1728         }
1729         while (bits > 0)
1730         {
1731           result[i].netmask.s6_addr[off] =
1732               (result[i].netmask.s6_addr[off] >> 1) + 0x80;
1733           bits--;
1734         }
1735       }
1736     }
1737     routeList[slash] = '\0';
1738     ret = inet_pton (AF_INET6, &routeList[start], &result[i].network);
1739     if (ret <= 0)
1740     {
1741       if (0 == ret)
1742         LOG (GNUNET_ERROR_TYPE_WARNING,
1743              _("Wrong format `%s' for network\n"),
1744              &routeList[slash + 1]);
1745       else
1746         LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1747                       "inet_pton");
1748       GNUNET_free (result);
1749       GNUNET_free (routeList);
1750       return NULL;
1751     }
1752     pos++;
1753     i++;
1754   }
1755   GNUNET_free (routeList);
1756   return result;
1757 }
1758
1759
1760
1761 /** ******************** Base64 encoding ***********/
1762
1763 #define FILLCHAR '='
1764 static char *cvt =
1765     "ABCDEFGHIJKLMNOPQRSTUVWXYZ" "abcdefghijklmnopqrstuvwxyz" "0123456789+/";
1766
1767
1768 /**
1769  * Encode into Base64.
1770  *
1771  * @param data the data to encode
1772  * @param len the length of the input
1773  * @param output where to write the output (*output should be NULL,
1774  *   is allocated)
1775  * @return the size of the output
1776  */
1777 size_t
1778 GNUNET_STRINGS_base64_encode (const char *data,
1779                               size_t len,
1780                               char **output)
1781 {
1782   size_t i;
1783   char c;
1784   size_t ret;
1785   char *opt;
1786
1787   ret = 0;
1788   opt = GNUNET_malloc (2 + (len * 4 / 3) + 8);
1789   *output = opt;
1790   for (i = 0; i < len; ++i)
1791   {
1792     c = (data[i] >> 2) & 0x3f;
1793     opt[ret++] = cvt[(int) c];
1794     c = (data[i] << 4) & 0x3f;
1795     if (++i < len)
1796       c |= (data[i] >> 4) & 0x0f;
1797     opt[ret++] = cvt[(int) c];
1798     if (i < len)
1799     {
1800       c = (data[i] << 2) & 0x3f;
1801       if (++i < len)
1802         c |= (data[i] >> 6) & 0x03;
1803       opt[ret++] = cvt[(int) c];
1804     }
1805     else
1806     {
1807       ++i;
1808       opt[ret++] = FILLCHAR;
1809     }
1810     if (i < len)
1811     {
1812       c = data[i] & 0x3f;
1813       opt[ret++] = cvt[(int) c];
1814     }
1815     else
1816     {
1817       opt[ret++] = FILLCHAR;
1818     }
1819   }
1820   opt[ret++] = FILLCHAR;
1821   return ret;
1822 }
1823
1824 #define cvtfind(a)( (((a) >= 'A')&&((a) <= 'Z'))? (a)-'A'\
1825                    :(((a)>='a')&&((a)<='z')) ? (a)-'a'+26\
1826                    :(((a)>='0')&&((a)<='9')) ? (a)-'0'+52\
1827            :((a) == '+') ? 62\
1828            :((a) == '/') ? 63 : -1)
1829
1830
1831 /**
1832  * Decode from Base64.
1833  *
1834  * @param data the data to encode
1835  * @param len the length of the input
1836  * @param output where to write the output (*output should be NULL,
1837  *   is allocated)
1838  * @return the size of the output
1839  */
1840 size_t
1841 GNUNET_STRINGS_base64_decode (const char *data,
1842                               size_t len, char **output)
1843 {
1844   size_t i;
1845   char c;
1846   char c1;
1847   size_t ret = 0;
1848
1849 #define CHECK_CRLF  while (data[i] == '\r' || data[i] == '\n') {\
1850                         GNUNET_log(GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK, "ignoring CR/LF\n"); \
1851                         i++; \
1852                         if (i >= len) goto END;  \
1853                 }
1854
1855   *output = GNUNET_malloc ((len * 3 / 4) + 8);
1856   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1857               "base64_decode decoding len=%d\n",
1858               (int) len);
1859   for (i = 0; i < len; ++i)
1860   {
1861     CHECK_CRLF;
1862     if (FILLCHAR == data[i])
1863       break;
1864     c = (char) cvtfind (data[i]);
1865     ++i;
1866     CHECK_CRLF;
1867     c1 = (char) cvtfind (data[i]);
1868     c = (c << 2) | ((c1 >> 4) & 0x3);
1869     (*output)[ret++] = c;
1870     if (++i < len)
1871     {
1872       CHECK_CRLF;
1873       c = data[i];
1874       if (FILLCHAR == c)
1875         break;
1876       c = (char) cvtfind (c);
1877       c1 = ((c1 << 4) & 0xf0) | ((c >> 2) & 0xf);
1878       (*output)[ret++] = c1;
1879     }
1880     if (++i < len)
1881     {
1882       CHECK_CRLF;
1883       c1 = data[i];
1884       if (FILLCHAR == c1)
1885         break;
1886
1887       c1 = (char) cvtfind (c1);
1888       c = ((c << 6) & 0xc0) | c1;
1889       (*output)[ret++] = c;
1890     }
1891   }
1892 END:
1893   return ret;
1894 }
1895
1896
1897
1898
1899
1900 /* end of strings.c */