src/include/gnunet_strings_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2001-2013 GNUnet e.V.
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @author Christian Grothoff
  23  * @author Krista Bennett
  24  * @author Gerd Knorr <kraxel@bytesex.org>
  25  * @author Ioana Patrascu
  26  * @author Tzvetan Horozov
  27  *
  28  * @file
  29  * Strings and string handling functions
  30  *
  31  * @defgroup strings  Strings library
  32  * Strings and string handling functions, including malloc and string tokenizing.
  33  * @{
  34  */
  35
  36 #ifndef GNUNET_STRINGS_LIB_H
  37 #define GNUNET_STRINGS_LIB_H
  38
  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... */
  43 #include <stdlib.h>
  44
  45 #ifdef __cplusplus
  46 extern "C"
  47 {
  48 #if 0                           /* keep Emacsens' auto-indent happy */
  49 }
  50 #endif
  51 #endif
  52
  53 #include "gnunet_time_lib.h"
  54
  55
  56 /**
  57  * Convert a given fancy human-readable size to bytes.
  58  *
  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
  62  */
  63 int
  64 GNUNET_STRINGS_fancy_size_to_bytes (const char *fancy_size,
  65                                     unsigned long long *size);
  66
  67
  68 /**
  69  * Convert a given fancy human-readable time to our internal
  70  * representation.
  71  *
  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
  75  */
  76 int
  77 GNUNET_STRINGS_fancy_time_to_relative (const char *fancy_time,
  78                                        struct GNUNET_TIME_Relative *rtime);
  79
  80
  81 /**
  82  * @ingroup time
  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.
  86  *
  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
  90  */
  91 int
  92 GNUNET_STRINGS_fancy_time_to_absolute (const char *fancy_time,
  93                                        struct GNUNET_TIME_Absolute *atime);
  94
  95
  96 /**
  97  * Convert a given filesize into a fancy human-readable format.
  98  *
  99  * @param size number of bytes
 100  * @return fancy representation of the size (possibly rounded) for humans
 101  */
 102 char *
 103 GNUNET_STRINGS_byte_size_fancy (unsigned long long size);
 104
 105
 106 /**
 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.
 110  *
 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.
 118  */
 119 char *
 120 GNUNET_STRINGS_conv (const char *input, size_t len,
 121                      const char *input_charset,
 122                      const char *output_charset);
 123
 124
 125 /**
 126  * Convert the len characters long character sequence
 127  * given in input that is in the given charset
 128  * to UTF-8.
 129  *
 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)
 134  */
 135 char *
 136 GNUNET_STRINGS_to_utf8 (const char *input,
 137                         size_t len,
 138                         const char *charset);
 139
 140
 141 /**
 142  * Convert the len bytes-long UTF-8 string
 143  * given in input to the given charset.
 144  *
 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.
 151  */
 152 char *
 153 GNUNET_STRINGS_from_utf8 (const char *input,
 154                           size_t len,
 155                           const char *charset);
 156
 157
 158 /**
 159  * Convert the utf-8 input string to lower case.
 160  * Output needs to be allocated appropriately.
 161  *
 162  * @param input input string
 163  * @param output output buffer
 164  */
 165 void
 166 GNUNET_STRINGS_utf8_tolower (const char *input,
 167                              char *output);
 168
 169
 170 /**
 171  * Convert the utf-8 input string to upper case.
 172  * Output needs to be allocated appropriately.
 173  *
 174  * @param input input string
 175  * @param output output buffer
 176  */
 177 void
 178 GNUNET_STRINGS_utf8_toupper (const char *input,
 179                              char *output);
 180
 181
 182 /**
 183  * Complete filename (a la shell) from abbrevition.
 184  *
 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
 189  */
 190 char *
 191 GNUNET_STRINGS_filename_expand (const char *fil);
 192
 193
 194 /**
 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").
 198  *
 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.
 203  *
 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)
 212  */
 213 size_t
 214 GNUNET_STRINGS_buffer_fill (char *buffer,
 215                             size_t size,
 216                             unsigned int count,
 217                             ...);
 218
 219
 220 /**
 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.
 224  *
 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.
 231  */
 232 unsigned int
 233 GNUNET_STRINGS_buffer_tokenize (const char *buffer,
 234                                 size_t size,
 235                                 unsigned int count, ...);
 236
 237
 238
 239 /**
 240  * @ingroup time
 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
 244  * is called again.
 245  *
 246  * @param t the absolute time to convert
 247  * @return timestamp in human-readable form in local time
 248  */
 249 const char *
 250 GNUNET_STRINGS_absolute_time_to_string (struct GNUNET_TIME_Absolute t);
 251
 252
 253 /**
 254  * @ingroup time
 255  * Give relative time in human-readable fancy format.
 256  * This is one of the very few calls in the entire API that is
 257  * NOT reentrant!
 258  *
 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
 262  */
 263 const char *
 264 GNUNET_STRINGS_relative_time_to_string (struct GNUNET_TIME_Relative delta,
 265                                         int do_round);
 266
 267
 268 /**
 269  * "man basename"
 270  * Returns a pointer to a part of filename (allocates nothing)!
 271  *
 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
 277  *         itself.
 278  */
 279 const char *
 280 GNUNET_STRINGS_get_short_name (const char *filename);
 281
 282
 283 /**
 284  * Convert binary data to ASCII encoding using Base32Hex (RFC 4648).
 285  * Does not append 0-terminator, but returns a pointer to the place where
 286  * it should be placed, if needed.
 287  *
 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.
 294  */
 295 char *
 296 GNUNET_STRINGS_data_to_string (const void *data,
 297                                size_t size,
 298                                char *out,
 299                                size_t out_size);
 300
 301
 302 /**
 303  * Return the base32crockford encoding of the given buffer.
 304  *
 305  * The returned string will be freshly allocated, and must be free'd
 306  * with #GNUNET_free().
 307  *
 308  * @param buf buffer with data
 309  * @param size size of the buffer @a buf
 310  * @return freshly allocated, null-terminated string
 311  */
 312 char *
 313 GNUNET_STRINGS_data_to_string_alloc (const void *buf,
 314                                      size_t size);
 315
 316
 317 /**
 318  * Convert Base32hex encoding back to data.
 319  * @a out_size must match exactly the size of the data before it was encoded.
 320  *
 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
 326  */
 327 int
 328 GNUNET_STRINGS_string_to_data (const char *enc,
 329                                size_t enclen,
 330                                void *out,
 331                                size_t out_size);
 332
 333
 334 /**
 335  * Encode into Base64.
 336  *
 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,
 340  *   is allocated)
 341  * @return the size of the output
 342  */
 343 size_t
 344 GNUNET_STRINGS_base64_encode (const char *data, size_t len, char **output);
 345
 346
 347 /**
 348  * Decode from Base64.
 349  *
 350  * @param data the data to encode
 351  * @param len the length of the input
 352  * @param[out] output where to write the output (*output should be NULL,
 353  *   is allocated)
 354  * @return the size of the output
 355  */
 356 size_t
 357 GNUNET_STRINGS_base64_decode (const char *data,
 358                               size_t len,
 359                               char **output);
 360
 361
 362 /**
 363  * Convert a peer path to a human-readable string.
 364  *
 365  * @param pids array of PIDs to convert to a string
 366  * @param num_pids length of the @a pids array
 367  * @return string representing the array of @a pids
 368  */
 369 char *
 370 GNUNET_STRINGS_pp2s (const struct GNUNET_PeerIdentity *pids,
 371                      unsigned int num_pids);
 372
 373
 374 /**
 375  * Parse a path that might be an URI.
 376  *
 377  * @param path path to parse. Must be NULL-terminated.
 378  * @param[out] scheme_part pointer to a string that
 379  *        represents the URI scheme will be stored. Can be NULL. The string is
 380  *        allocated by the function, and should be freed by GNUNET_free() when
 381  *        it is no longer needed.
 382  * @param path_part a pointer to 'const char *' where a pointer to the path
 383  *        part of the URI will be stored. Can be NULL. Points to the same block
 384  *        of memory as @a path, and thus must not be freed. Might point to '\0',
 385  *        if path part is zero-length.
 386  * @return #GNUNET_YES if it's an URI, #GNUNET_NO otherwise. If 'path' is not
 387  *         an URI, '* scheme_part' and '*path_part' will remain unchanged
 388  *         (if they weren't NULL).
 389  */
 390 int
 391 GNUNET_STRINGS_parse_uri (const char *path,
 392                           char **scheme_part,
 393                           const char **path_part);
 394
 395
 396 /**
 397  * Check whether filename is absolute or not, and if it's an URI
 398  *
 399  * @param filename filename to check
 400  * @param can_be_uri #GNUNET_YES to check for being URI, #GNUNET_NO - to
 401  *        assume it's not URI
 402  * @param r_is_uri a pointer to an int that is set to #GNUNET_YES if 'filename'
 403  *        is URI and to GNUNET_NO otherwise. Can be NULL. If 'can_be_uri' is
 404  *        not #GNUNET_YES, *r_is_uri is set to #GNUNET_NO.
 405  * @param r_uri_scheme a pointer to a char * that is set to a pointer to URI scheme.
 406  *        The string is allocated by the function, and should be freed with
 407  *        GNUNET_free (). Can be NULL.
 408  * @return #GNUNET_YES if 'filename' is absolute, #GNUNET_NO otherwise.
 409  */
 410 int
 411 GNUNET_STRINGS_path_is_absolute (const char *filename,
 412                                  int can_be_uri,
 413                                  int *r_is_uri,
 414                                  char **r_uri_scheme);
 415
 416
 417 /**
 418  * Flags for what we should check a file for.
 419  */
 420 enum GNUNET_STRINGS_FilenameCheck
 421 {
 422   /**
 423    * Check that it exists.
 424    */
 425   GNUNET_STRINGS_CHECK_EXISTS = 0x00000001,
 426
 427   /**
 428    * Check that it is a directory.
 429    */
 430   GNUNET_STRINGS_CHECK_IS_DIRECTORY = 0x00000002,
 431
 432   /**
 433    * Check that it is a link.
 434    */
 435   GNUNET_STRINGS_CHECK_IS_LINK = 0x00000004,
 436
 437   /**
 438    * Check that the path is an absolute path.
 439    */
 440   GNUNET_STRINGS_CHECK_IS_ABSOLUTE = 0x00000008
 441 };
 442
 443
 444 /**
 445  * Perform checks on @a filename.  FIXME: some duplication with
 446  * "GNUNET_DISK_"-APIs.  We should unify those.
 447  *
 448  * @param filename file to check
 449  * @param checks checks to perform
 450  * @return #GNUNET_YES if all checks pass, #GNUNET_NO if at least one of them
 451  *         fails, #GNUNET_SYSERR when a check can't be performed
 452  */
 453 int
 454 GNUNET_STRINGS_check_filename (const char *filename,
 455                                enum GNUNET_STRINGS_FilenameCheck checks);
 456
 457
 458 /**
 459  * Tries to convert @a zt_addr string to an IPv6 address.
 460  * The string is expected to have the format "[ABCD::01]:80".
 461  *
 462  * @param zt_addr 0-terminated string. May be mangled by the function.
 463  * @param addrlen length of zt_addr (not counting 0-terminator).
 464  * @param r_buf a buffer to fill. Initially gets filled with zeroes,
 465  *        then its sin6_port, sin6_family and sin6_addr are set appropriately.
 466  * @return #GNUNET_OK if conversion succeded. #GNUNET_SYSERR otherwise, in which
 467  *         case the contents of r_buf are undefined.
 468  */
 469 int
 470 GNUNET_STRINGS_to_address_ipv6 (const char *zt_addr,
 471                                 uint16_t addrlen,
 472                                 struct sockaddr_in6 *r_buf);
 473
 474
 475 /**
 476  * Tries to convert @a zt_addr string to an IPv4 address.
 477  * The string is expected to have the format "1.2.3.4:80".
 478  *
 479  * @param zt_addr 0-terminated string. May be mangled by the function.
 480  * @param addrlen length of zt_addr (not counting 0-terminator).
 481  * @param r_buf a buffer to fill.
 482  * @return #GNUNET_OK if conversion succeded. #GNUNET_SYSERR otherwise, in which case
 483  *         the contents of r_buf are undefined.
 484  */
 485 int
 486 GNUNET_STRINGS_to_address_ipv4 (const char *zt_addr,
 487                                 uint16_t addrlen,
 488                                 struct sockaddr_in *r_buf);
 489
 490
 491 /**
 492  * Parse an address given as a string into a
 493  * `struct sockaddr`.
 494  *
 495  * @param addr the address
 496  * @param[out] af set to the parsed address family (i.e. AF_INET)
 497  * @param[out] sa set to the parsed address
 498  * @return 0 on error, otherwise number of bytes in @a sa
 499  */
 500 size_t
 501 GNUNET_STRINGS_parse_socket_addr (const char *addr,
 502                                   uint8_t *af,
 503                                   struct sockaddr **sa);
 504
 505
 506 /**
 507  * Tries to convert @a addr string to an IP (v4 or v6) address.
 508  * Will automatically decide whether to treat 'addr' as v4 or v6 address.
 509  *
 510  * @param addr a string, may not be 0-terminated.
 511  * @param addrlen number of bytes in @a addr (if addr is 0-terminated,
 512  *        0-terminator should not be counted towards addrlen).
 513  * @param r_buf a buffer to fill.
 514  * @return #GNUNET_OK if conversion succeded. #GNUNET_SYSERR otherwise, in which
 515  *         case the contents of r_buf are undefined.
 516  */
 517 int
 518 GNUNET_STRINGS_to_address_ip (const char *addr,
 519                               uint16_t addrlen,
 520                               struct sockaddr_storage *r_buf);
 521
 522
 523 /**
 524  * Returns utf-8 encoded arguments.  Does nothing (returns a copy of
 525  * @a argc and @a argv) on any platform other than W32.  Returned @a
 526  * argv has `u8argv[u8argc] == NULL`.  Returned @a argv is a single
 527  * memory block, and can be freed with a single GNUNET_free() call.
 528  *
 529  * @param argc argc (as given by main())
 530  * @param argv argv (as given by main())
 531  * @param u8argc a location to store new argc in (though it's th same as argc)
 532  * @param u8argv a location to store new argv in
 533  * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
 534  */
 535 int
 536 GNUNET_STRINGS_get_utf8_args (int argc,
 537                               char *const *argv,
 538                               int *u8argc,
 539                               char *const **u8argv);
 540
 541
 542 /* ***************** IPv4/IPv6 parsing ****************** */
 543
 544 struct GNUNET_STRINGS_PortPolicy
 545 {
 546
 547   /**
 548    * Starting port range (0 if none given).
 549    */
 550   uint16_t start_port;
 551
 552   /**
 553    * End of port range (0 if none given).
 554    */
 555   uint16_t end_port;
 556
 557   /**
 558    * #GNUNET_YES if the port range should be negated
 559    * ("!" in policy).
 560    */
 561   int negate_portrange;
 562
 563 };
 564
 565
 566 /**
 567  * @brief IPV4 network in CIDR notation.
 568  */
 569 struct GNUNET_STRINGS_IPv4NetworkPolicy
 570 {
 571   /**
 572    * IPv4 address.
 573    */
 574   struct in_addr network;
 575
 576   /**
 577    * IPv4 netmask.
 578    */
 579   struct in_addr netmask;
 580
 581   /**
 582    * Policy for port access.
 583    */
 584   struct GNUNET_STRINGS_PortPolicy pp;
 585
 586 };
 587
 588
 589 /**
 590  * @brief network in CIDR notation for IPV6.
 591  */
 592 struct GNUNET_STRINGS_IPv6NetworkPolicy
 593 {
 594   /**
 595    * IPv6 address.
 596    */
 597   struct in6_addr network;
 598
 599   /**
 600    * IPv6 netmask.
 601    */
 602   struct in6_addr netmask;
 603
 604   /**
 605    * Policy for port access.
 606    */
 607   struct GNUNET_STRINGS_PortPolicy pp;
 608
 609 };
 610
 611
 612 /**
 613  * Parse an IPv4 network policy. The argument specifies a list of
 614  * subnets. The format is <tt>(network[/netmask][:[!]SPORT-DPORT];)*</tt>
 615  * (no whitespace, must be terminated with a semicolon). The network
 616  * must be given in dotted-decimal notation. The netmask can be given
 617  * in CIDR notation (/16) or in dotted-decimal (/255.255.0.0).
 618  *
 619  * @param routeListX a string specifying the IPv4 subnets
 620  * @return the converted list, terminated with all zeros;
 621  *         NULL if the synatx is flawed
 622  */
 623 struct GNUNET_STRINGS_IPv4NetworkPolicy *
 624 GNUNET_STRINGS_parse_ipv4_policy (const char *routeListX);
 625
 626
 627 /**
 628  * Parse an IPv6 network policy. The argument specifies a list of
 629  * subnets. The format is <tt>(network[/netmask[:[!]SPORT[-DPORT]]];)*</tt>
 630  * (no whitespace, must be terminated with a semicolon). The network
 631  * must be given in colon-hex notation.  The netmask must be given in
 632  * CIDR notation (/16) or can be omitted to specify a single host.
 633  * Note that the netmask is mandatory if ports are specified.
 634  *
 635  * @param routeListX a string specifying the policy
 636  * @return the converted list, 0-terminated, NULL if the synatx is flawed
 637  */
 638 struct GNUNET_STRINGS_IPv6NetworkPolicy *
 639 GNUNET_STRINGS_parse_ipv6_policy (const char *routeListX);
 640
 641
 642
 643 #if 0                           /* keep Emacsens' auto-indent happy */
 644 {
 645 #endif
 646 #ifdef __cplusplus
 647 }
 648 #endif
 649
 650 /* ifndef GNUNET_UTIL_STRING_H */
 651 #endif
 652
 653 /** @} */  /* end of group */
 654
 655 /* end of gnunet_util_string.h */