2 This file is part of GNUnet.
3 (C) 2005-2013 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file util/strings.c
23 * @brief string functions
25 * @author Christian Grothoff
32 #include "gnunet_util_lib.h"
37 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
39 #define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util", syscall)
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").
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
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)
64 GNUNET_STRINGS_buffer_fill (char *buffer, size_t size, unsigned int count, ...)
75 s = va_arg (ap, const char *);
77 slen = strlen (s) + 1;
80 GNUNET_assert (needed + slen <= size);
81 memcpy (&buffer[needed], s, slen);
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
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.
105 GNUNET_STRINGS_buffer_tokenize (const char *buffer, size_t size,
106 unsigned int count, ...)
114 va_start (ap, count);
117 r = va_arg (ap, const char **);
120 while ((needed < size) && (buffer[needed] != '\0'))
125 return 0; /* error */
128 needed++; /* skip 0-termination */
137 * Convert a given filesize into a fancy human-readable format.
139 * @param size number of bytes
140 * @return fancy representation of the size (possibly rounded) for humans
143 GNUNET_STRINGS_byte_size_fancy (unsigned long long size)
145 const char *unit = _( /* size unit */ "b");
168 ret = GNUNET_malloc (32);
169 GNUNET_snprintf (ret, 32, "%llu %s", size, unit);
175 * Unit conversion table entry for 'convert_with_table'.
177 struct ConversionTable
180 * Name of the unit (or NULL for end of table).
185 * Factor to apply for this unit.
187 unsigned long long value;
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.
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
203 convert_with_table (const char *input,
204 const struct ConversionTable *table,
205 unsigned long long *output)
207 unsigned long long ret;
210 unsigned long long last;
215 in = GNUNET_strdup (input);
216 for (tok = strtok (in, " "); tok != NULL; tok = strtok (NULL, " "))
221 while ((table[i].name != NULL) && (0 != strcasecmp (table[i].name, tok)))
223 if (table[i].name != NULL)
225 last *= table[i].value;
226 break; /* next tok */
233 last = strtoull (tok, &endptr, 10);
234 if ((0 != errno) || (endptr == tok))
237 return GNUNET_SYSERR; /* expected number */
239 if ('\0' == endptr[0])
240 break; /* next tok */
242 tok = endptr; /* and re-check (handles times like "10s") */
244 } while (GNUNET_YES);
254 * Convert a given fancy human-readable size to bytes.
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
261 GNUNET_STRINGS_fancy_size_to_bytes (const char *fancy_size,
262 unsigned long long *size)
264 static const struct ConversionTable table[] =
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},
282 return convert_with_table (fancy_size,
289 * Convert a given fancy human-readable time to our internal
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
297 GNUNET_STRINGS_fancy_time_to_relative (const char *fancy_time,
298 struct GNUNET_TIME_Relative *rtime)
300 static const struct ConversionTable table[] =
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 */ },
320 unsigned long long val;
322 if (0 == strcasecmp ("forever", fancy_time))
324 *rtime = GNUNET_TIME_UNIT_FOREVER_REL;
327 ret = convert_with_table (fancy_time,
330 rtime->rel_value_us = (uint64_t) val;
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.
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
345 GNUNET_STRINGS_fancy_time_to_absolute (const char *fancy_time,
346 struct GNUNET_TIME_Absolute *atime)
351 if (0 == strcasecmp ("end of time", fancy_time))
353 *atime = GNUNET_TIME_UNIT_FOREVER_ABS;
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;
369 atime->abs_value_us = (uint64_t) ((uint64_t) t * 1000LL * 1000LL);
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.
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.
388 GNUNET_STRINGS_conv (const char *input,
390 const char *input_charset,
391 const char *output_charset)
395 char *encoded_string;
396 size_t u8_string_length;
397 size_t encoded_string_length;
399 u8_string = u8_conv_from_encoding (input_charset,
404 if (NULL == u8_string)
406 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "u8_conv_from_encoding");
409 if (0 == strcmp (output_charset, "UTF-8"))
411 ret = GNUNET_malloc (u8_string_length + 1);
412 memcpy (ret, u8_string, u8_string_length);
413 ret[u8_string_length] = '\0';
417 encoded_string = u8_conv_to_encoding (output_charset, iconveh_error,
418 u8_string, u8_string_length,
420 &encoded_string_length);
422 if (NULL == encoded_string)
424 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "u8_conv_to_encoding");
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);
433 LOG (GNUNET_ERROR_TYPE_WARNING, _("Character sets requested were `%s'->`%s'\n"),
434 "UTF-8", output_charset);
435 ret = GNUNET_malloc (len + 1);
436 memcpy (ret, input, len);
443 * Convert the len characters long character sequence
444 * given in input that is in the given charset
447 * @param input the input string (not necessarily 0-terminated)
448 * @param len the number of bytes in the @a input
449 * @param charset character set to convert from
450 * @return the converted string (0-terminated),
451 * if conversion fails, a copy of the orignal
452 * string is returned.
455 GNUNET_STRINGS_to_utf8 (const char *input,
459 return GNUNET_STRINGS_conv (input, len, charset, "UTF-8");
464 * Convert the len bytes-long UTF-8 string
465 * given in input to the given charset.
467 * @param input the input string (not necessarily 0-terminated)
468 * @param len the number of bytes in the @a input
469 * @param charset character set to convert to
470 * @return the converted string (0-terminated),
471 * if conversion fails, a copy of the orignal
472 * string is returned.
475 GNUNET_STRINGS_from_utf8 (const char *input,
479 return GNUNET_STRINGS_conv (input, len, "UTF-8", charset);
484 * Convert the utf-8 input string to lowercase.
485 * Output needs to be allocated appropriately.
487 * @param input input string
488 * @param output output buffer
491 GNUNET_STRINGS_utf8_tolower (const char *input,
497 tmp_in = u8_tolower ((uint8_t*)input, strlen ((char *) input),
498 NULL, UNINORM_NFD, NULL, &len);
499 memcpy(output, tmp_in, len);
506 * Convert the utf-8 input string to uppercase.
507 * Output needs to be allocated appropriately.
509 * @param input input string
510 * @param output output buffer
513 GNUNET_STRINGS_utf8_toupper(const char *input,
519 tmp_in = u8_toupper ((uint8_t*)input, strlen ((char *) input),
520 NULL, UNINORM_NFD, NULL, &len);
521 memcpy (output, tmp_in, len);
528 * Complete filename (a la shell) from abbrevition.
529 * @param fil the name of the file, may contain ~/ or
530 * be relative to the current directory
531 * @returns the full file name,
532 * NULL is returned on error
535 GNUNET_STRINGS_filename_expand (const char *fil)
552 if (fil[0] == DIR_SEPARATOR)
553 /* absolute path, just copy */
554 return GNUNET_strdup (fil);
557 fm = getenv ("HOME");
560 LOG (GNUNET_ERROR_TYPE_WARNING,
561 _("Failed to expand `$HOME': environment variable `HOME' not set"));
564 fm = GNUNET_strdup (fm);
565 /* do not copy '~' */
568 /* skip over dir seperator to be consistent */
569 if (fil_ptr[0] == DIR_SEPARATOR)
580 buffer = GNUNET_malloc (len);
581 if (getcwd (buffer, len) != NULL)
586 if ((errno == ERANGE) && (len < 1024 * 1024 * 4))
589 GNUNET_free (buffer);
592 GNUNET_free (buffer);
597 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "getcwd");
598 buffer = getenv ("PWD"); /* alternative */
600 fm = GNUNET_strdup (buffer);
603 fm = GNUNET_strdup ("./"); /* give up */
605 n = strlen (fm) + 1 + strlen (fil_ptr) + 1;
606 buffer = GNUNET_malloc (n);
607 GNUNET_snprintf (buffer, n, "%s%s%s", fm,
608 (fm[strlen (fm) - 1] ==
609 DIR_SEPARATOR) ? "" : DIR_SEPARATOR_STR, fil_ptr);
613 fn = GNUNET_malloc (MAX_PATH + 1);
615 if ((lRet = plibc_conv_to_win_path (fil, fn)) != ERROR_SUCCESS)
617 SetErrnoFromWinError (lRet);
618 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "plibc_conv_to_win_path");
621 /* is the path relative? */
622 if ((strncmp (fn + 1, ":\\", 2) != 0) && (strncmp (fn, "\\\\", 2) != 0))
624 char szCurDir[MAX_PATH + 1];
626 lRet = GetCurrentDirectory (MAX_PATH + 1, szCurDir);
627 if (lRet + strlen (fn) + 1 > (MAX_PATH + 1))
629 SetErrnoFromWinError (ERROR_BUFFER_OVERFLOW);
630 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "GetCurrentDirectory");
633 buffer = GNUNET_malloc (MAX_PATH + 1);
634 GNUNET_snprintf (buffer, MAX_PATH + 1, "%s\\%s", szCurDir, fn);
645 * Give relative time in human-readable fancy format.
646 * This is one of the very few calls in the entire API that is
649 * @param delta time in milli seconds
650 * @param do_round are we allowed to round a bit?
651 * @return time as human-readable string
654 GNUNET_STRINGS_relative_time_to_string (struct GNUNET_TIME_Relative delta,
657 static char buf[128];
658 const char *unit = _( /* time unit */ "µs");
659 uint64_t dval = delta.rel_value_us;
661 if (GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us == delta.rel_value_us)
663 if (0 == delta.rel_value_us)
665 if ( ( (GNUNET_YES == do_round) &&
666 (dval > 5 * 1000) ) ||
667 (0 == (dval % 1000) ))
670 unit = _( /* time unit */ "ms");
671 if ( ( (GNUNET_YES == do_round) &&
672 (dval > 5 * 1000) ) ||
673 (0 == (dval % 1000) ))
676 unit = _( /* time unit */ "s");
677 if ( ( (GNUNET_YES == do_round) &&
679 (0 == (dval % 60) ) )
682 unit = _( /* time unit */ "m");
683 if ( ( (GNUNET_YES == do_round) &&
688 unit = _( /* time unit */ "h");
689 if ( ( (GNUNET_YES == do_round) &&
695 unit = _( /* time unit */ "day");
697 unit = _( /* time unit */ "days");
703 GNUNET_snprintf (buf, sizeof (buf),
704 "%llu %s", dval, unit);
710 * "asctime", except for GNUnet time. Converts a GNUnet internal
711 * absolute time (which is in UTC) to a string in local time.
712 * Note that the returned value will be overwritten if this function
715 * @param t the absolute time to convert
716 * @return timestamp in human-readable form in local time
719 GNUNET_STRINGS_absolute_time_to_string (struct GNUNET_TIME_Absolute t)
721 static char buf[255];
725 if (t.abs_value_us == GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us)
726 return _("end of time");
727 tt = t.abs_value_us / 1000LL / 1000LL;
728 tp = localtime (&tt);
729 /* This is hacky, but i don't know a way to detect libc character encoding.
730 * Just expect utf8 from glibc these days.
731 * As for msvcrt, use the wide variant, which always returns utf16
732 * (otherwise we'd have to detect current codepage or use W32API character
733 * set conversion routines to convert to UTF8).
736 strftime (buf, sizeof (buf), "%a %b %d %H:%M:%S %Y", tp);
739 static wchar_t wbuf[255];
743 wcsftime (wbuf, sizeof (wbuf) / sizeof (wchar_t),
744 L"%a %b %d %H:%M:%S %Y", tp);
746 ssize = sizeof (buf);
747 conved = u16_to_u8 (wbuf, sizeof (wbuf) / sizeof (wchar_t),
748 (uint8_t *) buf, &ssize);
749 if (conved != (uint8_t *) buf)
751 strncpy (buf, (char *) conved, sizeof (buf));
763 * Returns a pointer to a part of filename (allocates nothing)!
765 * @param filename filename to extract basename from
766 * @return short (base) name of the file (that is, everything following the
767 * last directory separator in filename. If filename ends with a
768 * directory separator, the result will be a zero-length string.
769 * If filename has no directory separators, the result is filename
773 GNUNET_STRINGS_get_short_name (const char *filename)
775 const char *short_fn = filename;
777 while (NULL != (ss = strstr (short_fn, DIR_SEPARATOR_STR))
785 * Get the numeric value corresponding to a character.
787 * @param a a character
788 * @return corresponding numeric value
791 getValue__ (unsigned char a)
793 if ((a >= '0') && (a <= '9'))
795 if ((a >= 'A') && (a <= 'V'))
796 return (a - 'A' + 10);
797 if ((a >= 'a') && (a <= 'v'))
798 return (a - 'a' + 10);
804 * Convert binary data to ASCII encoding. The ASCII encoding is rather
805 * GNUnet specific. It was chosen such that it only uses characters
806 * in [0-9A-V], can be produced without complex arithmetics and uses a
807 * small number of characters.
808 * Does not append 0-terminator, but returns a pointer to the place where
809 * it should be placed, if needed.
811 * @param data data to encode
812 * @param size size of data (in bytes)
813 * @param out buffer to fill
814 * @param out_size size of the buffer. Must be large enough to hold
815 * ((size*8) + (((size*8) % 5) > 0 ? 5 - ((size*8) % 5) : 0)) / 5 bytes
816 * @return pointer to the next byte in 'out' or NULL on error.
819 GNUNET_STRINGS_data_to_string (const void *data, size_t size, char *out, size_t out_size)
822 * 32 characters for encoding
824 static char *encTable__ = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
829 const unsigned char *udata;
831 GNUNET_assert (data != NULL);
832 GNUNET_assert (out != NULL);
834 if (out_size < (((size*8) + ((size*8) % 5)) % 5))
843 while ((rpos < size) || (vbit > 0))
845 if ((rpos < size) && (vbit < 5))
847 bits = (bits << 8) | udata[rpos++]; /* eat 8 more bits */
852 bits <<= (5 - vbit); /* zero-padding */
853 GNUNET_assert (vbit == ((size * 8) % 5));
856 if (wpos >= out_size)
861 out[wpos++] = encTable__[(bits >> (vbit - 5)) & 31];
864 GNUNET_assert (vbit == 0);
872 * Convert ASCII encoding back to data
873 * out_size must match exactly the size of the data before it was encoded.
875 * @param enc the encoding
876 * @param enclen number of characters in @a enc (without 0-terminator, which can be missing)
877 * @param out location where to store the decoded data
878 * @param out_size size of the output buffer @a out
879 * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
882 GNUNET_STRINGS_string_to_data (const char *enc, size_t enclen,
883 void *out, size_t out_size)
892 unsigned int encoded_len = out_size * 8;
898 return GNUNET_SYSERR;
903 if ((encoded_len % 5) > 0)
905 vbit = encoded_len % 5; /* padding! */
907 bits = (ret = getValue__ (enc[--rpos])) >> (5 - (encoded_len % 5));
913 bits = (ret = getValue__ (enc[--rpos]));
915 if ((encoded_len + shift) / 5 != enclen)
916 return GNUNET_SYSERR;
918 return GNUNET_SYSERR;
924 return GNUNET_SYSERR;
926 bits = ((ret = getValue__ (enc[--rpos])) << vbit) | bits;
928 return GNUNET_SYSERR;
932 uout[--wpos] = (unsigned char) bits;
939 return GNUNET_SYSERR;
945 * Parse a path that might be an URI.
947 * @param path path to parse. Must be NULL-terminated.
948 * @param scheme_part a pointer to 'char *' where a pointer to a string that
949 * represents the URI scheme will be stored. Can be NULL. The string is
950 * allocated by the function, and should be freed by GNUNET_free() when
951 * it is no longer needed.
952 * @param path_part a pointer to 'const char *' where a pointer to the path
953 * part of the URI will be stored. Can be NULL. Points to the same block
954 * of memory as 'path', and thus must not be freed. Might point to '\0',
955 * if path part is zero-length.
956 * @return GNUNET_YES if it's an URI, GNUNET_NO otherwise. If 'path' is not
957 * an URI, '* scheme_part' and '*path_part' will remain unchanged
958 * (if they weren't NULL).
961 GNUNET_STRINGS_parse_uri (const char *path, char **scheme_part,
962 const char **path_part)
967 const char *post_scheme_part = NULL;
969 for (end = 0, i = 0; !end && i < len; i++)
974 if (path[i] == ':' && i > 0)
979 if (!((path[i] >= 'A' && path[i] <= 'Z') || (path[i] >= 'a' && path[i] <= 'z')
980 || (path[i] >= '0' && path[i] <= '9') || path[i] == '+' || path[i] == '-'
981 || (path[i] == '.')))
994 post_scheme_part = &path[i];
1001 if (post_scheme_part == NULL)
1005 *scheme_part = GNUNET_malloc (post_scheme_part - path + 1);
1006 memcpy (*scheme_part, path, post_scheme_part - path);
1007 (*scheme_part)[post_scheme_part - path] = '\0';
1010 *path_part = post_scheme_part;
1016 * Check whether @a filename is absolute or not, and if it's an URI
1018 * @param filename filename to check
1019 * @param can_be_uri #GNUNET_YES to check for being URI, #GNUNET_NO - to
1020 * assume it's not URI
1021 * @param r_is_uri a pointer to an int that is set to #GNUNET_YES if @a filename
1022 * is URI and to #GNUNET_NO otherwise. Can be NULL. If @a can_be_uri is
1023 * not #GNUNET_YES, `* r_is_uri` is set to #GNUNET_NO.
1024 * @param r_uri_scheme a pointer to a char * that is set to a pointer to URI scheme.
1025 * The string is allocated by the function, and should be freed with
1026 * GNUNET_free(). Can be NULL.
1027 * @return #GNUNET_YES if @a filename is absolute, #GNUNET_NO otherwise.
1030 GNUNET_STRINGS_path_is_absolute (const char *filename,
1033 char **r_uri_scheme)
1038 const char *post_scheme_path;
1041 /* consider POSIX paths to be absolute too, even on W32,
1042 * as plibc expansion will fix them for us.
1044 if (filename[0] == '/')
1048 is_uri = GNUNET_STRINGS_parse_uri (filename, &uri, &post_scheme_path);
1054 *r_uri_scheme = uri;
1056 GNUNET_free_non_null (uri);
1058 len = strlen(post_scheme_path);
1059 /* Special check for file:///c:/blah
1060 * We want to parse 'c:/', not '/c:/'
1062 if (post_scheme_path[0] == '/' && len >= 3 && post_scheme_path[2] == ':')
1063 post_scheme_path = &post_scheme_path[1];
1065 return GNUNET_STRINGS_path_is_absolute (post_scheme_path, GNUNET_NO, NULL, NULL);
1071 *r_is_uri = GNUNET_NO;
1074 len = strlen (filename);
1076 ((filename[0] >= 'A' && filename[0] <= 'Z')
1077 || (filename[0] >= 'a' && filename[0] <= 'z'))
1078 && filename[1] == ':' && (filename[2] == '/' || filename[2] == '\\'))
1085 #define _IFMT 0170000 /* type of file */
1086 #define _IFLNK 0120000 /* symbolic link */
1087 #define S_ISLNK(m) (((m)&_IFMT) == _IFLNK)
1092 * Perform @a checks on @a filename.
1094 * @param filename file to check
1095 * @param checks checks to perform
1096 * @return #GNUNET_YES if all checks pass, #GNUNET_NO if at least one of them
1097 * fails, #GNUNET_SYSERR when a check can't be performed
1100 GNUNET_STRINGS_check_filename (const char *filename,
1101 enum GNUNET_STRINGS_FilenameCheck checks)
1104 if ( (NULL == filename) || (filename[0] == '\0') )
1105 return GNUNET_SYSERR;
1106 if (0 != (checks & GNUNET_STRINGS_CHECK_IS_ABSOLUTE))
1107 if (!GNUNET_STRINGS_path_is_absolute (filename, GNUNET_NO, NULL, NULL))
1109 if (0 != (checks & (GNUNET_STRINGS_CHECK_EXISTS
1110 | GNUNET_STRINGS_CHECK_IS_DIRECTORY
1111 | GNUNET_STRINGS_CHECK_IS_LINK)))
1113 if (0 != STAT (filename, &st))
1115 if (0 != (checks & GNUNET_STRINGS_CHECK_EXISTS))
1118 return GNUNET_SYSERR;
1121 if (0 != (checks & GNUNET_STRINGS_CHECK_IS_DIRECTORY))
1122 if (!S_ISDIR (st.st_mode))
1124 if (0 != (checks & GNUNET_STRINGS_CHECK_IS_LINK))
1125 if (!S_ISLNK (st.st_mode))
1132 * Tries to convert 'zt_addr' string to an IPv6 address.
1133 * The string is expected to have the format "[ABCD::01]:80".
1135 * @param zt_addr 0-terminated string. May be mangled by the function.
1136 * @param addrlen length of @a zt_addr (not counting 0-terminator).
1137 * @param r_buf a buffer to fill. Initially gets filled with zeroes,
1138 * then its sin6_port, sin6_family and sin6_addr are set appropriately.
1139 * @return #GNUNET_OK if conversion succeded.
1140 * #GNUNET_SYSERR otherwise, in which
1141 * case the contents of @a r_buf are undefined.
1144 GNUNET_STRINGS_to_address_ipv6 (const char *zt_addr,
1146 struct sockaddr_in6 *r_buf)
1148 char zbuf[addrlen + 1];
1154 return GNUNET_SYSERR;
1155 memcpy (zbuf, zt_addr, addrlen);
1158 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1159 _("IPv6 address did not start with `['\n"));
1160 return GNUNET_SYSERR;
1162 zbuf[addrlen] = '\0';
1163 port_colon = strrchr (zbuf, ':');
1164 if (NULL == port_colon)
1166 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1167 _("IPv6 address did contain ':' to separate port number\n"));
1168 return GNUNET_SYSERR;
1170 if (']' != *(port_colon - 1))
1172 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1173 _("IPv6 address did contain ']' before ':' to separate port number\n"));
1174 return GNUNET_SYSERR;
1176 ret = SSCANF (port_colon, ":%u", &port);
1177 if ( (1 != ret) || (port > 65535) )
1179 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1180 _("IPv6 address did contain a valid port number after the last ':'\n"));
1181 return GNUNET_SYSERR;
1183 *(port_colon-1) = '\0';
1184 memset (r_buf, 0, sizeof (struct sockaddr_in6));
1185 ret = inet_pton (AF_INET6, &zbuf[1], &r_buf->sin6_addr);
1188 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1189 _("Invalid IPv6 address `%s': %s\n"),
1192 return GNUNET_SYSERR;
1194 r_buf->sin6_port = htons (port);
1195 r_buf->sin6_family = AF_INET6;
1196 #if HAVE_SOCKADDR_IN_SIN_LEN
1197 r_buf->sin6_len = (u_char) sizeof (struct sockaddr_in6);
1204 * Tries to convert 'zt_addr' string to an IPv4 address.
1205 * The string is expected to have the format "1.2.3.4:80".
1207 * @param zt_addr 0-terminated string. May be mangled by the function.
1208 * @param addrlen length of @a zt_addr (not counting 0-terminator).
1209 * @param r_buf a buffer to fill.
1210 * @return #GNUNET_OK if conversion succeded.
1211 * #GNUNET_SYSERR otherwise, in which case
1212 * the contents of @a r_buf are undefined.
1215 GNUNET_STRINGS_to_address_ipv4 (const char *zt_addr, uint16_t addrlen,
1216 struct sockaddr_in *r_buf)
1218 unsigned int temps[4];
1223 return GNUNET_SYSERR;
1224 cnt = SSCANF (zt_addr, "%u.%u.%u.%u:%u", &temps[0], &temps[1], &temps[2], &temps[3], &port);
1226 return GNUNET_SYSERR;
1227 for (cnt = 0; cnt < 4; cnt++)
1228 if (temps[cnt] > 0xFF)
1229 return GNUNET_SYSERR;
1231 return GNUNET_SYSERR;
1232 r_buf->sin_family = AF_INET;
1233 r_buf->sin_port = htons (port);
1234 r_buf->sin_addr.s_addr = htonl ((temps[0] << 24) + (temps[1] << 16) +
1235 (temps[2] << 8) + temps[3]);
1236 #if HAVE_SOCKADDR_IN_SIN_LEN
1237 r_buf->sin_len = (u_char) sizeof (struct sockaddr_in);
1244 * Tries to convert @a addr string to an IP (v4 or v6) address.
1245 * Will automatically decide whether to treat 'addr' as v4 or v6 address.
1247 * @param addr a string, may not be 0-terminated.
1248 * @param addrlen number of bytes in @a addr (if addr is 0-terminated,
1249 * 0-terminator should not be counted towards addrlen).
1250 * @param r_buf a buffer to fill.
1251 * @return #GNUNET_OK if conversion succeded. GNUNET_SYSERR otherwise, in which
1252 * case the contents of r_buf are undefined.
1255 GNUNET_STRINGS_to_address_ip (const char *addr,
1257 struct sockaddr_storage *r_buf)
1260 return GNUNET_STRINGS_to_address_ipv6 (addr,
1262 (struct sockaddr_in6 *) r_buf);
1263 return GNUNET_STRINGS_to_address_ipv4 (addr,
1265 (struct sockaddr_in *) r_buf);
1270 * Makes a copy of argv that consists of a single memory chunk that can be
1271 * freed with a single call to GNUNET_free();
1273 static char *const *
1274 _make_continuous_arg_copy (int argc,
1277 size_t argvsize = 0;
1281 for (i = 0; i < argc; i++)
1282 argvsize += strlen (argv[i]) + 1 + sizeof (char *);
1283 new_argv = GNUNET_malloc (argvsize + sizeof (char *));
1284 p = (char *) &new_argv[argc + 1];
1285 for (i = 0; i < argc; i++)
1288 strcpy (p, argv[i]);
1289 p += strlen (argv[i]) + 1;
1291 new_argv[argc] = NULL;
1292 return (char *const *) new_argv;
1297 * Returns utf-8 encoded arguments.
1298 * Does nothing (returns a copy of argc and argv) on any platform
1300 * Returned argv has u8argv[u8argc] == NULL.
1301 * Returned argv is a single memory block, and can be freed with a single
1302 * GNUNET_free() call.
1304 * @param argc argc (as given by main())
1305 * @param argv argv (as given by main())
1306 * @param u8argc a location to store new argc in (though it's th same as argc)
1307 * @param u8argv a location to store new argv in
1308 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
1311 GNUNET_STRINGS_get_utf8_args (int argc, char *const *argv, int *u8argc, char *const **u8argv)
1318 char **split_u8argv;
1320 wcmd = GetCommandLineW ();
1322 return GNUNET_SYSERR;
1323 wargv = CommandLineToArgvW (wcmd, &wargc);
1325 return GNUNET_SYSERR;
1327 split_u8argv = GNUNET_malloc (argc * sizeof (char *));
1329 for (i = 0; i < wargc; i++)
1332 /* Hopefully it will allocate us NUL-terminated strings... */
1333 split_u8argv[i] = (char *) u16_to_u8 (wargv[i], wcslen (wargv[i]) + 1, NULL, &strl);
1334 if (NULL == split_u8argv[i])
1337 for (j = 0; j < i; j++)
1338 free (split_u8argv[j]);
1339 GNUNET_free (split_u8argv);
1341 return GNUNET_SYSERR;
1345 *u8argv = _make_continuous_arg_copy (wargc, split_u8argv);
1348 for (i = 0; i < wargc; i++)
1349 free (split_u8argv[i]);
1350 free (split_u8argv);
1353 char *const *new_argv = (char *const *) _make_continuous_arg_copy (argc, argv);
1362 * Parse the given port policy. The format is
1363 * "[!]SPORT[-DPORT]".
1365 * @param port_policy string to parse
1366 * @param pp policy to fill in
1367 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
1368 * @a port_policy is malformed
1371 parse_port_policy (const char *port_policy,
1372 struct GNUNET_STRINGS_PortPolicy *pp)
1382 pp->negate_portrange = GNUNET_YES;
1385 if (2 == sscanf (pos,
1394 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1395 _("Port not in range\n"));
1396 return GNUNET_SYSERR;
1398 pp->start_port = (uint16_t) s;
1399 pp->end_port = (uint16_t) e;
1402 if (1 == sscanf (pos,
1410 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1411 _("Port not in range\n"));
1412 return GNUNET_SYSERR;
1415 pp->start_port = (uint16_t) s;
1416 pp->end_port = (uint16_t) s;
1419 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1420 _("Malformed port policy `%s'\n"),
1422 return GNUNET_SYSERR;
1427 * Parse an IPv4 network policy. The argument specifies a list of
1428 * subnets. The format is
1429 * <tt>(network[/netmask][:SPORT[-DPORT]];)*</tt> (no whitespace, must
1430 * be terminated with a semicolon). The network must be given in
1431 * dotted-decimal notation. The netmask can be given in CIDR notation
1432 * (/16) or in dotted-decimal (/255.255.0.0).
1434 * @param routeListX a string specifying the IPv4 subnets
1435 * @return the converted list, terminated with all zeros;
1436 * NULL if the synatx is flawed
1438 struct GNUNET_STRINGS_IPv4NetworkPolicy *
1439 GNUNET_STRINGS_parse_ipv4_policy (const char *routeListX)
1447 unsigned int temps[8];
1449 struct GNUNET_STRINGS_IPv4NetworkPolicy *result;
1454 if (NULL == routeListX)
1456 len = strlen (routeListX);
1459 routeList = GNUNET_strdup (routeListX);
1461 for (i = 0; i < len; i++)
1462 if (routeList[i] == ';')
1464 result = GNUNET_malloc (sizeof (struct GNUNET_STRINGS_IPv4NetworkPolicy) * (count + 1));
1469 for (colon = pos; ':' != routeList[colon]; colon++)
1470 if ( (';' == routeList[colon]) ||
1471 ('\0' == routeList[colon]) )
1473 for (end = colon; ';' != routeList[end]; end++)
1474 if ('\0' == routeList[end])
1476 if ('\0' == routeList[end])
1478 routeList[end] = '\0';
1479 if (':' == routeList[colon])
1481 routeList[colon] = '\0';
1482 if (GNUNET_OK != parse_port_policy (&routeList[colon + 1],
1487 SSCANF (&routeList[pos],
1488 "%u.%u.%u.%u/%u.%u.%u.%u",
1499 for (j = 0; j < 8; j++)
1500 if (temps[j] > 0xFF)
1502 LOG (GNUNET_ERROR_TYPE_WARNING,
1503 _("Invalid format for IP: `%s'\n"),
1505 GNUNET_free (result);
1506 GNUNET_free (routeList);
1509 result[i].network.s_addr =
1510 htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
1512 result[i].netmask.s_addr =
1513 htonl ((temps[4] << 24) + (temps[5] << 16) + (temps[6] << 8) +
1519 /* try second notation */
1521 SSCANF (&routeList[pos],
1530 for (j = 0; j < 4; j++)
1531 if (temps[j] > 0xFF)
1533 LOG (GNUNET_ERROR_TYPE_WARNING,
1534 _("Invalid format for IP: `%s'\n"),
1536 GNUNET_free (result);
1537 GNUNET_free (routeList);
1540 result[i].network.s_addr =
1541 htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
1543 if ((slash <= 32) && (slash >= 0))
1545 result[i].netmask.s_addr = 0;
1548 result[i].netmask.s_addr =
1549 (result[i].netmask.s_addr >> 1) + 0x80000000;
1552 result[i].netmask.s_addr = htonl (result[i].netmask.s_addr);
1559 LOG (GNUNET_ERROR_TYPE_WARNING,
1560 _("Invalid network notation ('/%d' is not legal in IPv4 CIDR)."),
1562 GNUNET_free (result);
1563 GNUNET_free (routeList);
1564 return NULL; /* error */
1567 /* try third notation */
1570 SSCANF (&routeList[pos],
1578 for (j = 0; j < 4; j++)
1579 if (temps[j] > 0xFF)
1581 LOG (GNUNET_ERROR_TYPE_WARNING,
1582 _("Invalid format for IP: `%s'\n"),
1584 GNUNET_free (result);
1585 GNUNET_free (routeList);
1588 result[i].network.s_addr =
1589 htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
1591 result[i].netmask.s_addr = 0;
1594 result[i].netmask.s_addr = (result[i].netmask.s_addr >> 1) + 0x80000000;
1597 result[i].netmask.s_addr = htonl (result[i].netmask.s_addr);
1602 LOG (GNUNET_ERROR_TYPE_WARNING,
1603 _("Invalid format for IP: `%s'\n"),
1605 GNUNET_free (result);
1606 GNUNET_free (routeList);
1607 return NULL; /* error */
1609 if (pos < strlen (routeList))
1611 LOG (GNUNET_ERROR_TYPE_WARNING,
1612 _("Invalid format: `%s'\n"),
1614 GNUNET_free (result);
1615 GNUNET_free (routeList);
1616 return NULL; /* oops */
1618 GNUNET_free (routeList);
1619 return result; /* ok */
1624 * Parse an IPv6 network policy. The argument specifies a list of
1625 * subnets. The format is <tt>(network[/netmask[:SPORT[-DPORT]]];)*</tt>
1626 * (no whitespace, must be terminated with a semicolon). The network
1627 * must be given in colon-hex notation. The netmask must be given in
1628 * CIDR notation (/16) or can be omitted to specify a single host.
1629 * Note that the netmask is mandatory if ports are specified.
1631 * @param routeListX a string specifying the policy
1632 * @return the converted list, 0-terminated, NULL if the synatx is flawed
1634 struct GNUNET_STRINGS_IPv6NetworkPolicy *
1635 GNUNET_STRINGS_parse_ipv6_policy (const char *routeListX)
1645 struct GNUNET_STRINGS_IPv6NetworkPolicy *result;
1651 if (NULL == routeListX)
1653 len = strlen (routeListX);
1656 routeList = GNUNET_strdup (routeListX);
1658 for (i = 0; i < len; i++)
1659 if (';' == routeList[i])
1661 if (';' != routeList[len - 1])
1663 LOG (GNUNET_ERROR_TYPE_WARNING,
1664 _("Invalid network notation (does not end with ';': `%s')\n"),
1666 GNUNET_free (routeList);
1670 result = GNUNET_malloc (sizeof (struct GNUNET_STRINGS_IPv6NetworkPolicy) * (count + 1));
1676 while (';' != routeList[pos])
1679 while ((slash >= start) && (routeList[slash] != '/'))
1684 memset (&result[i].netmask,
1686 sizeof (struct in6_addr));
1691 routeList[pos] = '\0';
1692 for (colon = pos; ':' != routeList[colon]; colon--)
1693 if ('/' == routeList[colon])
1695 if (':' == routeList[colon])
1697 routeList[colon] = '\0';
1698 if (GNUNET_OK != parse_port_policy (&routeList[colon + 1],
1701 GNUNET_free (result);
1702 GNUNET_free (routeList);
1706 ret = inet_pton (AF_INET6, &routeList[slash + 1], &result[i].netmask);
1710 if ((1 != SSCANF (&routeList[slash + 1], "%u", &bits)) || (bits > 128))
1713 LOG (GNUNET_ERROR_TYPE_WARNING,
1714 _("Wrong format `%s' for netmask\n"),
1715 &routeList[slash + 1]);
1719 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "inet_pton");
1721 GNUNET_free (result);
1722 GNUNET_free (routeList);
1728 result[i].netmask.s6_addr[off++] = 0xFF;
1733 result[i].netmask.s6_addr[off] =
1734 (result[i].netmask.s6_addr[off] >> 1) + 0x80;
1739 routeList[slash] = '\0';
1740 ret = inet_pton (AF_INET6, &routeList[start], &result[i].network);
1744 LOG (GNUNET_ERROR_TYPE_WARNING,
1745 _("Wrong format `%s' for network\n"),
1746 &routeList[slash + 1]);
1748 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1750 GNUNET_free (result);
1751 GNUNET_free (routeList);
1757 GNUNET_free (routeList);
1763 /** ******************** Base64 encoding ***********/
1765 #define FILLCHAR '='
1767 "ABCDEFGHIJKLMNOPQRSTUVWXYZ" "abcdefghijklmnopqrstuvwxyz" "0123456789+/";
1771 * Encode into Base64.
1773 * @param data the data to encode
1774 * @param len the length of the input
1775 * @param output where to write the output (*output should be NULL,
1777 * @return the size of the output
1780 GNUNET_STRINGS_base64_encode (const char *data,
1790 opt = GNUNET_malloc (2 + (len * 4 / 3) + 8);
1792 for (i = 0; i < len; ++i)
1794 c = (data[i] >> 2) & 0x3f;
1795 opt[ret++] = cvt[(int) c];
1796 c = (data[i] << 4) & 0x3f;
1798 c |= (data[i] >> 4) & 0x0f;
1799 opt[ret++] = cvt[(int) c];
1802 c = (data[i] << 2) & 0x3f;
1804 c |= (data[i] >> 6) & 0x03;
1805 opt[ret++] = cvt[(int) c];
1810 opt[ret++] = FILLCHAR;
1815 opt[ret++] = cvt[(int) c];
1819 opt[ret++] = FILLCHAR;
1822 opt[ret++] = FILLCHAR;
1826 #define cvtfind(a)( (((a) >= 'A')&&((a) <= 'Z'))? (a)-'A'\
1827 :(((a)>='a')&&((a)<='z')) ? (a)-'a'+26\
1828 :(((a)>='0')&&((a)<='9')) ? (a)-'0'+52\
1830 :((a) == '/') ? 63 : -1)
1834 * Decode from Base64.
1836 * @param data the data to encode
1837 * @param len the length of the input
1838 * @param output where to write the output (*output should be NULL,
1840 * @return the size of the output
1843 GNUNET_STRINGS_base64_decode (const char *data,
1844 size_t len, char **output)
1851 #define CHECK_CRLF while (data[i] == '\r' || data[i] == '\n') {\
1852 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK, "ignoring CR/LF\n"); \
1854 if (i >= len) goto END; \
1857 *output = GNUNET_malloc ((len * 3 / 4) + 8);
1858 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1859 "base64_decode decoding len=%d\n",
1861 for (i = 0; i < len; ++i)
1864 if (FILLCHAR == data[i])
1866 c = (char) cvtfind (data[i]);
1869 c1 = (char) cvtfind (data[i]);
1870 c = (c << 2) | ((c1 >> 4) & 0x3);
1871 (*output)[ret++] = c;
1878 c = (char) cvtfind (c);
1879 c1 = ((c1 << 4) & 0xf0) | ((c >> 2) & 0xf);
1880 (*output)[ret++] = c1;
1889 c1 = (char) cvtfind (c1);
1890 c = ((c << 6) & 0xc0) | c1;
1891 (*output)[ret++] = c;
1902 /* end of strings.c */