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 { "a", 31536000000000LL /* year */ },
318 unsigned long long val;
320 if (0 == strcasecmp ("forever", fancy_time))
322 *rtime = GNUNET_TIME_UNIT_FOREVER_REL;
325 ret = convert_with_table (fancy_time,
328 rtime->rel_value_us = (uint64_t) val;
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.
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
343 GNUNET_STRINGS_fancy_time_to_absolute (const char *fancy_time,
344 struct GNUNET_TIME_Absolute *atime)
349 if (0 == strcasecmp ("end of time", fancy_time))
351 *atime = GNUNET_TIME_UNIT_FOREVER_ABS;
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;
367 atime->abs_value_us = (uint64_t) ((uint64_t) t * 1000LL * 1000LL);
369 atime->abs_value_us -= 1000LL * 1000LL * timezone;
370 #elif defined WINDOWS
373 TIME_ZONE_INFORMATION tzi;
374 tzv = GetTimeZoneInformation (&tzi);
375 if (TIME_ZONE_ID_INVALID != tzv)
377 atime->abs_value_us -= 1000LL * 1000LL * tzi.Bias * 60LL;
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.
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.
399 GNUNET_STRINGS_conv (const char *input,
401 const char *input_charset,
402 const char *output_charset)
406 char *encoded_string;
407 size_t u8_string_length;
408 size_t encoded_string_length;
410 u8_string = u8_conv_from_encoding (input_charset,
415 if (NULL == u8_string)
417 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "u8_conv_from_encoding");
420 if (0 == strcmp (output_charset, "UTF-8"))
422 ret = GNUNET_malloc (u8_string_length + 1);
423 memcpy (ret, u8_string, u8_string_length);
424 ret[u8_string_length] = '\0';
428 encoded_string = u8_conv_to_encoding (output_charset, iconveh_error,
429 u8_string, u8_string_length,
431 &encoded_string_length);
433 if (NULL == encoded_string)
435 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "u8_conv_to_encoding");
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);
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);
454 * Convert the len characters long character sequence
455 * given in input that is in the given charset
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.
466 GNUNET_STRINGS_to_utf8 (const char *input,
470 return GNUNET_STRINGS_conv (input, len, charset, "UTF-8");
475 * Convert the len bytes-long UTF-8 string
476 * given in input to the given charset.
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.
486 GNUNET_STRINGS_from_utf8 (const char *input,
490 return GNUNET_STRINGS_conv (input, len, "UTF-8", charset);
495 * Convert the utf-8 input string to lowercase.
496 * Output needs to be allocated appropriately.
498 * @param input input string
499 * @param output output buffer
502 GNUNET_STRINGS_utf8_tolower (const char *input,
508 tmp_in = u8_tolower ((uint8_t*)input, strlen ((char *) input),
509 NULL, UNINORM_NFD, NULL, &len);
510 memcpy(output, tmp_in, len);
517 * Convert the utf-8 input string to uppercase.
518 * Output needs to be allocated appropriately.
520 * @param input input string
521 * @param output output buffer
524 GNUNET_STRINGS_utf8_toupper(const char *input,
530 tmp_in = u8_toupper ((uint8_t*)input, strlen ((char *) input),
531 NULL, UNINORM_NFD, NULL, &len);
532 memcpy (output, tmp_in, len);
539 * Complete filename (a la shell) from abbrevition.
540 * @param fil the name of the file, may contain ~/ or
541 * be relative to the current directory
542 * @returns the full file name,
543 * NULL is returned on error
546 GNUNET_STRINGS_filename_expand (const char *fil)
563 if (fil[0] == DIR_SEPARATOR)
564 /* absolute path, just copy */
565 return GNUNET_strdup (fil);
568 fm = getenv ("HOME");
571 LOG (GNUNET_ERROR_TYPE_WARNING,
572 _("Failed to expand `$HOME': environment variable `HOME' not set"));
575 fm = GNUNET_strdup (fm);
576 /* do not copy '~' */
579 /* skip over dir seperator to be consistent */
580 if (fil_ptr[0] == DIR_SEPARATOR)
591 buffer = GNUNET_malloc (len);
592 if (getcwd (buffer, len) != NULL)
597 if ((errno == ERANGE) && (len < 1024 * 1024 * 4))
600 GNUNET_free (buffer);
603 GNUNET_free (buffer);
608 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "getcwd");
609 buffer = getenv ("PWD"); /* alternative */
611 fm = GNUNET_strdup (buffer);
614 fm = GNUNET_strdup ("./"); /* give up */
616 n = strlen (fm) + 1 + strlen (fil_ptr) + 1;
617 buffer = GNUNET_malloc (n);
618 GNUNET_snprintf (buffer, n, "%s%s%s", fm,
619 (fm[strlen (fm) - 1] ==
620 DIR_SEPARATOR) ? "" : DIR_SEPARATOR_STR, fil_ptr);
624 fn = GNUNET_malloc (MAX_PATH + 1);
626 if ((lRet = plibc_conv_to_win_path (fil, fn)) != ERROR_SUCCESS)
628 SetErrnoFromWinError (lRet);
629 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "plibc_conv_to_win_path");
632 /* is the path relative? */
633 if ((strncmp (fn + 1, ":\\", 2) != 0) && (strncmp (fn, "\\\\", 2) != 0))
635 char szCurDir[MAX_PATH + 1];
637 lRet = GetCurrentDirectory (MAX_PATH + 1, szCurDir);
638 if (lRet + strlen (fn) + 1 > (MAX_PATH + 1))
640 SetErrnoFromWinError (ERROR_BUFFER_OVERFLOW);
641 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "GetCurrentDirectory");
644 buffer = GNUNET_malloc (MAX_PATH + 1);
645 GNUNET_snprintf (buffer, MAX_PATH + 1, "%s\\%s", szCurDir, fn);
656 * Give relative time in human-readable fancy format.
657 * This is one of the very few calls in the entire API that is
660 * @param delta time in milli seconds
661 * @param do_round are we allowed to round a bit?
662 * @return time as human-readable string
665 GNUNET_STRINGS_relative_time_to_string (struct GNUNET_TIME_Relative delta,
668 static char buf[128];
669 const char *unit = _( /* time unit */ "µs");
670 uint64_t dval = delta.rel_value_us;
672 if (GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us == delta.rel_value_us)
674 if (0 == delta.rel_value_us)
676 if ( ( (GNUNET_YES == do_round) &&
677 (dval > 5 * 1000) ) ||
678 (0 == (dval % 1000) ))
681 unit = _( /* time unit */ "ms");
682 if ( ( (GNUNET_YES == do_round) &&
683 (dval > 5 * 1000) ) ||
684 (0 == (dval % 1000) ))
687 unit = _( /* time unit */ "s");
688 if ( ( (GNUNET_YES == do_round) &&
690 (0 == (dval % 60) ) )
693 unit = _( /* time unit */ "m");
694 if ( ( (GNUNET_YES == do_round) &&
699 unit = _( /* time unit */ "h");
700 if ( ( (GNUNET_YES == do_round) &&
706 unit = _( /* time unit */ "day");
708 unit = _( /* time unit */ "days");
714 GNUNET_snprintf (buf, sizeof (buf),
715 "%llu %s", dval, unit);
721 * "asctime", except for GNUnet time. Converts a GNUnet internal
722 * absolute time (which is in UTC) to a string in local time.
723 * Note that the returned value will be overwritten if this function
726 * @param t the absolute time to convert
727 * @return timestamp in human-readable form in local time
730 GNUNET_STRINGS_absolute_time_to_string (struct GNUNET_TIME_Absolute t)
732 static char buf[255];
736 if (t.abs_value_us == GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us)
737 return _("end of time");
738 tt = t.abs_value_us / 1000LL / 1000LL;
740 strftime (buf, sizeof (buf), "%a %b %d %H:%M:%S %Y", tp);
747 * Returns a pointer to a part of filename (allocates nothing)!
749 * @param filename filename to extract basename from
750 * @return short (base) name of the file (that is, everything following the
751 * last directory separator in filename. If filename ends with a
752 * directory separator, the result will be a zero-length string.
753 * If filename has no directory separators, the result is filename
757 GNUNET_STRINGS_get_short_name (const char *filename)
759 const char *short_fn = filename;
761 while (NULL != (ss = strstr (short_fn, DIR_SEPARATOR_STR))
769 * Get the numeric value corresponding to a character.
771 * @param a a character
772 * @return corresponding numeric value
775 getValue__ (unsigned char a)
777 if ((a >= '0') && (a <= '9'))
779 if ((a >= 'A') && (a <= 'V'))
780 return (a - 'A' + 10);
781 if ((a >= 'a') && (a <= 'v'))
782 return (a - 'a' + 10);
788 * Convert binary data to ASCII encoding. The ASCII encoding is rather
789 * GNUnet specific. It was chosen such that it only uses characters
790 * in [0-9A-V], can be produced without complex arithmetics and uses a
791 * small number of characters.
792 * Does not append 0-terminator, but returns a pointer to the place where
793 * it should be placed, if needed.
795 * @param data data to encode
796 * @param size size of data (in bytes)
797 * @param out buffer to fill
798 * @param out_size size of the buffer. Must be large enough to hold
799 * ((size*8) + (((size*8) % 5) > 0 ? 5 - ((size*8) % 5) : 0)) / 5 bytes
800 * @return pointer to the next byte in 'out' or NULL on error.
803 GNUNET_STRINGS_data_to_string (const void *data, size_t size, char *out, size_t out_size)
806 * 32 characters for encoding
808 static char *encTable__ = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
813 const unsigned char *udata;
815 GNUNET_assert (data != NULL);
816 GNUNET_assert (out != NULL);
818 if (out_size < (((size*8) + ((size*8) % 5)) % 5))
827 while ((rpos < size) || (vbit > 0))
829 if ((rpos < size) && (vbit < 5))
831 bits = (bits << 8) | udata[rpos++]; /* eat 8 more bits */
836 bits <<= (5 - vbit); /* zero-padding */
837 GNUNET_assert (vbit == ((size * 8) % 5));
840 if (wpos >= out_size)
845 out[wpos++] = encTable__[(bits >> (vbit - 5)) & 31];
848 GNUNET_assert (vbit == 0);
856 * Convert ASCII encoding back to data
857 * out_size must match exactly the size of the data before it was encoded.
859 * @param enc the encoding
860 * @param enclen number of characters in @a enc (without 0-terminator, which can be missing)
861 * @param out location where to store the decoded data
862 * @param out_size size of the output buffer @a out
863 * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
866 GNUNET_STRINGS_string_to_data (const char *enc, size_t enclen,
867 void *out, size_t out_size)
876 unsigned int encoded_len = out_size * 8;
882 return GNUNET_SYSERR;
887 if ((encoded_len % 5) > 0)
889 vbit = encoded_len % 5; /* padding! */
891 bits = (ret = getValue__ (enc[--rpos])) >> (5 - (encoded_len % 5));
897 bits = (ret = getValue__ (enc[--rpos]));
899 if ((encoded_len + shift) / 5 != enclen)
900 return GNUNET_SYSERR;
902 return GNUNET_SYSERR;
908 return GNUNET_SYSERR;
910 bits = ((ret = getValue__ (enc[--rpos])) << vbit) | bits;
912 return GNUNET_SYSERR;
916 uout[--wpos] = (unsigned char) bits;
923 return GNUNET_SYSERR;
929 * Parse a path that might be an URI.
931 * @param path path to parse. Must be NULL-terminated.
932 * @param scheme_part a pointer to 'char *' where a pointer to a string that
933 * represents the URI scheme will be stored. Can be NULL. The string is
934 * allocated by the function, and should be freed by GNUNET_free() when
935 * it is no longer needed.
936 * @param path_part a pointer to 'const char *' where a pointer to the path
937 * part of the URI will be stored. Can be NULL. Points to the same block
938 * of memory as 'path', and thus must not be freed. Might point to '\0',
939 * if path part is zero-length.
940 * @return GNUNET_YES if it's an URI, GNUNET_NO otherwise. If 'path' is not
941 * an URI, '* scheme_part' and '*path_part' will remain unchanged
942 * (if they weren't NULL).
945 GNUNET_STRINGS_parse_uri (const char *path, char **scheme_part,
946 const char **path_part)
951 const char *post_scheme_part = NULL;
953 for (end = 0, i = 0; !end && i < len; i++)
958 if (path[i] == ':' && i > 0)
963 if (!((path[i] >= 'A' && path[i] <= 'Z') || (path[i] >= 'a' && path[i] <= 'z')
964 || (path[i] >= '0' && path[i] <= '9') || path[i] == '+' || path[i] == '-'
965 || (path[i] == '.')))
978 post_scheme_part = &path[i];
985 if (post_scheme_part == NULL)
989 *scheme_part = GNUNET_malloc (post_scheme_part - path + 1);
990 memcpy (*scheme_part, path, post_scheme_part - path);
991 (*scheme_part)[post_scheme_part - path] = '\0';
994 *path_part = post_scheme_part;
1000 * Check whether @a filename is absolute or not, and if it's an URI
1002 * @param filename filename to check
1003 * @param can_be_uri #GNUNET_YES to check for being URI, #GNUNET_NO - to
1004 * assume it's not URI
1005 * @param r_is_uri a pointer to an int that is set to #GNUNET_YES if @a filename
1006 * is URI and to #GNUNET_NO otherwise. Can be NULL. If @a can_be_uri is
1007 * not #GNUNET_YES, `* r_is_uri` is set to #GNUNET_NO.
1008 * @param r_uri_scheme a pointer to a char * that is set to a pointer to URI scheme.
1009 * The string is allocated by the function, and should be freed with
1010 * GNUNET_free(). Can be NULL.
1011 * @return #GNUNET_YES if @a filename is absolute, #GNUNET_NO otherwise.
1014 GNUNET_STRINGS_path_is_absolute (const char *filename,
1017 char **r_uri_scheme)
1022 const char *post_scheme_path;
1025 /* consider POSIX paths to be absolute too, even on W32,
1026 * as plibc expansion will fix them for us.
1028 if (filename[0] == '/')
1032 is_uri = GNUNET_STRINGS_parse_uri (filename, &uri, &post_scheme_path);
1038 *r_uri_scheme = uri;
1040 GNUNET_free_non_null (uri);
1042 len = strlen(post_scheme_path);
1043 /* Special check for file:///c:/blah
1044 * We want to parse 'c:/', not '/c:/'
1046 if (post_scheme_path[0] == '/' && len >= 3 && post_scheme_path[2] == ':')
1047 post_scheme_path = &post_scheme_path[1];
1049 return GNUNET_STRINGS_path_is_absolute (post_scheme_path, GNUNET_NO, NULL, NULL);
1055 *r_is_uri = GNUNET_NO;
1058 len = strlen (filename);
1060 ((filename[0] >= 'A' && filename[0] <= 'Z')
1061 || (filename[0] >= 'a' && filename[0] <= 'z'))
1062 && filename[1] == ':' && (filename[2] == '/' || filename[2] == '\\'))
1069 #define _IFMT 0170000 /* type of file */
1070 #define _IFLNK 0120000 /* symbolic link */
1071 #define S_ISLNK(m) (((m)&_IFMT) == _IFLNK)
1076 * Perform @a checks on @a filename.
1078 * @param filename file to check
1079 * @param checks checks to perform
1080 * @return #GNUNET_YES if all checks pass, #GNUNET_NO if at least one of them
1081 * fails, #GNUNET_SYSERR when a check can't be performed
1084 GNUNET_STRINGS_check_filename (const char *filename,
1085 enum GNUNET_STRINGS_FilenameCheck checks)
1088 if ( (NULL == filename) || (filename[0] == '\0') )
1089 return GNUNET_SYSERR;
1090 if (0 != (checks & GNUNET_STRINGS_CHECK_IS_ABSOLUTE))
1091 if (!GNUNET_STRINGS_path_is_absolute (filename, GNUNET_NO, NULL, NULL))
1093 if (0 != (checks & (GNUNET_STRINGS_CHECK_EXISTS
1094 | GNUNET_STRINGS_CHECK_IS_DIRECTORY
1095 | GNUNET_STRINGS_CHECK_IS_LINK)))
1097 if (0 != STAT (filename, &st))
1099 if (0 != (checks & GNUNET_STRINGS_CHECK_EXISTS))
1102 return GNUNET_SYSERR;
1105 if (0 != (checks & GNUNET_STRINGS_CHECK_IS_DIRECTORY))
1106 if (!S_ISDIR (st.st_mode))
1108 if (0 != (checks & GNUNET_STRINGS_CHECK_IS_LINK))
1109 if (!S_ISLNK (st.st_mode))
1116 * Tries to convert 'zt_addr' string to an IPv6 address.
1117 * The string is expected to have the format "[ABCD::01]:80".
1119 * @param zt_addr 0-terminated string. May be mangled by the function.
1120 * @param addrlen length of @a zt_addr (not counting 0-terminator).
1121 * @param r_buf a buffer to fill. Initially gets filled with zeroes,
1122 * then its sin6_port, sin6_family and sin6_addr are set appropriately.
1123 * @return #GNUNET_OK if conversion succeded.
1124 * #GNUNET_SYSERR otherwise, in which
1125 * case the contents of @a r_buf are undefined.
1128 GNUNET_STRINGS_to_address_ipv6 (const char *zt_addr,
1130 struct sockaddr_in6 *r_buf)
1132 char zbuf[addrlen + 1];
1138 return GNUNET_SYSERR;
1139 memcpy (zbuf, zt_addr, addrlen);
1142 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1143 _("IPv6 address did not start with `['\n"));
1144 return GNUNET_SYSERR;
1146 zbuf[addrlen] = '\0';
1147 port_colon = strrchr (zbuf, ':');
1148 if (NULL == port_colon)
1150 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1151 _("IPv6 address did contain ':' to separate port number\n"));
1152 return GNUNET_SYSERR;
1154 if (']' != *(port_colon - 1))
1156 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1157 _("IPv6 address did contain ']' before ':' to separate port number\n"));
1158 return GNUNET_SYSERR;
1160 ret = SSCANF (port_colon, ":%u", &port);
1161 if ( (1 != ret) || (port > 65535) )
1163 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1164 _("IPv6 address did contain a valid port number after the last ':'\n"));
1165 return GNUNET_SYSERR;
1167 *(port_colon-1) = '\0';
1168 memset (r_buf, 0, sizeof (struct sockaddr_in6));
1169 ret = inet_pton (AF_INET6, &zbuf[1], &r_buf->sin6_addr);
1172 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1173 _("Invalid IPv6 address `%s': %s\n"),
1176 return GNUNET_SYSERR;
1178 r_buf->sin6_port = htons (port);
1179 r_buf->sin6_family = AF_INET6;
1180 #if HAVE_SOCKADDR_IN_SIN_LEN
1181 r_buf->sin6_len = (u_char) sizeof (struct sockaddr_in6);
1188 * Tries to convert 'zt_addr' string to an IPv4 address.
1189 * The string is expected to have the format "1.2.3.4:80".
1191 * @param zt_addr 0-terminated string. May be mangled by the function.
1192 * @param addrlen length of @a zt_addr (not counting 0-terminator).
1193 * @param r_buf a buffer to fill.
1194 * @return #GNUNET_OK if conversion succeded.
1195 * #GNUNET_SYSERR otherwise, in which case
1196 * the contents of @a r_buf are undefined.
1199 GNUNET_STRINGS_to_address_ipv4 (const char *zt_addr, uint16_t addrlen,
1200 struct sockaddr_in *r_buf)
1202 unsigned int temps[4];
1207 return GNUNET_SYSERR;
1208 cnt = SSCANF (zt_addr, "%u.%u.%u.%u:%u", &temps[0], &temps[1], &temps[2], &temps[3], &port);
1210 return GNUNET_SYSERR;
1211 for (cnt = 0; cnt < 4; cnt++)
1212 if (temps[cnt] > 0xFF)
1213 return GNUNET_SYSERR;
1215 return GNUNET_SYSERR;
1216 r_buf->sin_family = AF_INET;
1217 r_buf->sin_port = htons (port);
1218 r_buf->sin_addr.s_addr = htonl ((temps[0] << 24) + (temps[1] << 16) +
1219 (temps[2] << 8) + temps[3]);
1220 #if HAVE_SOCKADDR_IN_SIN_LEN
1221 r_buf->sin_len = (u_char) sizeof (struct sockaddr_in);
1228 * Tries to convert @a addr string to an IP (v4 or v6) address.
1229 * Will automatically decide whether to treat 'addr' as v4 or v6 address.
1231 * @param addr a string, may not be 0-terminated.
1232 * @param addrlen number of bytes in @a addr (if addr is 0-terminated,
1233 * 0-terminator should not be counted towards addrlen).
1234 * @param r_buf a buffer to fill.
1235 * @return #GNUNET_OK if conversion succeded. GNUNET_SYSERR otherwise, in which
1236 * case the contents of r_buf are undefined.
1239 GNUNET_STRINGS_to_address_ip (const char *addr,
1241 struct sockaddr_storage *r_buf)
1244 return GNUNET_STRINGS_to_address_ipv6 (addr,
1246 (struct sockaddr_in6 *) r_buf);
1247 return GNUNET_STRINGS_to_address_ipv4 (addr,
1249 (struct sockaddr_in *) r_buf);
1254 * Makes a copy of argv that consists of a single memory chunk that can be
1255 * freed with a single call to GNUNET_free ();
1257 static char *const *
1258 _make_continuous_arg_copy (int argc,
1261 size_t argvsize = 0;
1265 for (i = 0; i < argc; i++)
1266 argvsize += strlen (argv[i]) + 1 + sizeof (char *);
1267 new_argv = GNUNET_malloc (argvsize + sizeof (char *));
1268 p = (char *) &new_argv[argc + 1];
1269 for (i = 0; i < argc; i++)
1272 strcpy (p, argv[i]);
1273 p += strlen (argv[i]) + 1;
1275 new_argv[argc] = NULL;
1276 return (char *const *) new_argv;
1281 * Returns utf-8 encoded arguments.
1282 * Does nothing (returns a copy of argc and argv) on any platform
1284 * Returned argv has u8argv[u8argc] == NULL.
1285 * Returned argv is a single memory block, and can be freed with a single
1286 * GNUNET_free () call.
1288 * @param argc argc (as given by main())
1289 * @param argv argv (as given by main())
1290 * @param u8argc a location to store new argc in (though it's th same as argc)
1291 * @param u8argv a location to store new argv in
1292 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
1295 GNUNET_STRINGS_get_utf8_args (int argc, char *const *argv, int *u8argc, char *const **u8argv)
1302 char **split_u8argv;
1304 wcmd = GetCommandLineW ();
1306 return GNUNET_SYSERR;
1307 wargv = CommandLineToArgvW (wcmd, &wargc);
1309 return GNUNET_SYSERR;
1311 split_u8argv = GNUNET_malloc (argc * sizeof (char *));
1313 for (i = 0; i < wargc; i++)
1316 /* Hopefully it will allocate us NUL-terminated strings... */
1317 split_u8argv[i] = (char *) u16_to_u8 (wargv[i], wcslen (wargv[i]) + 1, NULL, &strl);
1318 if (NULL == split_u8argv[i])
1321 for (j = 0; j < i; j++)
1322 free (split_u8argv[j]);
1323 GNUNET_free (split_u8argv);
1325 return GNUNET_SYSERR;
1329 *u8argv = _make_continuous_arg_copy (wargc, split_u8argv);
1332 for (i = 0; i < wargc; i++)
1333 free (split_u8argv[i]);
1334 free (split_u8argv);
1337 char *const *new_argv = (char *const *) _make_continuous_arg_copy (argc, argv);
1346 * Parse the given port policy. The format is
1347 * "[!]SPORT[-DPORT]".
1349 * @param port_policy string to parse
1350 * @param pp policy to fill in
1351 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
1352 * @a port_policy is malformed
1355 parse_port_policy (const char *port_policy,
1356 struct GNUNET_STRINGS_PortPolicy *pp)
1366 pp->negate_portrange = GNUNET_YES;
1369 if (2 == sscanf (pos,
1378 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1379 _("Port not in range\n"));
1380 return GNUNET_SYSERR;
1382 pp->start_port = (uint16_t) s;
1383 pp->end_port = (uint16_t) e;
1386 if (1 == sscanf (pos,
1394 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1395 _("Port not in range\n"));
1396 return GNUNET_SYSERR;
1399 pp->start_port = (uint16_t) s;
1400 pp->end_port = (uint16_t) s;
1403 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1404 _("Malformed port policy `%s'\n"),
1406 return GNUNET_SYSERR;
1411 * Parse an IPv4 network policy. The argument specifies a list of
1412 * subnets. The format is
1413 * <tt>(network[/netmask][:SPORT[-DPORT]];)*</tt> (no whitespace, must
1414 * be terminated with a semicolon). The network must be given in
1415 * dotted-decimal notation. The netmask can be given in CIDR notation
1416 * (/16) or in dotted-decimal (/255.255.0.0).
1418 * @param routeListX a string specifying the IPv4 subnets
1419 * @return the converted list, terminated with all zeros;
1420 * NULL if the synatx is flawed
1422 struct GNUNET_STRINGS_IPv4NetworkPolicy *
1423 GNUNET_STRINGS_parse_ipv4_policy (const char *routeListX)
1431 unsigned int temps[8];
1433 struct GNUNET_STRINGS_IPv4NetworkPolicy *result;
1438 if (NULL == routeListX)
1440 len = strlen (routeListX);
1443 routeList = GNUNET_strdup (routeListX);
1445 for (i = 0; i < len; i++)
1446 if (routeList[i] == ';')
1448 result = GNUNET_malloc (sizeof (struct GNUNET_STRINGS_IPv4NetworkPolicy) * (count + 1));
1453 for (colon = pos; ':' != routeList[colon]; colon++)
1454 if ( (';' == routeList[colon]) ||
1455 ('\0' == routeList[colon]) )
1457 for (end = colon; ';' != routeList[end]; end++)
1458 if ('\0' == routeList[end])
1460 if ('\0' == routeList[end])
1462 routeList[end] = '\0';
1463 if (':' == routeList[colon])
1465 routeList[colon] = '\0';
1466 if (GNUNET_OK != parse_port_policy (&routeList[colon + 1],
1471 SSCANF (&routeList[pos],
1472 "%u.%u.%u.%u/%u.%u.%u.%u",
1483 for (j = 0; j < 8; j++)
1484 if (temps[j] > 0xFF)
1486 LOG (GNUNET_ERROR_TYPE_WARNING,
1487 _("Invalid format for IP: `%s'\n"),
1489 GNUNET_free (result);
1490 GNUNET_free (routeList);
1493 result[i].network.s_addr =
1494 htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
1496 result[i].netmask.s_addr =
1497 htonl ((temps[4] << 24) + (temps[5] << 16) + (temps[6] << 8) +
1503 /* try second notation */
1505 SSCANF (&routeList[pos],
1514 for (j = 0; j < 4; j++)
1515 if (temps[j] > 0xFF)
1517 LOG (GNUNET_ERROR_TYPE_WARNING,
1518 _("Invalid format for IP: `%s'\n"),
1520 GNUNET_free (result);
1521 GNUNET_free (routeList);
1524 result[i].network.s_addr =
1525 htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
1527 if ((slash <= 32) && (slash >= 0))
1529 result[i].netmask.s_addr = 0;
1532 result[i].netmask.s_addr =
1533 (result[i].netmask.s_addr >> 1) + 0x80000000;
1536 result[i].netmask.s_addr = htonl (result[i].netmask.s_addr);
1543 LOG (GNUNET_ERROR_TYPE_WARNING,
1544 _("Invalid network notation ('/%d' is not legal in IPv4 CIDR)."),
1546 GNUNET_free (result);
1547 GNUNET_free (routeList);
1548 return NULL; /* error */
1551 /* try third notation */
1554 SSCANF (&routeList[pos],
1562 for (j = 0; j < 4; j++)
1563 if (temps[j] > 0xFF)
1565 LOG (GNUNET_ERROR_TYPE_WARNING,
1566 _("Invalid format for IP: `%s'\n"),
1568 GNUNET_free (result);
1569 GNUNET_free (routeList);
1572 result[i].network.s_addr =
1573 htonl ((temps[0] << 24) + (temps[1] << 16) + (temps[2] << 8) +
1575 result[i].netmask.s_addr = 0;
1578 result[i].netmask.s_addr = (result[i].netmask.s_addr >> 1) + 0x80000000;
1581 result[i].netmask.s_addr = htonl (result[i].netmask.s_addr);
1586 LOG (GNUNET_ERROR_TYPE_WARNING,
1587 _("Invalid format for IP: `%s'\n"),
1589 GNUNET_free (result);
1590 GNUNET_free (routeList);
1591 return NULL; /* error */
1593 if (pos < strlen (routeList))
1595 LOG (GNUNET_ERROR_TYPE_WARNING,
1596 _("Invalid format: `%s'\n"),
1598 GNUNET_free (result);
1599 GNUNET_free (routeList);
1600 return NULL; /* oops */
1602 GNUNET_free (routeList);
1603 return result; /* ok */
1608 * Parse an IPv6 network policy. The argument specifies a list of
1609 * subnets. The format is <tt>(network[/netmask[:SPORT[-DPORT]]];)*</tt>
1610 * (no whitespace, must be terminated with a semicolon). The network
1611 * must be given in colon-hex notation. The netmask must be given in
1612 * CIDR notation (/16) or can be omitted to specify a single host.
1613 * Note that the netmask is mandatory if ports are specified.
1615 * @param routeListX a string specifying the policy
1616 * @return the converted list, 0-terminated, NULL if the synatx is flawed
1618 struct GNUNET_STRINGS_IPv6NetworkPolicy *
1619 GNUNET_STRINGS_parse_ipv6_policy (const char *routeListX)
1629 struct GNUNET_STRINGS_IPv6NetworkPolicy *result;
1635 if (NULL == routeListX)
1637 len = strlen (routeListX);
1640 routeList = GNUNET_strdup (routeListX);
1642 for (i = 0; i < len; i++)
1643 if (';' == routeList[i])
1645 if (';' != routeList[len - 1])
1647 LOG (GNUNET_ERROR_TYPE_WARNING,
1648 _("Invalid network notation (does not end with ';': `%s')\n"),
1650 GNUNET_free (routeList);
1654 result = GNUNET_malloc (sizeof (struct GNUNET_STRINGS_IPv6NetworkPolicy) * (count + 1));
1660 while (';' != routeList[pos])
1663 while ((slash >= start) && (routeList[slash] != '/'))
1668 memset (&result[i].netmask,
1670 sizeof (struct in6_addr));
1675 routeList[pos] = '\0';
1676 for (colon = pos; ':' != routeList[colon]; colon--)
1677 if ('/' == routeList[colon])
1679 if (':' == routeList[colon])
1681 routeList[colon] = '\0';
1682 if (GNUNET_OK != parse_port_policy (&routeList[colon + 1],
1685 GNUNET_free (result);
1686 GNUNET_free (routeList);
1690 ret = inet_pton (AF_INET6, &routeList[slash + 1], &result[i].netmask);
1694 if ((1 != SSCANF (&routeList[slash + 1], "%u", &bits)) || (bits > 128))
1697 LOG (GNUNET_ERROR_TYPE_WARNING,
1698 _("Wrong format `%s' for netmask\n"),
1699 &routeList[slash + 1]);
1703 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "inet_pton");
1705 GNUNET_free (result);
1706 GNUNET_free (routeList);
1712 result[i].netmask.s6_addr[off++] = 0xFF;
1717 result[i].netmask.s6_addr[off] =
1718 (result[i].netmask.s6_addr[off] >> 1) + 0x80;
1723 routeList[slash] = '\0';
1724 ret = inet_pton (AF_INET6, &routeList[start], &result[i].network);
1728 LOG (GNUNET_ERROR_TYPE_WARNING,
1729 _("Wrong format `%s' for network\n"),
1730 &routeList[slash + 1]);
1732 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
1734 GNUNET_free (result);
1735 GNUNET_free (routeList);
1741 GNUNET_free (routeList);
1747 /** ******************** Base64 encoding ***********/
1749 #define FILLCHAR '='
1751 "ABCDEFGHIJKLMNOPQRSTUVWXYZ" "abcdefghijklmnopqrstuvwxyz" "0123456789+/";
1755 * Encode into Base64.
1757 * @param data the data to encode
1758 * @param len the length of the input
1759 * @param output where to write the output (*output should be NULL,
1761 * @return the size of the output
1764 GNUNET_STRINGS_base64_encode (const char *data,
1774 opt = GNUNET_malloc (2 + (len * 4 / 3) + 8);
1776 for (i = 0; i < len; ++i)
1778 c = (data[i] >> 2) & 0x3f;
1779 opt[ret++] = cvt[(int) c];
1780 c = (data[i] << 4) & 0x3f;
1782 c |= (data[i] >> 4) & 0x0f;
1783 opt[ret++] = cvt[(int) c];
1786 c = (data[i] << 2) & 0x3f;
1788 c |= (data[i] >> 6) & 0x03;
1789 opt[ret++] = cvt[(int) c];
1794 opt[ret++] = FILLCHAR;
1799 opt[ret++] = cvt[(int) c];
1803 opt[ret++] = FILLCHAR;
1806 opt[ret++] = FILLCHAR;
1810 #define cvtfind(a)( (((a) >= 'A')&&((a) <= 'Z'))? (a)-'A'\
1811 :(((a)>='a')&&((a)<='z')) ? (a)-'a'+26\
1812 :(((a)>='0')&&((a)<='9')) ? (a)-'0'+52\
1814 :((a) == '/') ? 63 : -1)
1818 * Decode from Base64.
1820 * @param data the data to encode
1821 * @param len the length of the input
1822 * @param output where to write the output (*output should be NULL,
1824 * @return the size of the output
1827 GNUNET_STRINGS_base64_decode (const char *data,
1828 size_t len, char **output)
1835 #define CHECK_CRLF while (data[i] == '\r' || data[i] == '\n') {\
1836 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK, "ignoring CR/LF\n"); \
1838 if (i >= len) goto END; \
1841 *output = GNUNET_malloc ((len * 3 / 4) + 8);
1842 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1843 "base64_decode decoding len=%d\n",
1845 for (i = 0; i < len; ++i)
1848 if (FILLCHAR == data[i])
1850 c = (char) cvtfind (data[i]);
1853 c1 = (char) cvtfind (data[i]);
1854 c = (c << 2) | ((c1 >> 4) & 0x3);
1855 (*output)[ret++] = c;
1862 c = (char) cvtfind (c);
1863 c1 = ((c1 << 4) & 0xf0) | ((c >> 2) & 0xf);
1864 (*output)[ret++] = c1;
1873 c1 = (char) cvtfind (c1);
1874 c = ((c << 6) & 0xc0) | c1;
1875 (*output)[ret++] = c;
1886 /* end of strings.c */