2 This file is part of GNUnet.
3 Copyright (C) 2001-2013 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @author Christian Grothoff
23 * @author Krista Bennett
24 * @author Gerd Knorr <kraxel@bytesex.org>
25 * @author Ioana Patrascu
26 * @author Tzvetan Horozov
29 * Strings and string handling functions
31 * @defgroup strings Strings library
32 * Strings and string handling functions, including malloc and string tokenizing.
36 #ifndef GNUNET_STRINGS_LIB_H
37 #define GNUNET_STRINGS_LIB_H
39 /* we need size_t, and since it can be both unsigned int
40 or unsigned long long, this IS platform dependent;
41 but "stdlib.h" should be portable 'enough' to be
42 unconditionally available... */
48 #if 0 /* keep Emacsens' auto-indent happy */
53 #include "gnunet_time_lib.h"
57 * Convert a given fancy human-readable size to bytes.
59 * @param fancy_size human readable string (i.e. 1 MB)
60 * @param size set to the size in bytes
61 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
64 GNUNET_STRINGS_fancy_size_to_bytes (const char *fancy_size,
65 unsigned long long *size);
69 * Convert a given fancy human-readable time to our internal
72 * @param fancy_time human readable string (i.e. 1 minute)
73 * @param rtime set to the relative time
74 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
77 GNUNET_STRINGS_fancy_time_to_relative (const char *fancy_time,
78 struct GNUNET_TIME_Relative *rtime);
83 * Convert a given fancy human-readable time to our internal
84 * representation. The human-readable time is expected to be
85 * in local time, whereas the returned value will be in UTC.
87 * @param fancy_time human readable string (i.e. %Y-%m-%d %H:%M:%S)
88 * @param atime set to the absolute time
89 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
92 GNUNET_STRINGS_fancy_time_to_absolute (const char *fancy_time,
93 struct GNUNET_TIME_Absolute *atime);
97 * Convert a given filesize into a fancy human-readable format.
99 * @param size number of bytes
100 * @return fancy representation of the size (possibly rounded) for humans
103 GNUNET_STRINGS_byte_size_fancy (unsigned long long size);
107 * Convert the len characters long character sequence
108 * given in input that is in the given input charset
109 * to a string in given output charset.
111 * @param input input string
112 * @param len number of bytes in @a input
113 * @param input_charset character set used for @a input
114 * @param output_charset desired character set for the return value
115 * @return the converted string (0-terminated),
116 * if conversion fails, a copy of the orignal
117 * string is returned.
120 GNUNET_STRINGS_conv (const char *input, size_t len,
121 const char *input_charset,
122 const char *output_charset);
126 * Convert the len characters long character sequence
127 * given in input that is in the given charset
130 * @param input the input string (not necessarily 0-terminated)
131 * @param len the number of bytes in the @a input
132 * @param charset character set to convert from
133 * @return the converted string (0-terminated)
136 GNUNET_STRINGS_to_utf8 (const char *input,
138 const char *charset);
142 * Convert the len bytes-long UTF-8 string
143 * given in input to the given charset.
145 * @param input the input string (not necessarily 0-terminated)
146 * @param len the number of bytes in the @a input
147 * @param charset character set to convert to
148 * @return the converted string (0-terminated),
149 * if conversion fails, a copy of the orignal
150 * string is returned.
153 GNUNET_STRINGS_from_utf8 (const char *input,
155 const char *charset);
159 * Convert the utf-8 input string to lower case.
160 * Output needs to be allocated appropriately.
162 * @param input input string
163 * @param output output buffer
166 GNUNET_STRINGS_utf8_tolower (const char *input,
171 * Convert the utf-8 input string to upper case.
172 * Output needs to be allocated appropriately.
174 * @param input input string
175 * @param output output buffer
178 GNUNET_STRINGS_utf8_toupper (const char *input,
183 * Complete filename (a la shell) from abbrevition.
185 * @param fil the name of the file, may contain ~/ or
186 * be relative to the current directory
187 * @return the full file name,
188 * NULL is returned on error
191 GNUNET_STRINGS_filename_expand (const char *fil);
195 * Fill a buffer of the given size with count 0-terminated strings
196 * (given as varargs). If "buffer" is NULL, only compute the amount
197 * of space required (sum of "strlen(arg)+1").
199 * Unlike using "snprintf" with "%s", this function will add
200 * 0-terminators after each string. The
201 * "GNUNET_string_buffer_tokenize" function can be used to parse the
202 * buffer back into individual strings.
204 * @param buffer the buffer to fill with strings, can
205 * be NULL in which case only the necessary
206 * amount of space will be calculated
207 * @param size number of bytes available in buffer
208 * @param count number of strings that follow
209 * @param ... count 0-terminated strings to copy to buffer
210 * @return number of bytes written to the buffer
211 * (or number of bytes that would have been written)
214 GNUNET_STRINGS_buffer_fill (char *buffer,
221 * Given a buffer of a given size, find "count" 0-terminated strings
222 * in the buffer and assign the count (varargs) of type "const char**"
223 * to the locations of the respective strings in the buffer.
225 * @param buffer the buffer to parse FIXME: not 'const', is it?
226 * @param size size of the @a buffer
227 * @param count number of strings to locate
228 * @param ... pointers to where to store the strings
229 * @return offset of the character after the last 0-termination
230 * in the buffer, or 0 on error.
233 GNUNET_STRINGS_buffer_tokenize (const char *buffer,
235 unsigned int count, ...);
241 * Like `asctime`, except for GNUnet time. Converts a GNUnet internal
242 * absolute time (which is in UTC) to a string in local time.
243 * Note that the returned value will be overwritten if this function
246 * @param t the absolute time to convert
247 * @return timestamp in human-readable form in local time
250 GNUNET_STRINGS_absolute_time_to_string (struct GNUNET_TIME_Absolute t);
255 * Give relative time in human-readable fancy format.
256 * This is one of the very few calls in the entire API that is
259 * @param delta time in milli seconds
260 * @param do_round are we allowed to round a bit?
261 * @return string in human-readable form
264 GNUNET_STRINGS_relative_time_to_string (struct GNUNET_TIME_Relative delta,
270 * Returns a pointer to a part of filename (allocates nothing)!
272 * @param filename filename to extract basename from
273 * @return short (base) name of the file (that is, everything following the
274 * last directory separator in filename. If filename ends with a
275 * directory separator, the result will be a zero-length string.
276 * If filename has no directory separators, the result is filename
280 GNUNET_STRINGS_get_short_name (const char *filename);
284 * Convert binary data to ASCII encoding using CrockfordBase32.
285 * Does not append 0-terminator, but returns a pointer to the place where
286 * it should be placed, if needed.
288 * @param data data to encode
289 * @param size size of data (in bytes)
290 * @param out buffer to fill
291 * @param out_size size of the buffer. Must be large enough to hold
292 * ((size*8) + (((size*8) % 5) > 0 ? 5 - ((size*8) % 5) : 0)) / 5
293 * @return pointer to the next byte in 'out' or NULL on error.
296 GNUNET_STRINGS_data_to_string (const void *data,
303 * Return the base32crockford encoding of the given buffer.
305 * The returned string will be freshly allocated, and must be free'd
306 * with #GNUNET_free().
308 * @param buf buffer with data
309 * @param size size of the buffer @a buf
310 * @return freshly allocated, null-terminated string
313 GNUNET_STRINGS_data_to_string_alloc (const void *buf,
318 * Convert CrockfordBase32 encoding back to data.
319 * @a out_size must match exactly the size of the data before it was encoded.
321 * @param enc the encoding
322 * @param enclen number of characters in @a enc (without 0-terminator, which can be missing)
323 * @param out location where to store the decoded data
324 * @param out_size size of the output buffer @a out
325 * @return #GNUNET_OK on success, #GNUNET_SYSERR if result has the wrong encoding
328 GNUNET_STRINGS_string_to_data (const char *enc,
335 * Encode into Base64.
337 * @param data the data to encode
338 * @param len the length of the input
339 * @param output where to write the output (*output should be NULL,
341 * @return the size of the output
344 GNUNET_STRINGS_base64_encode (const void *in,
350 * Decode from Base64.
352 * @param data the data to encode
353 * @param len the length of the input
354 * @param[out] output where to write the output (*output should be NULL,
356 * @return the size of the output
359 GNUNET_STRINGS_base64_decode (const char *data,
365 * Convert a peer path to a human-readable string.
367 * @param pids array of PIDs to convert to a string
368 * @param num_pids length of the @a pids array
369 * @return string representing the array of @a pids
372 GNUNET_STRINGS_pp2s (const struct GNUNET_PeerIdentity *pids,
373 unsigned int num_pids);
377 * Parse a path that might be an URI.
379 * @param path path to parse. Must be NULL-terminated.
380 * @param[out] scheme_part pointer to a string that
381 * represents the URI scheme will be stored. Can be NULL. The string is
382 * allocated by the function, and should be freed by GNUNET_free() when
383 * it is no longer needed.
384 * @param path_part a pointer to 'const char *' where a pointer to the path
385 * part of the URI will be stored. Can be NULL. Points to the same block
386 * of memory as @a path, and thus must not be freed. Might point to '\0',
387 * if path part is zero-length.
388 * @return #GNUNET_YES if it's an URI, #GNUNET_NO otherwise. If 'path' is not
389 * an URI, '* scheme_part' and '*path_part' will remain unchanged
390 * (if they weren't NULL).
393 GNUNET_STRINGS_parse_uri (const char *path,
395 const char **path_part);
399 * Check whether filename is absolute or not, and if it's an URI
401 * @param filename filename to check
402 * @param can_be_uri #GNUNET_YES to check for being URI, #GNUNET_NO - to
403 * assume it's not URI
404 * @param r_is_uri a pointer to an int that is set to #GNUNET_YES if 'filename'
405 * is URI and to GNUNET_NO otherwise. Can be NULL. If 'can_be_uri' is
406 * not #GNUNET_YES, *r_is_uri is set to #GNUNET_NO.
407 * @param r_uri_scheme a pointer to a char * that is set to a pointer to URI scheme.
408 * The string is allocated by the function, and should be freed with
409 * GNUNET_free (). Can be NULL.
410 * @return #GNUNET_YES if 'filename' is absolute, #GNUNET_NO otherwise.
413 GNUNET_STRINGS_path_is_absolute (const char *filename,
416 char **r_uri_scheme);
420 * Flags for what we should check a file for.
422 enum GNUNET_STRINGS_FilenameCheck
425 * Check that it exists.
427 GNUNET_STRINGS_CHECK_EXISTS = 0x00000001,
430 * Check that it is a directory.
432 GNUNET_STRINGS_CHECK_IS_DIRECTORY = 0x00000002,
435 * Check that it is a link.
437 GNUNET_STRINGS_CHECK_IS_LINK = 0x00000004,
440 * Check that the path is an absolute path.
442 GNUNET_STRINGS_CHECK_IS_ABSOLUTE = 0x00000008
447 * Perform checks on @a filename. FIXME: some duplication with
448 * "GNUNET_DISK_"-APIs. We should unify those.
450 * @param filename file to check
451 * @param checks checks to perform
452 * @return #GNUNET_YES if all checks pass, #GNUNET_NO if at least one of them
453 * fails, #GNUNET_SYSERR when a check can't be performed
456 GNUNET_STRINGS_check_filename (const char *filename,
457 enum GNUNET_STRINGS_FilenameCheck checks);
461 * Tries to convert @a zt_addr string to an IPv6 address.
462 * The string is expected to have the format "[ABCD::01]:80".
464 * @param zt_addr 0-terminated string. May be mangled by the function.
465 * @param addrlen length of zt_addr (not counting 0-terminator).
466 * @param r_buf a buffer to fill. Initially gets filled with zeroes,
467 * then its sin6_port, sin6_family and sin6_addr are set appropriately.
468 * @return #GNUNET_OK if conversion succeded. #GNUNET_SYSERR otherwise, in which
469 * case the contents of r_buf are undefined.
472 GNUNET_STRINGS_to_address_ipv6 (const char *zt_addr,
474 struct sockaddr_in6 *r_buf);
478 * Tries to convert @a zt_addr string to an IPv4 address.
479 * The string is expected to have the format "1.2.3.4:80".
481 * @param zt_addr 0-terminated string. May be mangled by the function.
482 * @param addrlen length of zt_addr (not counting 0-terminator).
483 * @param r_buf a buffer to fill.
484 * @return #GNUNET_OK if conversion succeded. #GNUNET_SYSERR otherwise, in which case
485 * the contents of r_buf are undefined.
488 GNUNET_STRINGS_to_address_ipv4 (const char *zt_addr,
490 struct sockaddr_in *r_buf);
494 * Parse an address given as a string into a
497 * @param addr the address
498 * @param[out] af set to the parsed address family (i.e. AF_INET)
499 * @param[out] sa set to the parsed address
500 * @return 0 on error, otherwise number of bytes in @a sa
503 GNUNET_STRINGS_parse_socket_addr (const char *addr,
505 struct sockaddr **sa);
509 * Tries to convert @a addr string to an IP (v4 or v6) address.
510 * Will automatically decide whether to treat 'addr' as v4 or v6 address.
512 * @param addr a string, may not be 0-terminated.
513 * @param addrlen number of bytes in @a addr (if addr is 0-terminated,
514 * 0-terminator should not be counted towards addrlen).
515 * @param r_buf a buffer to fill.
516 * @return #GNUNET_OK if conversion succeded. #GNUNET_SYSERR otherwise, in which
517 * case the contents of r_buf are undefined.
520 GNUNET_STRINGS_to_address_ip (const char *addr,
522 struct sockaddr_storage *r_buf);
526 * Returns utf-8 encoded arguments. Does nothing (returns a copy of
527 * @a argc and @a argv) on any platform other than W32. Returned @a
528 * argv has `u8argv[u8argc] == NULL`. Returned @a argv is a single
529 * memory block, and can be freed with a single GNUNET_free() call.
531 * @param argc argc (as given by main())
532 * @param argv argv (as given by main())
533 * @param u8argc a location to store new argc in (though it's th same as argc)
534 * @param u8argv a location to store new argv in
535 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
538 GNUNET_STRINGS_get_utf8_args (int argc,
541 char *const **u8argv);
544 /* ***************** IPv4/IPv6 parsing ****************** */
546 struct GNUNET_STRINGS_PortPolicy
550 * Starting port range (0 if none given).
555 * End of port range (0 if none given).
560 * #GNUNET_YES if the port range should be negated
563 int negate_portrange;
569 * @brief IPV4 network in CIDR notation.
571 struct GNUNET_STRINGS_IPv4NetworkPolicy
576 struct in_addr network;
581 struct in_addr netmask;
584 * Policy for port access.
586 struct GNUNET_STRINGS_PortPolicy pp;
592 * @brief network in CIDR notation for IPV6.
594 struct GNUNET_STRINGS_IPv6NetworkPolicy
599 struct in6_addr network;
604 struct in6_addr netmask;
607 * Policy for port access.
609 struct GNUNET_STRINGS_PortPolicy pp;
615 * Parse an IPv4 network policy. The argument specifies a list of
616 * subnets. The format is <tt>(network[/netmask][:[!]SPORT-DPORT];)*</tt>
617 * (no whitespace, must be terminated with a semicolon). The network
618 * must be given in dotted-decimal notation. The netmask can be given
619 * in CIDR notation (/16) or in dotted-decimal (/255.255.0.0).
621 * @param routeListX a string specifying the IPv4 subnets
622 * @return the converted list, terminated with all zeros;
623 * NULL if the synatx is flawed
625 struct GNUNET_STRINGS_IPv4NetworkPolicy *
626 GNUNET_STRINGS_parse_ipv4_policy (const char *routeListX);
630 * Parse an IPv6 network policy. The argument specifies a list of
631 * subnets. The format is <tt>(network[/netmask[:[!]SPORT[-DPORT]]];)*</tt>
632 * (no whitespace, must be terminated with a semicolon). The network
633 * must be given in colon-hex notation. The netmask must be given in
634 * CIDR notation (/16) or can be omitted to specify a single host.
635 * Note that the netmask is mandatory if ports are specified.
637 * @param routeListX a string specifying the policy
638 * @return the converted list, 0-terminated, NULL if the synatx is flawed
640 struct GNUNET_STRINGS_IPv6NetworkPolicy *
641 GNUNET_STRINGS_parse_ipv6_policy (const char *routeListX);
645 #if 0 /* keep Emacsens' auto-indent happy */
652 /* ifndef GNUNET_UTIL_STRING_H */
655 /** @} */ /* end of group */
657 /* end of gnunet_util_string.h */