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     { "a", 31536000000000LL /* year */ },
 315     { NULL, 0}
 316   };
 317   int ret;
 318   unsigned long long val;
 319
 320   if (0 == strcasecmp ("forever", fancy_time))
 321   {
 322     *rtime = GNUNET_TIME_UNIT_FOREVER_REL;
 323     return GNUNET_OK;
 324   }
 325   ret = convert_with_table (fancy_time,
 326                             table,
 327                             &val);
 328   rtime->rel_value_us = (uint64_t) val;
 329   return ret;
 330 }
 331
 332
 333 /**
 334  * Convert a given fancy human-readable time to our internal
 335  * representation. The human-readable time is expected to be
 336  * in local time, whereas the returned value will be in UTC.
 337  *
 338  * @param fancy_time human readable string (i.e. %Y-%m-%d %H:%M:%S)
 339  * @param atime set to the absolute time
 340  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 341  */
 342 int
 343 GNUNET_STRINGS_fancy_time_to_absolute (const char *fancy_time,
 344                                        struct GNUNET_TIME_Absolute *atime)
 345 {
 346   struct tm tv;
 347   time_t t;
 348
 349   if (0 == strcasecmp ("end of time", fancy_time))
 350   {
 351     *atime = GNUNET_TIME_UNIT_FOREVER_ABS;
 352     return GNUNET_OK;
 353   }
 354   memset (&tv, 0, sizeof (tv));
 355   if ( (NULL == strptime (fancy_time, "%a %b %d %H:%M:%S %Y", &tv)) &&
 356        (NULL == strptime (fancy_time, "%c", &tv)) &&
 357        (NULL == strptime (fancy_time, "%Ec", &tv)) &&
 358        (NULL == strptime (fancy_time, "%Y-%m-%d %H:%M:%S", &tv)) &&
 359        (NULL == strptime (fancy_time, "%Y-%m-%d %H:%M", &tv)) &&
 360        (NULL == strptime (fancy_time, "%x", &tv)) &&
 361        (NULL == strptime (fancy_time, "%Ex", &tv)) &&
 362        (NULL == strptime (fancy_time, "%Y-%m-%d", &tv)) &&
 363        (NULL == strptime (fancy_time, "%Y-%m", &tv)) &&
 364        (NULL == strptime (fancy_time, "%Y", &tv)) )
 365     return GNUNET_SYSERR;
 366   t = mktime (&tv);
 367   atime->abs_value_us = (uint64_t) ((uint64_t) t * 1000LL * 1000LL);
 368 #if LINUX
 369   atime->abs_value_us -= 1000LL * 1000LL * timezone;
 370 #elif defined WINDOWS
 371   {
 372     DWORD tzv;
 373     TIME_ZONE_INFORMATION tzi;
 374     tzv = GetTimeZoneInformation (&tzi);
 375     if (TIME_ZONE_ID_INVALID != tzv)
 376     {
 377       atime->abs_value_us -= 1000LL * 1000LL * tzi.Bias * 60LL;
 378     }
 379   }
 380 #endif
 381   return GNUNET_OK;
 382 }
 383
 384
 385 /**
 386  * Convert the len characters long character sequence
 387  * given in input that is in the given input charset
 388  * to a string in given output charset.
 389  *
 390  * @param input input string
 391  * @param len number of bytes in @a input
 392  * @param input_charset character set used for @a input
 393  * @param output_charset desired character set for the return value
 394  * @return the converted string (0-terminated),
 395  *  if conversion fails, a copy of the orignal
 396  *  string is returned.
 397  */
 398 char *
 399 GNUNET_STRINGS_conv (const char *input,
 400                      size_t len,
 401                      const char *input_charset,
 402                      const char *output_charset)
 403 {
 404   char *ret;
 405   uint8_t *u8_string;
 406   char *encoded_string;
 407   size_t u8_string_length;
 408   size_t encoded_string_length;
 409
 410   u8_string = u8_conv_from_encoding (input_charset,
 411                                      iconveh_error,
 412                                      input, len,
 413                                      NULL, NULL,
 414                                      &u8_string_length);
 415   if (NULL == u8_string)
 416   {
 417     LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "u8_conv_from_encoding");
 418     goto fail;
 419   }
 420   if (0 == strcmp (output_charset, "UTF-8"))
 421   {
 422     ret = GNUNET_malloc (u8_string_length + 1);
 423     memcpy (ret, u8_string, u8_string_length);
 424     ret[u8_string_length] = '\0';
 425     free (u8_string);
 426     return ret;
 427   }
 428   encoded_string = u8_conv_to_encoding (output_charset, iconveh_error,
 429                                         u8_string, u8_string_length,
 430                                         NULL, NULL,
 431                                         &encoded_string_length);
 432   free (u8_string);
 433   if (NULL == encoded_string)
 434   {
 435     LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "u8_conv_to_encoding");
 436     goto fail;
 437   }
 438   ret = GNUNET_malloc (encoded_string_length + 1);
 439   memcpy (ret, encoded_string, encoded_string_length);
 440   ret[encoded_string_length] = '\0';
 441   free (encoded_string);
 442   return ret;
 443  fail:
 444   LOG (GNUNET_ERROR_TYPE_WARNING, _("Character sets requested were `%s'->`%s'\n"),
 445        "UTF-8", output_charset);
 446   ret = GNUNET_malloc (len + 1);
 447   memcpy (ret, input, len);
 448   ret[len] = '\0';
 449   return ret;
 450 }
 451
 452
 453 /**
 454  * Convert the len characters long character sequence
 455  * given in input that is in the given charset
 456  * to UTF-8.
 457  *
 458  * @param input the input string (not necessarily 0-terminated)
 459  * @param len the number of bytes in the @a input
 460  * @param charset character set to convert from
 461  * @return the converted string (0-terminated),
 462  *  if conversion fails, a copy of the orignal
 463  *  string is returned.
 464  */
 465 char *
 466 GNUNET_STRINGS_to_utf8 (const char *input,
 467                         size_t len,
 468                         const char *charset)
 469 {
 470   return GNUNET_STRINGS_conv (input, len, charset, "UTF-8");
 471 }
 472
 473
 474 /**
 475  * Convert the len bytes-long UTF-8 string
 476  * given in input to the given charset.
 477  *
 478  * @param input the input string (not necessarily 0-terminated)
 479  * @param len the number of bytes in the @a input
 480  * @param charset character set to convert to
 481  * @return the converted string (0-terminated),
 482  *  if conversion fails, a copy of the orignal
 483  *  string is returned.
 484  */
 485 char *
 486 GNUNET_STRINGS_from_utf8 (const char *input,
 487                           size_t len,
 488                           const char *charset)
 489 {
 490   return GNUNET_STRINGS_conv (input, len, "UTF-8", charset);
 491 }
 492
 493
 494 /**
 495  * Convert the utf-8 input string to lowercase
 496  * Output needs to be allocated appropriately
 497  *
 498  * @param input input string
 499  * @param output output buffer
 500  */
 501 void
 502 GNUNET_STRINGS_utf8_tolower(const char* input, char** output)
 503 {
 504   uint8_t *tmp_in;
 505   size_t len;
 506
 507   tmp_in = u8_tolower ((uint8_t*)input, strlen ((char *) input),
 508                        NULL, UNINORM_NFD, NULL, &len);
 509   memcpy(*output, tmp_in, len);
 510   (*output)[len] = '\0';
 511   free(tmp_in);
 512 }
 513
 514
 515 /**
 516  * Convert the utf-8 input string to uppercase
 517  * Output needs to be allocated appropriately
 518  *
 519  * @param input input string
 520  * @param output output buffer
 521  */
 522 void
 523 GNUNET_STRINGS_utf8_toupper(const char* input, char** output)
 524 {
 525   uint8_t *tmp_in;
 526   size_t len;
 527
 528   tmp_in = u8_toupper ((uint8_t*)input, strlen ((char *) input),
 529                        NULL, UNINORM_NFD, NULL, &len);
 530   memcpy(*output, tmp_in, len);
 531   (*output)[len] = '\0';
 532   free(tmp_in);
 533 }
 534
 535
 536 /**
 537  * Complete filename (a la shell) from abbrevition.
 538  * @param fil the name of the file, may contain ~/ or
 539  *        be relative to the current directory
 540  * @returns the full file name,
 541  *          NULL is returned on error
 542  */
 543 char *
 544 GNUNET_STRINGS_filename_expand (const char *fil)
 545 {
 546   char *buffer;
 547 #ifndef MINGW
 548   size_t len;
 549   size_t n;
 550   char *fm;
 551   const char *fil_ptr;
 552 #else
 553   char *fn;
 554   long lRet;
 555 #endif
 556
 557   if (fil == NULL)
 558     return NULL;
 559
 560 #ifndef MINGW
 561   if (fil[0] == DIR_SEPARATOR)
 562     /* absolute path, just copy */
 563     return GNUNET_strdup (fil);
 564   if (fil[0] == '~')
 565   {
 566     fm = getenv ("HOME");
 567     if (fm == NULL)
 568     {
 569       LOG (GNUNET_ERROR_TYPE_WARNING,
 570            _("Failed to expand `$HOME': environment variable `HOME' not set"));
 571       return NULL;
 572     }
 573     fm = GNUNET_strdup (fm);
 574     /* do not copy '~' */
 575     fil_ptr = fil + 1;
 576
 577     /* skip over dir seperator to be consistent */
 578     if (fil_ptr[0] == DIR_SEPARATOR)
 579       fil_ptr++;
 580   }
 581   else
 582   {
 583     /* relative path */
 584     fil_ptr = fil;
 585     len = 512;
 586     fm = NULL;
 587     while (1)
 588     {
 589       buffer = GNUNET_malloc (len);
 590       if (getcwd (buffer, len) != NULL)
 591       {
 592         fm = buffer;
 593         break;
 594       }
 595       if ((errno == ERANGE) && (len < 1024 * 1024 * 4))
 596       {
 597         len *= 2;
 598         GNUNET_free (buffer);
 599         continue;
 600       }
 601       GNUNET_free (buffer);
 602       break;
 603     }
 604     if (fm == NULL)
 605     {
 606       LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "getcwd");
 607       buffer = getenv ("PWD");  /* alternative */
 608       if (buffer != NULL)
 609         fm = GNUNET_strdup (buffer);
 610     }
 611     if (fm == NULL)
 612       fm = GNUNET_strdup ("./");        /* give up */
 613   }
 614   n = strlen (fm) + 1 + strlen (fil_ptr) + 1;
 615   buffer = GNUNET_malloc (n);
 616   GNUNET_snprintf (buffer, n, "%s%s%s", fm,
 617                    (fm[strlen (fm) - 1] ==
 618                     DIR_SEPARATOR) ? "" : DIR_SEPARATOR_STR, fil_ptr);
 619   GNUNET_free (fm);
 620   return buffer;
 621 #else
 622   fn = GNUNET_malloc (MAX_PATH + 1);
 623
 624   if ((lRet = plibc_conv_to_win_path (fil, fn)) != ERROR_SUCCESS)
 625   {
 626     SetErrnoFromWinError (lRet);
 627     LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "plibc_conv_to_win_path");
 628     return NULL;
 629   }
 630   /* is the path relative? */
 631   if ((strncmp (fn + 1, ":\\", 2) != 0) && (strncmp (fn, "\\\\", 2) != 0))
 632   {
 633     char szCurDir[MAX_PATH + 1];
 634
 635     lRet = GetCurrentDirectory (MAX_PATH + 1, szCurDir);
 636     if (lRet + strlen (fn) + 1 > (MAX_PATH + 1))
 637     {
 638       SetErrnoFromWinError (ERROR_BUFFER_OVERFLOW);
 639       LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "GetCurrentDirectory");
 640       return NULL;
 641     }
 642     buffer = GNUNET_malloc (MAX_PATH + 1);
 643     GNUNET_snprintf (buffer, MAX_PATH + 1, "%s\\%s", szCurDir, fn);
 644     GNUNET_free (fn);
 645     fn = buffer;
 646   }
 647
 648   return fn;
 649 #endif
 650 }
 651
 652
 653 /**
 654  * Give relative time in human-readable fancy format.
 655  * This is one of the very few calls in the entire API that is
 656  * NOT reentrant!
 657  *
 658  * @param delta time in milli seconds
 659  * @param do_round are we allowed to round a bit?
 660  * @return time as human-readable string
 661  */
 662 const char *
 663 GNUNET_STRINGS_relative_time_to_string (struct GNUNET_TIME_Relative delta,
 664                                         int do_round)
 665 {
 666   static char buf[128];
 667   const char *unit = _( /* time unit */ "µs");
 668   uint64_t dval = delta.rel_value_us;
 669
 670   if (GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us == delta.rel_value_us)
 671     return _("forever");
 672   if (0 == delta.rel_value_us)
 673     return _("0 ms");
 674   if ( ( (GNUNET_YES == do_round) &&
 675          (dval > 5 * 1000) ) ||
 676        (0 == (dval % 1000) ))
 677   {
 678     dval = dval / 1000;
 679     unit = _( /* time unit */ "ms");
 680     if ( ( (GNUNET_YES == do_round) &&
 681            (dval > 5 * 1000) ) ||
 682          (0 == (dval % 1000) ))
 683     {
 684       dval = dval / 1000;
 685       unit = _( /* time unit */ "s");
 686       if ( ( (GNUNET_YES == do_round) &&
 687              (dval > 5 * 60) ) ||
 688            (0 == (dval % 60) ) )
 689       {
 690         dval = dval / 60;
 691         unit = _( /* time unit */ "m");
 692         if ( ( (GNUNET_YES == do_round) &&
 693                (dval > 5 * 60) ) ||
 694              (0 == (dval % 60) ))
 695         {
 696           dval = dval / 60;
 697           unit = _( /* time unit */ "h");
 698           if ( ( (GNUNET_YES == do_round) &&
 699                  (dval > 5 * 24) ) ||
 700                (0 == (dval % 24)) )
 701           {
 702             dval = dval / 24;
 703             if (1 == dval)
 704               unit = _( /* time unit */ "day");
 705             else
 706               unit = _( /* time unit */ "days");
 707           }
 708         }
 709       }
 710     }
 711   }
 712   GNUNET_snprintf (buf, sizeof (buf),
 713                    "%llu %s", dval, unit);
 714   return buf;
 715 }
 716
 717
 718 /**
 719  * "asctime", except for GNUnet time.  Converts a GNUnet internal
 720  * absolute time (which is in UTC) to a string in local time.
 721  * Note that the returned value will be overwritten if this function
 722  * is called again.
 723  *
 724  * @param t the absolute time to convert
 725  * @return timestamp in human-readable form in local time
 726  */
 727 const char *
 728 GNUNET_STRINGS_absolute_time_to_string (struct GNUNET_TIME_Absolute t)
 729 {
 730   static char buf[255];
 731   time_t tt;
 732   struct tm *tp;
 733
 734   if (t.abs_value_us == GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us)
 735     return _("end of time");
 736   tt = t.abs_value_us / 1000LL / 1000LL;
 737   tp = gmtime (&tt);
 738   strftime (buf, sizeof (buf), "%a %b %d %H:%M:%S %Y", tp);
 739   return buf;
 740 }
 741
 742
 743 /**
 744  * "man basename"
 745  * Returns a pointer to a part of filename (allocates nothing)!
 746  *
 747  * @param filename filename to extract basename from
 748  * @return short (base) name of the file (that is, everything following the
 749  *         last directory separator in filename. If filename ends with a
 750  *         directory separator, the result will be a zero-length string.
 751  *         If filename has no directory separators, the result is filename
 752  *         itself.
 753  */
 754 const char *
 755 GNUNET_STRINGS_get_short_name (const char *filename)
 756 {
 757   const char *short_fn = filename;
 758   const char *ss;
 759   while (NULL != (ss = strstr (short_fn, DIR_SEPARATOR_STR))
 760       && (ss[1] != '\0'))
 761     short_fn = 1 + ss;
 762   return short_fn;
 763 }
 764
 765
 766 /**
 767  * Get the numeric value corresponding to a character.
 768  *
 769  * @param a a character
 770  * @return corresponding numeric value
 771  */
 772 static unsigned int
 773 getValue__ (unsigned char a)
 774 {
 775   if ((a >= '0') && (a <= '9'))
 776     return a - '0';
 777   if ((a >= 'A') && (a <= 'V'))
 778     return (a - 'A' + 10);
 779   return -1;
 780 }
 781
 782
 783 /**
 784  * Convert binary data to ASCII encoding.  The ASCII encoding is rather
 785  * GNUnet specific.  It was chosen such that it only uses characters
 786  * in [0-9A-V], can be produced without complex arithmetics and uses a
 787  * small number of characters.
 788  * Does not append 0-terminator, but returns a pointer to the place where
 789  * it should be placed, if needed.
 790  *
 791  * @param data data to encode
 792  * @param size size of data (in bytes)
 793  * @param out buffer to fill
 794  * @param out_size size of the buffer. Must be large enough to hold
 795  * ((size*8) + (((size*8) % 5) > 0 ? 5 - ((size*8) % 5) : 0)) / 5 bytes
 796  * @return pointer to the next byte in 'out' or NULL on error.
 797  */
 798 char *
 799 GNUNET_STRINGS_data_to_string (const void *data, size_t size, char *out, size_t out_size)
 800 {
 801   /**
 802    * 32 characters for encoding
 803    */
 804   static char *encTable__ = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
 805   unsigned int wpos;
 806   unsigned int rpos;
 807   unsigned int bits;
 808   unsigned int vbit;
 809   const unsigned char *udata;
 810
 811   GNUNET_assert (data != NULL);
 812   GNUNET_assert (out != NULL);
 813   udata = data;
 814   if (out_size < (((size*8) + ((size*8) % 5)) % 5))
 815   {
 816     GNUNET_break (0);
 817     return NULL;
 818   }
 819   vbit = 0;
 820   wpos = 0;
 821   rpos = 0;
 822   bits = 0;
 823   while ((rpos < size) || (vbit > 0))
 824   {
 825     if ((rpos < size) && (vbit < 5))
 826     {
 827       bits = (bits << 8) | udata[rpos++];   /* eat 8 more bits */
 828       vbit += 8;
 829     }
 830     if (vbit < 5)
 831     {
 832       bits <<= (5 - vbit);      /* zero-padding */
 833       GNUNET_assert (vbit == ((size * 8) % 5));
 834       vbit = 5;
 835     }
 836     if (wpos >= out_size)
 837     {
 838       GNUNET_break (0);
 839       return NULL;
 840     }
 841     out[wpos++] = encTable__[(bits >> (vbit - 5)) & 31];
 842     vbit -= 5;
 843   }
 844   GNUNET_assert (vbit == 0);
 845   if (wpos < out_size)
 846     out[wpos] = '\0';
 847   return &out[wpos];
 848 }
 849
 850
 851 /**
 852  * Convert ASCII encoding back to data
 853  * out_size must match exactly the size of the data before it was encoded.
 854  *
 855  * @param enc the encoding
 856  * @param enclen number of characters in 'enc' (without 0-terminator, which can be missing)
 857  * @param out location where to store the decoded data
 858  * @param out_size size of the output buffer
 859  * @return GNUNET_OK on success, GNUNET_SYSERR if result has the wrong encoding
 860  */
 861 int
 862 GNUNET_STRINGS_string_to_data (const char *enc, size_t enclen,
 863                                void *out, size_t out_size)
 864 {
 865   unsigned int rpos;
 866   unsigned int wpos;
 867   unsigned int bits;
 868   unsigned int vbit;
 869   int ret;
 870   int shift;
 871   unsigned char *uout;
 872   unsigned int encoded_len = out_size * 8;
 873
 874   if (0 == enclen)
 875   {
 876     if (0 == out_size)
 877       return GNUNET_OK;
 878     return GNUNET_SYSERR;
 879   }
 880   uout = out;
 881   wpos = out_size;
 882   rpos = enclen;
 883   if ((encoded_len % 5) > 0)
 884   {
 885     vbit = encoded_len % 5; /* padding! */
 886     shift = 5 - vbit;
 887     bits = (ret = getValue__ (enc[--rpos])) >> (5 - (encoded_len % 5));
 888   }
 889   else
 890   {
 891     vbit = 5;
 892     shift = 0;
 893     bits = (ret = getValue__ (enc[--rpos]));
 894   }
 895   if ((encoded_len + shift) / 5 != enclen)
 896     return GNUNET_SYSERR;
 897   if (-1 == ret)
 898     return GNUNET_SYSERR;
 899   while (wpos > 0)
 900   {
 901     if (0 == rpos)
 902     {
 903       GNUNET_break (0);
 904       return GNUNET_SYSERR;
 905     }
 906     bits = ((ret = getValue__ (enc[--rpos])) << vbit) | bits;
 907     if (-1 == ret)
 908       return GNUNET_SYSERR;
 909     vbit += 5;
 910     if (vbit >= 8)
 911     {
 912       uout[--wpos] = (unsigned char) bits;
 913       bits >>= 8;
 914       vbit -= 8;
 915     }
 916   }
 917   if ( (0 != rpos) ||
 918        (0 != vbit) )
 919     return GNUNET_SYSERR;
 920   return GNUNET_OK;
 921 }
 922
 923
 924 /**
 925  * Parse a path that might be an URI.
 926  *
 927  * @param path path to parse. Must be NULL-terminated.
 928  * @param scheme_part a pointer to 'char *' where a pointer to a string that
 929  *        represents the URI scheme will be stored. Can be NULL. The string is
 930  *        allocated by the function, and should be freed by GNUNET_free() when
 931  *        it is no longer needed.
 932  * @param path_part a pointer to 'const char *' where a pointer to the path
 933  *        part of the URI will be stored. Can be NULL. Points to the same block
 934  *        of memory as 'path', and thus must not be freed. Might point to '\0',
 935  *        if path part is zero-length.
 936  * @return GNUNET_YES if it's an URI, GNUNET_NO otherwise. If 'path' is not
 937  *         an URI, '* scheme_part' and '*path_part' will remain unchanged
 938  *         (if they weren't NULL).
 939  */
 940 int
 941 GNUNET_STRINGS_parse_uri (const char *path, char **scheme_part,
 942     const char **path_part)
 943 {
 944   size_t len;
 945   int i, end;
 946   int pp_state = 0;
 947   const char *post_scheme_part = NULL;
 948   len = strlen (path);
 949   for (end = 0, i = 0; !end && i < len; i++)
 950   {
 951     switch (pp_state)
 952     {
 953     case 0:
 954       if (path[i] == ':' && i > 0)
 955       {
 956         pp_state += 1;
 957         continue;
 958       }
 959       if (!((path[i] >= 'A' && path[i] <= 'Z') || (path[i] >= 'a' && path[i] <= 'z')
 960           || (path[i] >= '0' && path[i] <= '9') || path[i] == '+' || path[i] == '-'
 961           || (path[i] == '.')))
 962         end = 1;
 963       break;
 964     case 1:
 965     case 2:
 966       if (path[i] == '/')
 967       {
 968         pp_state += 1;
 969         continue;
 970       }
 971       end = 1;
 972       break;
 973     case 3:
 974       post_scheme_part = &path[i];
 975       end = 1;
 976       break;
 977     default:
 978       end = 1;
 979     }
 980   }
 981   if (post_scheme_part == NULL)
 982     return GNUNET_NO;
 983   if (scheme_part)
 984   {
 985     *scheme_part = GNUNET_malloc (post_scheme_part - path + 1);
 986     memcpy (*scheme_part, path, post_scheme_part - path);
 987     (*scheme_part)[post_scheme_part - path] = '\0';
 988   }
 989   if (path_part)
 990     *path_part = post_scheme_part;
 991   return GNUNET_YES;
 992 }
 993
 994
 995 /**
 996  * Check whether 'filename' is absolute or not, and if it's an URI
 997  *
 998  * @param filename filename to check
 999  * @param can_be_uri GNUNET_YES to check for being URI, GNUNET_NO - to
1000  *        assume it's not URI
1001  * @param r_is_uri a pointer to an int that is set to GNUNET_YES if 'filename'
1002  *        is URI and to GNUNET_NO otherwise. Can be NULL. If 'can_be_uri' is
1003  *        not GNUNET_YES, *r_is_uri is set to GNUNET_NO.
1004  * @param r_uri_scheme a pointer to a char * that is set to a pointer to URI scheme.
1005  *        The string is allocated by the function, and should be freed with
1006  *        GNUNET_free (). Can be NULL.
1007  * @return GNUNET_YES if 'filename' is absolute, GNUNET_NO otherwise.
1008  */
1009 int
1010 GNUNET_STRINGS_path_is_absolute (const char *filename, int can_be_uri,
1011     int *r_is_uri, char **r_uri_scheme)
1012 {
1013 #if WINDOWS
1014   size_t len;
1015 #endif
1016   const char *post_scheme_path;
1017   int is_uri;
1018   char * uri;
1019   /* consider POSIX paths to be absolute too, even on W32,
1020    * as plibc expansion will fix them for us.
1021    */
1022   if (filename[0] == '/')
1023     return GNUNET_YES;
1024   if (can_be_uri)
1025   {
1026     is_uri = GNUNET_STRINGS_parse_uri (filename, &uri, &post_scheme_path);
1027     if (r_is_uri)
1028       *r_is_uri = is_uri;
1029     if (is_uri)
1030     {
1031       if (r_uri_scheme)
1032         *r_uri_scheme = uri;
1033       else
1034         GNUNET_free_non_null (uri);
1035 #if WINDOWS
1036       len = strlen(post_scheme_path);
1037       /* Special check for file:///c:/blah
1038        * We want to parse 'c:/', not '/c:/'
1039        */
1040       if (post_scheme_path[0] == '/' && len >= 3 && post_scheme_path[2] == ':')
1041         post_scheme_path = &post_scheme_path[1];
1042 #endif
1043       return GNUNET_STRINGS_path_is_absolute (post_scheme_path, GNUNET_NO, NULL, NULL);
1044     }
1045   }
1046   else
1047   {
1048     if (r_is_uri)
1049       *r_is_uri = GNUNET_NO;
1050   }
1051 #if WINDOWS
1052   len = strlen (filename);
1053   if (len >= 3 &&
1054       ((filename[0] >= 'A' && filename[0] <= 'Z')
1055       || (filename[0] >= 'a' && filename[0] <= 'z'))
1056       && filename[1] == ':' && (filename[2] == '/' || filename[2] == '\\'))
1057     return GNUNET_YES;
1058 #endif
1059   return GNUNET_NO;
1060 }
1061
1062 #if MINGW
1063 #define         _IFMT           0170000 /* type of file */
1064 #define         _IFLNK          0120000 /* symbolic link */
1065 #define  S_ISLNK(m)     (((m)&_IFMT) == _IFLNK)
1066 #endif
1067
1068
1069 /**
1070  * Perform 'checks' on 'filename'
1071  *
1072  * @param filename file to check
1073  * @param checks checks to perform
1074  * @return GNUNET_YES if all checks pass, GNUNET_NO if at least one of them
1075  *         fails, GNUNET_SYSERR when a check can't be performed
1076  */
1077 int
1078 GNUNET_STRINGS_check_filename (const char *filename,
1079                                enum GNUNET_STRINGS_FilenameCheck checks)
1080 {
1081   struct stat st;
1082   if ( (NULL == filename) || (filename[0] == '\0') )
1083     return GNUNET_SYSERR;
1084   if (0 != (checks & GNUNET_STRINGS_CHECK_IS_ABSOLUTE))
1085     if (!GNUNET_STRINGS_path_is_absolute (filename, GNUNET_NO, NULL, NULL))
1086       return GNUNET_NO;
1087   if (0 != (checks & (GNUNET_STRINGS_CHECK_EXISTS
1088                       | GNUNET_STRINGS_CHECK_IS_DIRECTORY
1089                       | GNUNET_STRINGS_CHECK_IS_LINK)))
1090   {
1091     if (0 != STAT (filename, &st))
1092     {
1093       if (0 != (checks & GNUNET_STRINGS_CHECK_EXISTS))
1094         return GNUNET_NO;
1095       else
1096         return GNUNET_SYSERR;
1097     }
1098   }
1099   if (0 != (checks & GNUNET_STRINGS_CHECK_IS_DIRECTORY))
1100     if (!S_ISDIR (st.st_mode))
1101       return GNUNET_NO;
1102   if (0 != (checks & GNUNET_STRINGS_CHECK_IS_LINK))
1103     if (!S_ISLNK (st.st_mode))
1104       return GNUNET_NO;
1105   return GNUNET_YES;
1106 }
1107
1108
1109 /**
1110  * Tries to convert 'zt_addr' string to an IPv6 address.
1111  * The string is expected to have the format "[ABCD::01]:80".
1112  *
1113  * @param zt_addr 0-terminated string. May be mangled by the function.
1114  * @param addrlen length of zt_addr (not counting 0-terminator).
1115  * @param r_buf a buffer to fill. Initially gets filled with zeroes,
1116  *        then its sin6_port, sin6_family and sin6_addr are set appropriately.
1117  * @return GNUNET_OK if conversion succeded. GNUNET_SYSERR otherwise, in which
1118  *         case the contents of r_buf are undefined.
1119  */
1120 int
1121 GNUNET_STRINGS_to_address_ipv6 (const char *zt_addr,
1122                                 uint16_t addrlen,
1123                                 struct sockaddr_in6 *r_buf)
1124 {
1125   char zbuf[addrlen + 1];
1126   int ret;
1127   char *port_colon;
1128   unsigned int port;
1129
1130   if (addrlen < 6)
1131     return GNUNET_SYSERR;
1132   memcpy (zbuf, zt_addr, addrlen);
1133   if ('[' != zbuf[0])
1134   {
1135     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1136                 _("IPv6 address did not start with `['\n"));
1137     return GNUNET_SYSERR;
1138   }
1139   zbuf[addrlen] = '\0';
1140   port_colon = strrchr (zbuf, ':');
1141   if (NULL == port_colon)
1142   {
1143     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1144                 _("IPv6 address did contain ':' to separate port number\n"));
1145     return GNUNET_SYSERR;
1146   }
1147   if (']' != *(port_colon - 1))
1148   {
1149     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1150                 _("IPv6 address did contain ']' before ':' to separate port number\n"));
1151     return GNUNET_SYSERR;
1152   }
1153   ret = SSCANF (port_colon, ":%u", &port);
1154   if ( (1 != ret) || (port > 65535) )
1155   {
1156     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1157                 _("IPv6 address did contain a valid port number after the last ':'\n"));
1158     return GNUNET_SYSERR;
1159   }
1160   *(port_colon-1) = '\0';
1161   memset (r_buf, 0, sizeof (struct sockaddr_in6));
1162   ret = inet_pton (AF_INET6, &zbuf[1], &r_buf->sin6_addr);
1163   if (ret <= 0)
1164   {
1165     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1166                 _("Invalid IPv6 address `%s': %s\n"),
1167                 &zbuf[1],
1168                 STRERROR (errno));
1169     return GNUNET_SYSERR;
1170   }
1171   r_buf->sin6_port = htons (port);
1172   r_buf->sin6_family = AF_INET6;
1173 #if HAVE_SOCKADDR_IN_SIN_LEN
1174   r_buf->sin6_len = (u_char) sizeof (struct sockaddr_in6);
1175 #endif
1176   return GNUNET_OK;
1177 }
1178
1179
1180 /**
1181  * Tries to convert 'zt_addr' string to an IPv4 address.
1182  * The string is expected to have the format "1.2.3.4:80".
1183  *
1184  * @param zt_addr 0-terminated string. May be mangled by the function.
1185  * @param addrlen length of zt_addr (not counting 0-terminator).
1186  * @param r_buf a buffer to fill.
1187  * @return GNUNET_OK if conversion succeded. GNUNET_SYSERR otherwise, in which case
1188  *         the contents of r_buf are undefined.
1189  */
1190 int
1191 GNUNET_STRINGS_to_address_ipv4 (const char *zt_addr, uint16_t addrlen,
1192                                 struct sockaddr_in *r_buf)
1193 {
1194   unsigned int temps[4];
1195   unsigned int port;
1196   unsigned int cnt;
1197
1198   if (addrlen < 9)
1199     return GNUNET_SYSERR;
1200   cnt = SSCANF (zt_addr, "%u.%u.%u.%u:%u", &temps[0], &temps[1], &temps[2], &temps[3], &port);
1201   if (5 != cnt)
1202     return GNUNET_SYSERR;
1203   for (cnt = 0; cnt < 4; cnt++)
1204     if (temps[cnt] > 0xFF)
1205       return GNUNET_SYSERR;
1206   if (port > 65535)
1207     return GNUNET_SYSERR;
1208   r_buf->sin_family = AF_INET;
1209   r_buf->sin_port = htons (port);
1210   r_buf->sin_addr.s_addr = htonl ((temps[0] << 24) + (temps[1] << 16) +
1211                                   (temps[2] << 8) + temps[3]);
1212 #if HAVE_SOCKADDR_IN_SIN_LEN
1213   r_buf->sin_len = (u_char) sizeof (struct sockaddr_in);
1214 #endif
1215   return GNUNET_OK;
1216 }
1217
1218
1219 /**
1220  * Tries to convert 'addr' string to an IP (v4 or v6) address.
1221  * Will automatically decide whether to treat 'addr' as v4 or v6 address.
1222  *
1223  * @param addr a string, may not be 0-terminated.
1224  * @param addrlen number of bytes in addr (if addr is 0-terminated,
1225  *        0-terminator should not be counted towards addrlen).
1226  * @param r_buf a buffer to fill.
1227  * @return GNUNET_OK if conversion succeded. GNUNET_SYSERR otherwise, in which
1228  *         case the contents of r_buf are undefined.
1229  */
1230 int
1231 GNUNET_STRINGS_to_address_ip (const char *addr,
1232                               uint16_t addrlen,
1233                               struct sockaddr_storage *r_buf)
1234 {
1235   if (addr[0] == '[')
1236     return GNUNET_STRINGS_to_address_ipv6 (addr, addrlen, (struct sockaddr_in6 *) r_buf);
1237   return GNUNET_STRINGS_to_address_ipv4 (addr, addrlen, (struct sockaddr_in *) r_buf);
1238 }
1239
1240
1241 /**
1242  * Makes a copy of argv that consists of a single memory chunk that can be
1243  * freed with a single call to GNUNET_free ();
1244  */
1245 static char *const *
1246 _make_continuous_arg_copy (int argc, char *const *argv)
1247 {
1248   size_t argvsize = 0;
1249   int i;
1250   char **new_argv;
1251   char *p;
1252   for (i = 0; i < argc; i++)
1253     argvsize += strlen (argv[i]) + 1 + sizeof (char *);
1254   new_argv = GNUNET_malloc (argvsize + sizeof (char *));
1255   p = (char *) &new_argv[argc + 1];
1256   for (i = 0; i < argc; i++)
1257   {
1258     new_argv[i] = p;
1259     strcpy (p, argv[i]);
1260     p += strlen (argv[i]) + 1;
1261   }
1262   new_argv[argc] = NULL;
1263   return (char *const *) new_argv;
1264 }
1265
1266
1267 /**
1268  * Returns utf-8 encoded arguments.
1269  * Does nothing (returns a copy of argc and argv) on any platform
1270  * other than W32.
1271  * Returned argv has u8argv[u8argc] == NULL.
1272  * Returned argv is a single memory block, and can be freed with a single
1273  *   GNUNET_free () call.
1274  *
1275  * @param argc argc (as given by main())
1276  * @param argv argv (as given by main())
1277  * @param u8argc a location to store new argc in (though it's th same as argc)
1278  * @param u8argv a location to store new argv in
1279  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
1280  */
1281 int
1282 GNUNET_STRINGS_get_utf8_args (int argc, char *const *argv, int *u8argc, char *const **u8argv)
1283 {
1284 #if WINDOWS
1285   wchar_t *wcmd;
1286   wchar_t **wargv;
1287   int wargc;
1288   int i;
1289   char **split_u8argv;
1290
1291   wcmd = GetCommandLineW ();
1292   if (NULL == wcmd)
1293     return GNUNET_SYSERR;
1294   wargv = CommandLineToArgvW (wcmd, &wargc);
1295   if (NULL == wargv)
1296     return GNUNET_SYSERR;
1297
1298   split_u8argv = GNUNET_malloc (argc * sizeof (char *));
1299
1300   for (i = 0; i < wargc; i++)
1301   {
1302     size_t strl;
1303     /* Hopefully it will allocate us NUL-terminated strings... */
1304     split_u8argv[i] = (char *) u16_to_u8 (wargv[i], wcslen (wargv[i]) + 1, NULL, &strl);
1305     if (NULL == split_u8argv[i])
1306     {
1307       int j;
1308       for (j = 0; j < i; j++)
1309         free (split_u8argv[j]);
1310       GNUNET_free (split_u8argv);
1311       LocalFree (wargv);
1312       return GNUNET_SYSERR;
1313     }
1314   }
1315
1316   *u8argv = _make_continuous_arg_copy (wargc, split_u8argv);
1317   *u8argc = wargc;
1318
1319   for (i = 0; i < wargc; i++)
1320     free (split_u8argv[i]);
1321   free (split_u8argv);
1322   return GNUNET_OK;
1323 #else
1324   char *const *new_argv = (char *const *) _make_continuous_arg_copy (argc, argv);
1325   *u8argv = new_argv;
1326   *u8argc = argc;
1327   return GNUNET_OK;
1328 #endif
1329 }
1330
1331 /* end of strings.c */