dbus/dbus-string.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-string.c String utility class (internal to D-BUS implementation)
   3  *
   4  * Copyright (C) 2002  Red Hat, Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23
  24 #include "dbus-internals.h"
  25 #include "dbus-string.h"
  26 /* we allow a system header here, for speed/convenience */
  27 #include <string.h>
  28
  29 /**
  30  * @defgroup DBusString string class
  31  * @ingroup  DBusInternals
  32  * @brief DBusString data structure
  33  *
  34  * Types and functions related to DBusString. DBusString is intended
  35  * to be a string class that makes it hard to mess up security issues
  36  * (and just in general harder to write buggy code).  It should be
  37  * used (or extended and then used) rather than the libc stuff in
  38  * string.h.  The string class is a bit inconvenient at spots because
  39  * it handles out-of-memory failures and tries to be extra-robust.
  40  *
  41  * A DBusString has a maximum length set at initialization time; this
  42  * can be used to ensure that a buffer doesn't get too big.  The
  43  * _dbus_string_lengthen() method checks for overflow, and for max
  44  * length being exceeded.
  45  *
  46  * Try to avoid conversion to a plain C string, i.e. add methods on
  47  * the string object instead, only convert to C string when passing
  48  * things out to the public API. In particular, no sprintf, strcpy,
  49  * strcat, any of that should be used. The GString feature of
  50  * accepting negative numbers for "length of string" is also absent,
  51  * because it could keep us from detecting bogus huge lengths. i.e. if
  52  * we passed in some bogus huge length it would be taken to mean
  53  * "current length of string" instead of "broken crack"
  54  */
  55
  56 /**
  57  * @defgroup DBusStringInternals DBusString implementation details
  58  * @ingroup  DBusInternals
  59  * @brief DBusString implementation details
  60  *
  61  * The guts of DBusString.
  62  *
  63  * @{
  64  */
  65
  66 /**
  67  * @brief Internals of DBusString.
  68  *
  69  * DBusString internals. DBusString is an opaque objects, it must be
  70  * used via accessor functions.
  71  */
  72 typedef struct
  73 {
  74   unsigned char *str;            /**< String data, plus nul termination */
  75   int            len;            /**< Length without nul */
  76   int            allocated;      /**< Allocated size of data */
  77   int            max_length;     /**< Max length of this string. */
  78   unsigned int   constant : 1;   /**< String data is not owned by DBusString */
  79   unsigned int   locked : 1;     /**< DBusString has been locked and can't be changed */
  80   unsigned int   invalid : 1;    /**< DBusString is invalid (e.g. already freed) */
  81 } DBusRealString;
  82
  83 /**
  84  * Checks a bunch of assertions about a string object
  85  *
  86  * @param real the DBusRealString
  87  */
  88 #define DBUS_GENERIC_STRING_PREAMBLE(real) _dbus_assert ((real) != NULL); _dbus_assert (!(real)->invalid); _dbus_assert ((real)->len >= 0); _dbus_assert ((real)->allocated >= 0); _dbus_assert ((real)->max_length >= 0); _dbus_assert ((real)->len <= (real)->allocated); _dbus_assert ((real)->len <= (real)->max_length)
  89
  90 /**
  91  * Checks assertions about a string object that needs to be
  92  * modifiable - may not be locked or const. Also declares
  93  * the "real" variable pointing to DBusRealString.
  94  * @param str the string
  95  */
  96 #define DBUS_STRING_PREAMBLE(str) DBusRealString *real = (DBusRealString*) str; \
  97   DBUS_GENERIC_STRING_PREAMBLE (real);                                          \
  98   _dbus_assert (!(real)->constant);                                             \
  99   _dbus_assert (!(real)->locked)
 100
 101 /**
 102  * Checks assertions about a string object that may be locked but
 103  * can't be const. i.e. a string object that we can free.  Also
 104  * declares the "real" variable pointing to DBusRealString.
 105  *
 106  * @param str the string
 107  */
 108 #define DBUS_LOCKED_STRING_PREAMBLE(str) DBusRealString *real = (DBusRealString*) str; \
 109   DBUS_GENERIC_STRING_PREAMBLE (real);                                                 \
 110   _dbus_assert (!(real)->constant)
 111
 112 /**
 113  * Checks assertions about a string that may be const or locked.  Also
 114  * declares the "real" variable pointing to DBusRealString.
 115  * @param str the string.
 116  */
 117 #define DBUS_CONST_STRING_PREAMBLE(str) const DBusRealString *real = (DBusRealString*) str; \
 118   DBUS_GENERIC_STRING_PREAMBLE (real)
 119
 120 /** @} */
 121
 122 /**
 123  * @addtogroup DBusString
 124  * @{
 125  */
 126
 127 /** Assert that the string's memory is 8-byte aligned.
 128  *
 129  *  @todo Currently we just hope libc returns 8-byte aligned memory
 130  *  (which is true for GNU libc), but really we need to ensure it by
 131  *  allocating 8 extra bytes and keeping an "align_offset : 3" field
 132  *  in DBusString, or something along those lines.
 133  */
 134 #define ASSERT_8_BYTE_ALIGNED(s) \
 135   _dbus_assert (_DBUS_ALIGN_ADDRESS (((const DBusRealString*)s)->str, 8) == ((const DBusRealString*)s)->str)
 136
 137 /**
 138  * Initializes a string. The maximum length may be _DBUS_INT_MAX for
 139  * no maximum. The string starts life with zero length.
 140  * The string must eventually be freed with _dbus_string_free().
 141  *
 142  * @todo the max length feature is useless, because it looks
 143  * to the app like out of memory, and the app might try
 144  * to "recover" - but recovery in this case is impossible,
 145  * as we can't ever "get more memory" - so should delete the
 146  * max length feature I think.
 147  *
 148  * @todo we could make this init routine not alloc any memory and
 149  * return void, would simplify a lot of code, however it might
 150  * complexify things elsewhere because _dbus_string_get_data()
 151  * etc. could suddenly fail as they'd need to alloc new memory.
 152  *
 153  * @param str memory to hold the string
 154  * @param max_length the maximum size of the string
 155  * @returns #TRUE on success
 156  */
 157 dbus_bool_t
 158 _dbus_string_init (DBusString *str,
 159                    int         max_length)
 160 {
 161   DBusRealString *real;
 162
 163   _dbus_assert (str != NULL);
 164   _dbus_assert (max_length >= 0);
 165
 166   _dbus_assert (sizeof (DBusString) == sizeof (DBusRealString));
 167
 168   real = (DBusRealString*) str;
 169
 170   /* It's very important not to touch anything
 171    * other than real->str if we're going to fail,
 172    * since we also use this function to reset
 173    * an existing string, e.g. in _dbus_string_steal_data()
 174    */
 175
 176 #define INITIAL_ALLOC 2
 177
 178   real->str = dbus_malloc (INITIAL_ALLOC);
 179   if (real->str == NULL)
 180     return FALSE;
 181
 182   real->allocated = INITIAL_ALLOC;
 183   real->len = 0;
 184   real->str[real->len] = '\0';
 185
 186   real->max_length = max_length;
 187   real->constant = FALSE;
 188   real->locked = FALSE;
 189   real->invalid = FALSE;
 190
 191   ASSERT_8_BYTE_ALIGNED (str);
 192
 193   return TRUE;
 194 }
 195
 196 /**
 197  * Initializes a constant string. The value parameter is not copied
 198  * (should be static), and the string may never be modified.
 199  * It is safe but not necessary to call _dbus_string_free()
 200  * on a const string.
 201  *
 202  * @param str memory to use for the string
 203  * @param value a string to be stored in str (not copied!!!)
 204  */
 205 void
 206 _dbus_string_init_const (DBusString *str,
 207                          const char *value)
 208 {
 209   _dbus_string_init_const_len (str, value,
 210                                strlen (value));
 211 }
 212
 213 /**
 214  * Initializes a constant string with a length. The value parameter is
 215  * not copied (should be static), and the string may never be
 216  * modified.  It is safe but not necessary to call _dbus_string_free()
 217  * on a const string.
 218  *
 219  * @param str memory to use for the string
 220  * @param value a string to be stored in str (not copied!!!)
 221  * @param len the length to use
 222  */
 223 void
 224 _dbus_string_init_const_len (DBusString *str,
 225                              const char *value,
 226                              int         len)
 227 {
 228   DBusRealString *real;
 229
 230   _dbus_assert (str != NULL);
 231   _dbus_assert (value != NULL);
 232
 233   real = (DBusRealString*) str;
 234
 235   real->str = (char*) value;
 236   real->len = len;
 237   real->allocated = real->len;
 238   real->max_length = real->len;
 239   real->constant = TRUE;
 240   real->invalid = FALSE;
 241
 242   /* We don't require const strings to be 8-byte aligned as the
 243    * memory is coming from elsewhere.
 244    */
 245 }
 246
 247 /**
 248  * Frees a string created by _dbus_string_init().
 249  *
 250  * @param str memory where the string is stored.
 251  */
 252 void
 253 _dbus_string_free (DBusString *str)
 254 {
 255   DBUS_LOCKED_STRING_PREAMBLE (str);
 256
 257   if (real->constant)
 258     return;
 259
 260   dbus_free (real->str);
 261
 262   real->invalid = TRUE;
 263 }
 264
 265 /**
 266  * Locks a string such that any attempts to change the string
 267  * will result in aborting the program. Also, if the string
 268  * is wasting a lot of memory (allocation is larger than what
 269  * the string is really using), _dbus_string_lock() will realloc
 270  * the string's data to "compact" it.
 271  *
 272  * @param str the string to lock.
 273  */
 274 void
 275 _dbus_string_lock (DBusString *str)
 276 {
 277   DBUS_LOCKED_STRING_PREAMBLE (str); /* can lock multiple times */
 278
 279   real->locked = TRUE;
 280
 281   /* Try to realloc to avoid excess memory usage, since
 282    * we know we won't change the string further
 283    */
 284 #define MAX_WASTE 24
 285   if (real->allocated > (real->len + MAX_WASTE))
 286     {
 287       char *new_str;
 288       int new_allocated;
 289
 290       new_allocated = real->len + 1;
 291
 292       new_str = dbus_realloc (real->str, new_allocated);
 293       if (new_str != NULL)
 294         {
 295           real->str = new_str;
 296           real->allocated = new_allocated;
 297           ASSERT_8_BYTE_ALIGNED (str);
 298         }
 299     }
 300 }
 301
 302 /**
 303  * Gets the raw character buffer from the string.  The returned buffer
 304  * will be nul-terminated, but note that strings may contain binary
 305  * data so there may be extra nul characters prior to the termination.
 306  * This function should be little-used, extend DBusString or add
 307  * stuff to dbus-sysdeps.c instead. It's an error to use this
 308  * function on a const string.
 309  *
 310  * @param str the string
 311  * @param data_return place to store the returned data
 312  */
 313 void
 314 _dbus_string_get_data (DBusString        *str,
 315                        char             **data_return)
 316 {
 317   DBUS_STRING_PREAMBLE (str);
 318   _dbus_assert (data_return != NULL);
 319
 320   *data_return = real->str;
 321 }
 322
 323 /**
 324  * Gets the raw character buffer from a const string.
 325  *
 326  * @param str the string
 327  * @param data_return location to store returned data
 328  */
 329 void
 330 _dbus_string_get_const_data (const DBusString  *str,
 331                              const char       **data_return)
 332 {
 333   DBUS_CONST_STRING_PREAMBLE (str);
 334   _dbus_assert (data_return != NULL);
 335
 336   *data_return = real->str;
 337 }
 338
 339 /**
 340  * Gets a sub-portion of the raw character buffer from the
 341  * string. The "len" field is required simply for error
 342  * checking, to be sure you don't try to use more
 343  * string than exists. The nul termination of the
 344  * returned buffer remains at the end of the entire
 345  * string, not at start + len.
 346  *
 347  * @param str the string
 348  * @param data_return location to return the buffer
 349  * @param start byte offset to return
 350  * @param len length of segment to return
 351  */
 352 void
 353 _dbus_string_get_data_len (DBusString *str,
 354                            char      **data_return,
 355                            int         start,
 356                            int         len)
 357 {
 358   DBUS_STRING_PREAMBLE (str);
 359   _dbus_assert (data_return != NULL);
 360   _dbus_assert (start >= 0);
 361   _dbus_assert (len >= 0);
 362   _dbus_assert ((start + len) <= real->len);
 363
 364   *data_return = real->str + start;
 365 }
 366
 367 /**
 368  * const version of _dbus_string_get_data_len().
 369  *
 370  * @param str the string
 371  * @param data_return location to return the buffer
 372  * @param start byte offset to return
 373  * @param len length of segment to return
 374  */
 375 void
 376 _dbus_string_get_const_data_len (const DBusString  *str,
 377                                  const char       **data_return,
 378                                  int                start,
 379                                  int                len)
 380 {
 381   DBUS_CONST_STRING_PREAMBLE (str);
 382   _dbus_assert (data_return != NULL);
 383   _dbus_assert (start >= 0);
 384   _dbus_assert (len >= 0);
 385   _dbus_assert ((start + len) <= real->len);
 386
 387   *data_return = real->str + start;
 388 }
 389
 390 /**
 391  * Gets the byte at the given position.
 392  *
 393  * @param str the string
 394  * @param start the position
 395  * @returns the byte at that position
 396  */
 397 char
 398 _dbus_string_get_byte (const DBusString  *str,
 399                        int                start)
 400 {
 401   DBUS_CONST_STRING_PREAMBLE (str);
 402   _dbus_assert (start < real->len);
 403
 404   return real->str[start];
 405 }
 406
 407 /**
 408  * Like _dbus_string_get_data(), but removes the
 409  * gotten data from the original string. The caller
 410  * must free the data returned. This function may
 411  * fail due to lack of memory, and return #FALSE.
 412  *
 413  * @param str the string
 414  * @param data_return location to return the buffer
 415  * @returns #TRUE on success
 416  */
 417 dbus_bool_t
 418 _dbus_string_steal_data (DBusString        *str,
 419                          char             **data_return)
 420 {
 421   DBUS_STRING_PREAMBLE (str);
 422   _dbus_assert (data_return != NULL);
 423
 424   *data_return = real->str;
 425
 426   /* reset the string */
 427   if (!_dbus_string_init (str, real->max_length))
 428     {
 429       /* hrm, put it back then */
 430       real->str = *data_return;
 431       *data_return = NULL;
 432       return FALSE;
 433     }
 434
 435   return TRUE;
 436 }
 437
 438 /**
 439  * Like _dbus_string_get_data_len(), but removes the gotten data from
 440  * the original string. The caller must free the data returned. This
 441  * function may fail due to lack of memory, and return #FALSE.
 442  * The returned string is nul-terminated and has length len.
 443  *
 444  * @param str the string
 445  * @param data_return location to return the buffer
 446  * @param start the start of segment to steal
 447  * @param len the length of segment to steal
 448  * @returns #TRUE on success
 449  */
 450 dbus_bool_t
 451 _dbus_string_steal_data_len (DBusString        *str,
 452                              char             **data_return,
 453                              int                start,
 454                              int                len)
 455 {
 456   DBusString dest;
 457
 458   DBUS_STRING_PREAMBLE (str);
 459   _dbus_assert (data_return != NULL);
 460   _dbus_assert (start >= 0);
 461   _dbus_assert (len >= 0);
 462   _dbus_assert ((start + len) <= real->len);
 463
 464   if (!_dbus_string_init (&dest, real->max_length))
 465     return FALSE;
 466
 467   if (!_dbus_string_move_len (str, start, len, &dest, 0))
 468     {
 469       _dbus_string_free (&dest);
 470       return FALSE;
 471     }
 472
 473   if (!_dbus_string_steal_data (&dest, data_return))
 474     {
 475       _dbus_string_free (&dest);
 476       return FALSE;
 477     }
 478
 479   _dbus_string_free (&dest);
 480   return TRUE;
 481 }
 482
 483 /**
 484  * Gets the length of a string (not including nul termination).
 485  *
 486  * @returns the length.
 487  */
 488 int
 489 _dbus_string_get_length (const DBusString  *str)
 490 {
 491   DBUS_CONST_STRING_PREAMBLE (str);
 492
 493   return real->len;
 494 }
 495
 496 static dbus_bool_t
 497 set_length (DBusRealString *real,
 498             int             new_length)
 499 {
 500   /* Note, we are setting the length without nul termination */
 501
 502   /* exceeding max length is the same as failure to allocate memory */
 503   if (new_length > real->max_length)
 504     return FALSE;
 505
 506   while (new_length >= real->allocated)
 507     {
 508       int new_allocated;
 509       char *new_str;
 510
 511       new_allocated = 2 + real->allocated * 2;
 512       if (new_allocated < real->allocated)
 513         return FALSE; /* overflow */
 514
 515       new_str = dbus_realloc (real->str, new_allocated);
 516       if (new_str == NULL)
 517         return FALSE;
 518
 519       real->str = new_str;
 520       real->allocated = new_allocated;
 521
 522       ASSERT_8_BYTE_ALIGNED (real);
 523     }
 524
 525   real->len = new_length;
 526   real->str[real->len] = '\0';
 527
 528   return TRUE;
 529 }
 530
 531 /**
 532  * Makes a string longer by the given number of bytes.  Checks whether
 533  * adding additional_length to the current length would overflow an
 534  * integer, and checks for exceeding a string's max length.
 535  * The new bytes are not initialized, other than nul-terminating
 536  * the end of the string. The uninitialized bytes may contain
 537  * unexpected nul bytes or other junk.
 538  *
 539  * @param str a string
 540  * @param additional_length length to add to the string.
 541  * @returns #TRUE on success.
 542  */
 543 dbus_bool_t
 544 _dbus_string_lengthen (DBusString *str,
 545                        int         additional_length)
 546 {
 547   DBUS_STRING_PREAMBLE (str);
 548   _dbus_assert (additional_length >= 0);
 549
 550   if ((real->len + additional_length) < real->len)
 551     return FALSE; /* overflow */
 552
 553   return set_length (real,
 554                      real->len + additional_length);
 555 }
 556
 557 /**
 558  * Makes a string shorter by the given number of bytes.
 559  *
 560  * @param str a string
 561  * @param length_to_remove length to remove from the string.
 562  */
 563 void
 564 _dbus_string_shorten (DBusString *str,
 565                       int         length_to_remove)
 566 {
 567   DBUS_STRING_PREAMBLE (str);
 568   _dbus_assert (length_to_remove >= 0);
 569   _dbus_assert (length_to_remove <= real->len);
 570
 571   set_length (real,
 572               real->len - length_to_remove);
 573 }
 574
 575 /**
 576  * Sets the length of a string. Can be used to truncate or lengthen
 577  * the string. If the string is lengthened, the function may fail and
 578  * return #FALSE. Newly-added bytes are not initialized, as with
 579  * _dbus_string_lengthen().
 580  *
 581  * @param str a string
 582  * @param length new length of the string.
 583  * @returns #FALSE on failure.
 584  */
 585 dbus_bool_t
 586 _dbus_string_set_length (DBusString *str,
 587                          int         length)
 588 {
 589   DBUS_STRING_PREAMBLE (str);
 590   _dbus_assert (length >= 0);
 591
 592   return set_length (real, length);
 593 }
 594
 595 /**
 596  * Align the length of a string to a specific alignment (typically 4 or 8)
 597  * by appending nul bytes to the string.
 598  *
 599  * @param str a string
 600  * @param alignment the alignment
 601  * @returns #FALSE if no memory
 602  */
 603 dbus_bool_t
 604 _dbus_string_align_length (DBusString *str,
 605                            int         alignment)
 606 {
 607   int new_len;
 608   int delta;
 609   DBUS_STRING_PREAMBLE (str);
 610   _dbus_assert (alignment >= 1);
 611   _dbus_assert (alignment <= 16); /* arbitrary */
 612
 613   new_len = _DBUS_ALIGN_VALUE (real->len, alignment);
 614
 615   delta = new_len - real->len;
 616   _dbus_assert (delta >= 0);
 617
 618   if (delta == 0)
 619     return TRUE;
 620
 621   if (!set_length (real, new_len))
 622     return FALSE;
 623
 624   memset (real->str + (new_len - delta),
 625           '\0', delta);
 626
 627   return TRUE;
 628 }
 629
 630 static dbus_bool_t
 631 append (DBusRealString *real,
 632         const char     *buffer,
 633         int             buffer_len)
 634 {
 635   if (buffer_len == 0)
 636     return TRUE;
 637
 638   if (!_dbus_string_lengthen ((DBusString*)real, buffer_len))
 639     return FALSE;
 640
 641   memcpy (real->str + (real->len - buffer_len),
 642           buffer,
 643           buffer_len);
 644
 645   return TRUE;
 646 }
 647
 648 /**
 649  * Appends a nul-terminated C-style string to a DBusString.
 650  *
 651  * @param str the DBusString
 652  * @param buffer the nul-terminated characters to append
 653  * @returns #FALSE if not enough memory.
 654  */
 655 dbus_bool_t
 656 _dbus_string_append (DBusString *str,
 657                      const char *buffer)
 658 {
 659   int buffer_len;
 660
 661   DBUS_STRING_PREAMBLE (str);
 662   _dbus_assert (buffer != NULL);
 663
 664   buffer_len = strlen (buffer);
 665
 666   return append (real, buffer, buffer_len);
 667 }
 668
 669 /**
 670  * Appends block of bytes with the given length to a DBusString.
 671  *
 672  * @param str the DBusString
 673  * @param buffer the bytes to append
 674  * @param len the number of bytes to append
 675  * @returns #FALSE if not enough memory.
 676  */
 677 dbus_bool_t
 678 _dbus_string_append_len (DBusString *str,
 679                          const char *buffer,
 680                          int         len)
 681 {
 682   DBUS_STRING_PREAMBLE (str);
 683   _dbus_assert (buffer != NULL);
 684   _dbus_assert (len >= 0);
 685
 686   return append (real, buffer, len);
 687 }
 688
 689 /**
 690  * Appends a single byte to the string, returning #FALSE
 691  * if not enough memory.
 692  *
 693  * @param str the string
 694  * @param byte the byte to append
 695  * @returns #TRUE on success
 696  */
 697 dbus_bool_t
 698 _dbus_string_append_byte (DBusString    *str,
 699                           unsigned char  byte)
 700 {
 701   DBUS_STRING_PREAMBLE (str);
 702
 703   if (!set_length (real, real->len + 1))
 704     return FALSE;
 705
 706   real->str[real->len-1] = byte;
 707
 708   return TRUE;
 709 }
 710
 711 /**
 712  * Appends a single Unicode character, encoding the character
 713  * in UTF-8 format.
 714  *
 715  * @param str the string
 716  * @param ch the Unicode character
 717  */
 718 dbus_bool_t
 719 _dbus_string_append_unichar (DBusString    *str,
 720                              dbus_unichar_t ch)
 721 {
 722   int len;
 723   int first;
 724   int i;
 725   char *out;
 726
 727   DBUS_STRING_PREAMBLE (str);
 728
 729   /* this code is from GLib but is pretty standard I think */
 730
 731   len = 0;
 732
 733   if (ch < 0x80)
 734     {
 735       first = 0;
 736       len = 1;
 737     }
 738   else if (ch < 0x800)
 739     {
 740       first = 0xc0;
 741       len = 2;
 742     }
 743   else if (ch < 0x10000)
 744     {
 745       first = 0xe0;
 746       len = 3;
 747     }
 748    else if (ch < 0x200000)
 749     {
 750       first = 0xf0;
 751       len = 4;
 752     }
 753   else if (ch < 0x4000000)
 754     {
 755       first = 0xf8;
 756       len = 5;
 757     }
 758   else
 759     {
 760       first = 0xfc;
 761       len = 6;
 762     }
 763
 764   if (!set_length (real, real->len + len))
 765     return FALSE;
 766
 767   out = real->str + (real->len - len);
 768
 769   for (i = len - 1; i > 0; --i)
 770     {
 771       out[i] = (ch & 0x3f) | 0x80;
 772       ch >>= 6;
 773     }
 774   out[0] = ch | first;
 775
 776   return TRUE;
 777 }
 778
 779 static void
 780 delete (DBusRealString *real,
 781         int             start,
 782         int             len)
 783 {
 784   if (len == 0)
 785     return;
 786
 787   memmove (real->str + start, real->str + start + len, real->len - (start + len));
 788   real->len -= len;
 789   real->str[real->len] = '\0';
 790 }
 791
 792 /**
 793  * Deletes a segment of a DBusString with length len starting at
 794  * start. (Hint: to clear an entire string, setting length to 0
 795  * with _dbus_string_set_length() is easier.)
 796  *
 797  * @param str the DBusString
 798  * @param start where to start deleting
 799  * @param len the number of bytes to delete
 800  */
 801 void
 802 _dbus_string_delete (DBusString       *str,
 803                      int               start,
 804                      int               len)
 805 {
 806   DBUS_STRING_PREAMBLE (str);
 807   _dbus_assert (start >= 0);
 808   _dbus_assert (len >= 0);
 809   _dbus_assert ((start + len) <= real->len);
 810
 811   delete (real, start, len);
 812 }
 813
 814 static dbus_bool_t
 815 open_gap (int             len,
 816           DBusRealString *dest,
 817           int             insert_at)
 818 {
 819   if (len == 0)
 820     return TRUE;
 821
 822   if (!set_length (dest, dest->len + len))
 823     return FALSE;
 824
 825   memmove (dest->str + insert_at + len,
 826            dest->str + insert_at,
 827            dest->len - len - insert_at);
 828
 829   return TRUE;
 830 }
 831
 832 static dbus_bool_t
 833 copy (DBusRealString *source,
 834       int             start,
 835       int             len,
 836       DBusRealString *dest,
 837       int             insert_at)
 838 {
 839   if (len == 0)
 840     return TRUE;
 841
 842   if (!open_gap (len, dest, insert_at))
 843     return FALSE;
 844
 845   memcpy (dest->str + insert_at,
 846           source->str + start,
 847           len);
 848
 849   return TRUE;
 850 }
 851
 852 /**
 853  * Checks assertions for two strings we're copying a segment between,
 854  * and declares real_source/real_dest variables.
 855  *
 856  * @param source the source string
 857  * @param start the starting offset
 858  * @param dest the dest string
 859  * @param insert_at where the copied segment is inserted
 860  */
 861 #define DBUS_STRING_COPY_PREAMBLE(source, start, dest, insert_at)       \
 862   DBusRealString *real_source = (DBusRealString*) source;               \
 863   DBusRealString *real_dest = (DBusRealString*) dest;                   \
 864   _dbus_assert ((source) != (dest));                                    \
 865   DBUS_GENERIC_STRING_PREAMBLE (real_source);                           \
 866   DBUS_GENERIC_STRING_PREAMBLE (real_dest);                             \
 867   _dbus_assert (!real_source->constant);                                \
 868   _dbus_assert (!real_source->locked);                                  \
 869   _dbus_assert (!real_dest->constant);                                  \
 870   _dbus_assert (!real_dest->locked);                                    \
 871   _dbus_assert ((start) >= 0);                                          \
 872   _dbus_assert ((start) <= real_source->len);                           \
 873   _dbus_assert ((insert_at) >= 0);                                      \
 874   _dbus_assert ((insert_at) <= real_dest->len)
 875
 876 /**
 877  * Moves the end of one string into another string. Both strings
 878  * must be initialized, valid strings.
 879  *
 880  * @param source the source string
 881  * @param start where to chop off the source string
 882  * @param dest the destination string
 883  * @param insert_at where to move the chopped-off part of source string
 884  * @returns #FALSE if not enough memory
 885  */
 886 dbus_bool_t
 887 _dbus_string_move (DBusString       *source,
 888                    int               start,
 889                    DBusString       *dest,
 890                    int               insert_at)
 891 {
 892   DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
 893
 894   if (!copy (real_source, start,
 895              real_source->len - start,
 896              real_dest,
 897              insert_at))
 898     return FALSE;
 899
 900   delete (real_source, start,
 901           real_source->len - start);
 902
 903   return TRUE;
 904 }
 905
 906 /**
 907  * Like _dbus_string_move(), but does not delete the section
 908  * of the source string that's copied to the dest string.
 909  *
 910  * @param source the source string
 911  * @param start where to start copying the source string
 912  * @param dest the destination string
 913  * @param insert_at where to place the copied part of source string
 914  * @returns #FALSE if not enough memory
 915  */
 916 dbus_bool_t
 917 _dbus_string_copy (const DBusString *source,
 918                    int               start,
 919                    DBusString       *dest,
 920                    int               insert_at)
 921 {
 922   DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
 923
 924   return copy (real_source, start,
 925                real_source->len - start,
 926                real_dest,
 927                insert_at);
 928 }
 929
 930 /**
 931  * Like _dbus_string_move(), but can move a segment from
 932  * the middle of the source string.
 933  *
 934  * @param source the source string
 935  * @param start first byte of source string to move
 936  * @param len length of segment to move
 937  * @param dest the destination string
 938  * @param insert_at where to move the bytes from the source string
 939  * @returns #FALSE if not enough memory
 940  */
 941 dbus_bool_t
 942 _dbus_string_move_len (DBusString       *source,
 943                        int               start,
 944                        int               len,
 945                        DBusString       *dest,
 946                        int               insert_at)
 947
 948 {
 949   DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
 950   _dbus_assert (len >= 0);
 951   _dbus_assert ((start + len) <= real_source->len);
 952
 953   if (!copy (real_source, start, len,
 954              real_dest,
 955              insert_at))
 956     return FALSE;
 957
 958   delete (real_source, start,
 959           len);
 960
 961   return TRUE;
 962 }
 963
 964 /**
 965  * Like _dbus_string_copy(), but can copy a segment from the middle of
 966  * the source string.
 967  *
 968  * @param source the source string
 969  * @param start where to start copying the source string
 970  * @param len length of segment to copy
 971  * @param dest the destination string
 972  * @param insert_at where to place the copied segment of source string
 973  * @returns #FALSE if not enough memory
 974  */
 975 dbus_bool_t
 976 _dbus_string_copy_len (const DBusString *source,
 977                        int               start,
 978                        int               len,
 979                        DBusString       *dest,
 980                        int               insert_at)
 981 {
 982   DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
 983   _dbus_assert (len >= 0);
 984   _dbus_assert ((start + len) <= real_source->len);
 985
 986   return copy (real_source, start, len,
 987                real_dest,
 988                insert_at);
 989 }
 990
 991 /**
 992  * Replaces a segment of dest string with a segment of source string.
 993  *
 994  * @todo optimize the case where the two lengths are the same, and
 995  * avoid memmoving the data in the trailing part of the string twice.
 996  *
 997  * @param source the source string
 998  * @param start where to start copying the source string
 999  * @param len length of segment to copy
1000  * @param dest the destination string
1001  * @param replace_at start of segment of dest string to replace
1002  * @param replace_len length of segment of dest string to replace
1003  * @returns #FALSE if not enough memory
1004  *
1005  */
1006 dbus_bool_t
1007 _dbus_string_replace_len (const DBusString *source,
1008                           int               start,
1009                           int               len,
1010                           DBusString       *dest,
1011                           int               replace_at,
1012                           int               replace_len)
1013 {
1014   DBUS_STRING_COPY_PREAMBLE (source, start, dest, replace_at);
1015   _dbus_assert (len >= 0);
1016   _dbus_assert ((start + len) <= real_source->len);
1017   _dbus_assert (replace_at >= 0);
1018   _dbus_assert ((replace_at + replace_len) <= real_dest->len);
1019
1020   if (!copy (real_source, start, len,
1021              real_dest, replace_at))
1022     return FALSE;
1023
1024   delete (real_dest, replace_at + len, replace_len);
1025
1026   return TRUE;
1027 }
1028
1029 /* Unicode macros from GLib */
1030
1031 /** computes length and mask of a unicode character
1032  * @param Char the char
1033  * @param Mask the mask variable to assign to
1034  * @param Len the length variable to assign to
1035  */
1036 #define UTF8_COMPUTE(Char, Mask, Len)                                         \
1037   if (Char < 128)                                                             \
1038     {                                                                         \
1039       Len = 1;                                                                \
1040       Mask = 0x7f;                                                            \
1041     }                                                                         \
1042   else if ((Char & 0xe0) == 0xc0)                                             \
1043     {                                                                         \
1044       Len = 2;                                                                \
1045       Mask = 0x1f;                                                            \
1046     }                                                                         \
1047   else if ((Char & 0xf0) == 0xe0)                                             \
1048     {                                                                         \
1049       Len = 3;                                                                \
1050       Mask = 0x0f;                                                            \
1051     }                                                                         \
1052   else if ((Char & 0xf8) == 0xf0)                                             \
1053     {                                                                         \
1054       Len = 4;                                                                \
1055       Mask = 0x07;                                                            \
1056     }                                                                         \
1057   else if ((Char & 0xfc) == 0xf8)                                             \
1058     {                                                                         \
1059       Len = 5;                                                                \
1060       Mask = 0x03;                                                            \
1061     }                                                                         \
1062   else if ((Char & 0xfe) == 0xfc)                                             \
1063     {                                                                         \
1064       Len = 6;                                                                \
1065       Mask = 0x01;                                                            \
1066     }                                                                         \
1067   else                                                                        \
1068     Len = -1;
1069
1070 /**
1071  * computes length of a unicode character in UTF-8
1072  * @param Char the char
1073  */
1074 #define UTF8_LENGTH(Char)              \
1075   ((Char) < 0x80 ? 1 :                 \
1076    ((Char) < 0x800 ? 2 :               \
1077     ((Char) < 0x10000 ? 3 :            \
1078      ((Char) < 0x200000 ? 4 :          \
1079       ((Char) < 0x4000000 ? 5 : 6)))))
1080
1081 /**
1082  * Gets a UTF-8 value.
1083  *
1084  * @param Result variable for extracted unicode char.
1085  * @param Chars the bytes to decode
1086  * @param Count counter variable
1087  * @param Mask mask for this char
1088  * @param Len length for this char in bytes
1089  */
1090 #define UTF8_GET(Result, Chars, Count, Mask, Len)                             \
1091   (Result) = (Chars)[0] & (Mask);                                             \
1092   for ((Count) = 1; (Count) < (Len); ++(Count))                               \
1093     {                                                                         \
1094       if (((Chars)[(Count)] & 0xc0) != 0x80)                                  \
1095         {                                                                     \
1096           (Result) = -1;                                                      \
1097           break;                                                              \
1098         }                                                                     \
1099       (Result) <<= 6;                                                         \
1100       (Result) |= ((Chars)[(Count)] & 0x3f);                                  \
1101     }
1102
1103 /**
1104  * Check whether a unicode char is in a valid range.
1105  *
1106  * @param Char the character
1107  */
1108 #define UNICODE_VALID(Char)                   \
1109     ((Char) < 0x110000 &&                     \
1110      ((Char) < 0xD800 || (Char) >= 0xE000) && \
1111      (Char) != 0xFFFE && (Char) != 0xFFFF)
1112
1113 /**
1114  * Gets a unicode character from a UTF-8 string. Does no validation;
1115  * you must verify that the string is valid UTF-8 in advance and must
1116  * pass in the start of a character.
1117  *
1118  * @param str the string
1119  * @param start the start of the UTF-8 character.
1120  * @param ch_return location to return the character
1121  * @param end_return location to return the byte index of next character
1122  * @returns #TRUE on success, #FALSE otherwise.
1123  */
1124 void
1125 _dbus_string_get_unichar (const DBusString *str,
1126                           int               start,
1127                           dbus_unichar_t   *ch_return,
1128                           int              *end_return)
1129 {
1130   int i, mask, len;
1131   dbus_unichar_t result;
1132   unsigned char c;
1133   unsigned char *p;
1134   DBUS_CONST_STRING_PREAMBLE (str);
1135
1136   if (ch_return)
1137     *ch_return = 0;
1138   if (end_return)
1139     *end_return = real->len;
1140
1141   mask = 0;
1142   p = real->str + start;
1143   c = *p;
1144
1145   UTF8_COMPUTE (c, mask, len);
1146   if (len == -1)
1147     return;
1148   UTF8_GET (result, p, i, mask, len);
1149
1150   if (result == (dbus_unichar_t)-1)
1151     return;
1152
1153   if (ch_return)
1154     *ch_return = result;
1155   if (end_return)
1156     *end_return = start + len;
1157 }
1158
1159 /**
1160  * Finds the given substring in the string,
1161  * returning #TRUE and filling in the byte index
1162  * where the substring was found, if it was found.
1163  * Returns #FALSE if the substring wasn't found.
1164  * Sets *start to the length of the string if the substring
1165  * is not found.
1166  *
1167  * @param str the string
1168  * @param start where to start looking
1169  * @param substr the substring
1170  * @param found return location for where it was found, or #NULL
1171  * @returns #TRUE if found
1172  */
1173 dbus_bool_t
1174 _dbus_string_find (const DBusString *str,
1175                    int               start,
1176                    const char       *substr,
1177                    int              *found)
1178 {
1179   int i;
1180   DBUS_CONST_STRING_PREAMBLE (str);
1181   _dbus_assert (substr != NULL);
1182   _dbus_assert (start <= real->len);
1183
1184   /* we always "find" an empty string */
1185   if (*substr == '\0')
1186     {
1187       if (found)
1188         *found = 0;
1189       return TRUE;
1190     }
1191
1192   i = start;
1193   while (i < real->len)
1194     {
1195       if (real->str[i] == substr[0])
1196         {
1197           int j = i + 1;
1198
1199           while (j < real->len)
1200             {
1201               if (substr[j - i] == '\0')
1202                 break;
1203               else if (real->str[j] != substr[j - i])
1204                 break;
1205
1206               ++j;
1207             }
1208
1209           if (substr[j - i] == '\0')
1210             {
1211               if (found)
1212                 *found = i;
1213               return TRUE;
1214             }
1215         }
1216
1217       ++i;
1218     }
1219
1220   if (found)
1221     *found = real->len;
1222
1223   return FALSE;
1224 }
1225
1226 /**
1227  * Finds a blank (space or tab) in the string. Returns #TRUE
1228  * if found, #FALSE otherwise. If a blank is not found sets
1229  * *found to the length of the string.
1230  *
1231  * @param str the string
1232  * @param start byte index to start looking
1233  * @param found place to store the location of the first blank
1234  * @returns #TRUE if a blank was found
1235  */
1236 dbus_bool_t
1237 _dbus_string_find_blank (const DBusString *str,
1238                          int               start,
1239                          int              *found)
1240 {
1241   int i;
1242   DBUS_CONST_STRING_PREAMBLE (str);
1243   _dbus_assert (start <= real->len);
1244
1245   i = start;
1246   while (i < real->len)
1247     {
1248       if (real->str[i] == ' ' ||
1249           real->str[i] == '\t')
1250         {
1251           if (found)
1252             *found = i;
1253           return TRUE;
1254         }
1255
1256       ++i;
1257     }
1258
1259   if (found)
1260     *found = real->len;
1261
1262   return FALSE;
1263 }
1264
1265 /**
1266  * Skips blanks from start, storing the first non-blank in *end
1267  *
1268  * @param str the string
1269  * @param start where to start
1270  * @param end where to store the first non-blank byte index
1271  */
1272 void
1273 _dbus_string_skip_blank (const DBusString *str,
1274                          int               start,
1275                          int              *end)
1276 {
1277   int i;
1278   DBUS_CONST_STRING_PREAMBLE (str);
1279   _dbus_assert (start <= real->len);
1280
1281   i = start;
1282   while (i < real->len)
1283     {
1284       if (!(real->str[i] == ' ' ||
1285             real->str[i] == '\t'))
1286         break;
1287
1288       ++i;
1289     }
1290
1291   _dbus_assert (i == real->len || !(real->str[i] == ' ' ||
1292                                     real->str[i] == '\t'));
1293
1294   if (end)
1295     *end = i;
1296 }
1297
1298 /**
1299  * Tests two DBusString for equality.
1300  *
1301  * @param a first string
1302  * @param b second string
1303  * @returns #TRUE if equal
1304  */
1305 dbus_bool_t
1306 _dbus_string_equal (const DBusString *a,
1307                     const DBusString *b)
1308 {
1309   const unsigned char *ap;
1310   const unsigned char *bp;
1311   const unsigned char *a_end;
1312   const DBusRealString *real_a = (const DBusRealString*) a;
1313   const DBusRealString *real_b = (const DBusRealString*) b;
1314   DBUS_GENERIC_STRING_PREAMBLE (real_a);
1315   DBUS_GENERIC_STRING_PREAMBLE (real_b);
1316
1317   if (real_a->len != real_b->len)
1318     return FALSE;
1319
1320   ap = real_a->str;
1321   bp = real_b->str;
1322   a_end = real_a->str + real_a->len;
1323   while (ap != a_end)
1324     {
1325       if (*ap != *bp)
1326         return FALSE;
1327
1328       ++ap;
1329       ++bp;
1330     }
1331
1332   return TRUE;
1333 }
1334
1335 /**
1336  * Checks whether a string is equal to a C string.
1337  *
1338  * @param a the string
1339  * @param c_str the C string
1340  * @returns #TRUE if equal
1341  */
1342 dbus_bool_t
1343 _dbus_string_equal_c_str (const DBusString *a,
1344                           const char       *c_str)
1345 {
1346   const unsigned char *ap;
1347   const unsigned char *bp;
1348   const unsigned char *a_end;
1349   const DBusRealString *real_a = (const DBusRealString*) a;
1350   DBUS_GENERIC_STRING_PREAMBLE (real_a);
1351
1352   ap = real_a->str;
1353   bp = (const unsigned char*) c_str;
1354   a_end = real_a->str + real_a->len;
1355   while (ap != a_end && *bp)
1356     {
1357       if (*ap != *bp)
1358         return FALSE;
1359
1360       ++ap;
1361       ++bp;
1362     }
1363
1364   if (*ap && *bp == '\0')
1365     return FALSE;
1366   else if (ap == a_end && *bp)
1367     return FALSE;
1368
1369   return TRUE;
1370 }
1371
1372 static const signed char base64_table[] = {
1373   /* 0 */ 'A',
1374   /* 1 */ 'B',
1375   /* 2 */ 'C',
1376   /* 3 */ 'D',
1377   /* 4 */ 'E',
1378   /* 5 */ 'F',
1379   /* 6 */ 'G',
1380   /* 7 */ 'H',
1381   /* 8 */ 'I',
1382   /* 9 */ 'J',
1383   /* 10 */ 'K',
1384   /* 11 */ 'L',
1385   /* 12 */ 'M',
1386   /* 13 */ 'N',
1387   /* 14 */ 'O',
1388   /* 15 */ 'P',
1389   /* 16 */ 'Q',
1390   /* 17 */ 'R',
1391   /* 18 */ 'S',
1392   /* 19 */ 'T',
1393   /* 20 */ 'U',
1394   /* 21 */ 'V',
1395   /* 22 */ 'W',
1396   /* 23 */ 'X',
1397   /* 24 */ 'Y',
1398   /* 25 */ 'Z',
1399   /* 26 */ 'a',
1400   /* 27 */ 'b',
1401   /* 28 */ 'c',
1402   /* 29 */ 'd',
1403   /* 30 */ 'e',
1404   /* 31 */ 'f',
1405   /* 32 */ 'g',
1406   /* 33 */ 'h',
1407   /* 34 */ 'i',
1408   /* 35 */ 'j',
1409   /* 36 */ 'k',
1410   /* 37 */ 'l',
1411   /* 38 */ 'm',
1412   /* 39 */ 'n',
1413   /* 40 */ 'o',
1414   /* 41 */ 'p',
1415   /* 42 */ 'q',
1416   /* 43 */ 'r',
1417   /* 44 */ 's',
1418   /* 45 */ 't',
1419   /* 46 */ 'u',
1420   /* 47 */ 'v',
1421   /* 48 */ 'w',
1422   /* 49 */ 'x',
1423   /* 50 */ 'y',
1424   /* 51 */ 'z',
1425   /* 52 */ '0',
1426   /* 53 */ '1',
1427   /* 54 */ '2',
1428   /* 55 */ '3',
1429   /* 56 */ '4',
1430   /* 57 */ '5',
1431   /* 58 */ '6',
1432   /* 59 */ '7',
1433   /* 60 */ '8',
1434   /* 61 */ '9',
1435   /* 62 */ '+',
1436   /* 63 */ '/'
1437 };
1438
1439 /** The minimum char that's a valid char in Base64-encoded text */
1440 #define UNBASE64_MIN_CHAR (43)
1441 /** The maximum char that's a valid char in Base64-encoded text */
1442 #define UNBASE64_MAX_CHAR (122)
1443 /** Must subtract this from a char's integer value before offsetting
1444  * into unbase64_table
1445  */
1446 #define UNBASE64_TABLE_OFFSET UNBASE64_MIN_CHAR
1447 static const signed char unbase64_table[] = {
1448   /* 43 + */ 62,
1449   /* 44 , */ -1,
1450   /* 45 - */ -1,
1451   /* 46 . */ -1,
1452   /* 47 / */ 63,
1453   /* 48 0 */ 52,
1454   /* 49 1 */ 53,
1455   /* 50 2 */ 54,
1456   /* 51 3 */ 55,
1457   /* 52 4 */ 56,
1458   /* 53 5 */ 57,
1459   /* 54 6 */ 58,
1460   /* 55 7 */ 59,
1461   /* 56 8 */ 60,
1462   /* 57 9 */ 61,
1463   /* 58 : */ -1,
1464   /* 59 ; */ -1,
1465   /* 60 < */ -1,
1466   /* 61 = */ -1,
1467   /* 62 > */ -1,
1468   /* 63 ? */ -1,
1469   /* 64 @ */ -1,
1470   /* 65 A */ 0,
1471   /* 66 B */ 1,
1472   /* 67 C */ 2,
1473   /* 68 D */ 3,
1474   /* 69 E */ 4,
1475   /* 70 F */ 5,
1476   /* 71 G */ 6,
1477   /* 72 H */ 7,
1478   /* 73 I */ 8,
1479   /* 74 J */ 9,
1480   /* 75 K */ 10,
1481   /* 76 L */ 11,
1482   /* 77 M */ 12,
1483   /* 78 N */ 13,
1484   /* 79 O */ 14,
1485   /* 80 P */ 15,
1486   /* 81 Q */ 16,
1487   /* 82 R */ 17,
1488   /* 83 S */ 18,
1489   /* 84 T */ 19,
1490   /* 85 U */ 20,
1491   /* 86 V */ 21,
1492   /* 87 W */ 22,
1493   /* 88 X */ 23,
1494   /* 89 Y */ 24,
1495   /* 90 Z */ 25,
1496   /* 91 [ */ -1,
1497   /* 92 \ */ -1,
1498   /* 93 ] */ -1,
1499   /* 94 ^ */ -1,
1500   /* 95 _ */ -1,
1501   /* 96 ` */ -1,
1502   /* 97 a */ 26,
1503   /* 98 b */ 27,
1504   /* 99 c */ 28,
1505   /* 100 d */ 29,
1506   /* 101 e */ 30,
1507   /* 102 f */ 31,
1508   /* 103 g */ 32,
1509   /* 104 h */ 33,
1510   /* 105 i */ 34,
1511   /* 106 j */ 35,
1512   /* 107 k */ 36,
1513   /* 108 l */ 37,
1514   /* 109 m */ 38,
1515   /* 110 n */ 39,
1516   /* 111 o */ 40,
1517   /* 112 p */ 41,
1518   /* 113 q */ 42,
1519   /* 114 r */ 43,
1520   /* 115 s */ 44,
1521   /* 116 t */ 45,
1522   /* 117 u */ 46,
1523   /* 118 v */ 47,
1524   /* 119 w */ 48,
1525   /* 120 x */ 49,
1526   /* 121 y */ 50,
1527   /* 122 z */ 51
1528 };
1529
1530 /**
1531  * Encodes a string using Base64, as documented in RFC 2045.
1532  *
1533  * @param source the string to encode
1534  * @param start byte index to start encoding
1535  * @param dest string where encoded data should be placed
1536  * @param insert_at where to place encoded data
1537  * @returns #TRUE if encoding was successful, #FALSE if no memory etc.
1538  */
1539 dbus_bool_t
1540 _dbus_string_base64_encode (const DBusString *source,
1541                             int               start,
1542                             DBusString       *dest,
1543                             int               insert_at)
1544 {
1545   int source_len;
1546   int dest_len;
1547   const unsigned char *s;
1548   unsigned char *d;
1549   const unsigned char *triplet_end;
1550   const unsigned char *final_end;
1551   DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1552   _dbus_assert (source != dest);
1553
1554   /* For each 24 bits (3 bytes) of input, we have 4 chars of
1555    * output.
1556    */
1557   source_len = real_source->len - start;
1558   dest_len = (source_len / 3) * 4;
1559   if (source_len % 3 != 0)
1560     dest_len += 4;
1561
1562   if (source_len == 0)
1563     return TRUE;
1564
1565   if (!open_gap (dest_len, real_dest, insert_at))
1566     return FALSE;
1567
1568   d = real_dest->str + insert_at;
1569   s = real_source->str + start;
1570   final_end = real_source->str + (start + source_len);
1571   triplet_end = final_end - (source_len % 3);
1572   _dbus_assert (triplet_end <= final_end);
1573   _dbus_assert ((final_end - triplet_end) < 3);
1574
1575 #define ENCODE_64(v) (base64_table[ (unsigned char) (v) ])
1576 #define SIX_BITS_MASK (0x3f)
1577   _dbus_assert (SIX_BITS_MASK < _DBUS_N_ELEMENTS (base64_table));
1578
1579   while (s != triplet_end)
1580     {
1581       unsigned int triplet;
1582
1583       triplet = s[0] | (s[1] << 8) | (s[2] << 16);
1584
1585       /* Encode each 6 bits */
1586
1587       *d++ = ENCODE_64 (triplet >> 18);
1588       *d++ = ENCODE_64 ((triplet >> 12) & SIX_BITS_MASK);
1589       *d++ = ENCODE_64 ((triplet >> 6) & SIX_BITS_MASK);
1590       *d++ = ENCODE_64 (triplet & SIX_BITS_MASK);
1591
1592       s += 3;
1593     }
1594
1595   switch (final_end - triplet_end)
1596     {
1597     case 2:
1598       {
1599         unsigned int doublet;
1600
1601         doublet = s[0] | (s[1] << 8);
1602
1603         *d++ = ENCODE_64 (doublet >> 12);
1604         *d++ = ENCODE_64 ((doublet >> 6) & SIX_BITS_MASK);
1605         *d++ = ENCODE_64 (doublet & SIX_BITS_MASK);
1606         *d++ = '=';
1607       }
1608       break;
1609     case 1:
1610       {
1611         unsigned int singlet;
1612
1613         singlet = s[0];
1614
1615         *d++ = ENCODE_64 ((singlet >> 6) & SIX_BITS_MASK);
1616         *d++ = ENCODE_64 (singlet & SIX_BITS_MASK);
1617         *d++ = '=';
1618         *d++ = '=';
1619       }
1620       break;
1621     case 0:
1622       break;
1623     }
1624
1625   _dbus_assert (d == (real_dest->str + (insert_at + dest_len)));
1626
1627   return TRUE;
1628 }
1629
1630
1631 /**
1632  * Decodes a string from Base64, as documented in RFC 2045.
1633  *
1634  * @param source the string to decode
1635  * @param start byte index to start decode
1636  * @param dest string where decoded data should be placed
1637  * @param insert_at where to place decoded data
1638  * @returns #TRUE if decoding was successful, #FALSE if no memory etc.
1639  */
1640 dbus_bool_t
1641 _dbus_string_base64_decode (const DBusString *source,
1642                             int               start,
1643                             DBusString       *dest,
1644                             int               insert_at)
1645 {
1646   int source_len;
1647   const char *s;
1648   const char *end;
1649   DBusString result;
1650   unsigned int triplet = 0;
1651   int sextet_count;
1652   int pad_count;
1653   DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1654   _dbus_assert (source != dest);
1655
1656   source_len = real_source->len - start;
1657   s = real_source->str + start;
1658   end = real_source->str + source_len;
1659
1660   if (source_len == 0)
1661     return TRUE;
1662
1663   if (!_dbus_string_init (&result, _DBUS_INT_MAX))
1664     return FALSE;
1665
1666   pad_count = 0;
1667   sextet_count = 0;
1668   while (s != end)
1669     {
1670       /* The idea is to just skip anything that isn't
1671        * a base64 char - it's allowed to have whitespace,
1672        * newlines, etc. in here. We also ignore trailing
1673        * base64 chars, though that's suspicious.
1674        */
1675
1676       if (*s >= UNBASE64_MIN_CHAR &&
1677           *s <= UNBASE64_MAX_CHAR)
1678         {
1679           if (*s == '=')
1680             {
1681               /* '=' is padding, doesn't represent additional data
1682                * but does increment our count.
1683                */
1684               pad_count += 1;
1685               sextet_count += 1;
1686             }
1687           else
1688             {
1689               int val;
1690
1691               val = unbase64_table[(*s) - UNBASE64_TABLE_OFFSET];
1692
1693               if (val >= 0)
1694                 {
1695                   triplet <<= 6;
1696                   triplet |= (unsigned int) val;
1697                   sextet_count += 1;
1698                 }
1699             }
1700
1701           if (sextet_count == 4)
1702             {
1703               /* no pad = 3 bytes, 1 pad = 2 bytes, 2 pad = 1 byte */
1704
1705               _dbus_string_append_byte (&result,
1706                                         triplet & 0xff);
1707
1708               if (pad_count < 2)
1709                 _dbus_string_append_byte (&result,
1710                                           (triplet >> 8) & 0xff);
1711
1712               if (pad_count < 1)
1713                 _dbus_string_append_byte (&result,
1714                                           triplet >> 16);
1715
1716               sextet_count = 0;
1717               pad_count = 0;
1718               triplet = 0;
1719             }
1720         }
1721
1722       ++s;
1723     }
1724
1725   if (!_dbus_string_move (&result, 0, dest, insert_at))
1726     {
1727       _dbus_string_free (&result);
1728       return FALSE;
1729     }
1730
1731   _dbus_string_free (&result);
1732
1733   return TRUE;
1734 }
1735
1736 /**
1737  * Checks that the given range of the string
1738  * is valid ASCII. If the given range is not contained
1739  * in the string, returns #FALSE.
1740  *
1741  * @param str the string
1742  * @param start first byte index to check
1743  * @param len number of bytes to check
1744  * @returns #TRUE if the byte range exists and is all valid ASCII
1745  */
1746 dbus_bool_t
1747 _dbus_string_validate_ascii (const DBusString *str,
1748                              int               start,
1749                              int               len)
1750 {
1751   const unsigned char *s;
1752   const unsigned char *end;
1753   DBUS_CONST_STRING_PREAMBLE (str);
1754   _dbus_assert (start >= 0);
1755   _dbus_assert (len >= 0);
1756
1757   if ((start + len) > real->len)
1758     return FALSE;
1759
1760   s = real->str + start;
1761   end = s + len;
1762   while (s != end)
1763     {
1764       if (*s == '\0' ||
1765           ((*s & ~0x7f) != 0))
1766         return FALSE;
1767
1768       ++s;
1769     }
1770
1771   return TRUE;
1772 }
1773
1774 /** @} */
1775
1776 #ifdef DBUS_BUILD_TESTS
1777 #include "dbus-test.h"
1778 #include <stdio.h>
1779
1780 static void
1781 test_max_len (DBusString *str,
1782               int         max_len)
1783 {
1784   if (max_len > 0)
1785     {
1786       if (!_dbus_string_set_length (str, max_len - 1))
1787         _dbus_assert_not_reached ("setting len to one less than max should have worked");
1788     }
1789
1790   if (!_dbus_string_set_length (str, max_len))
1791     _dbus_assert_not_reached ("setting len to max len should have worked");
1792
1793   if (_dbus_string_set_length (str, max_len + 1))
1794     _dbus_assert_not_reached ("setting len to one more than max len should not have worked");
1795
1796   if (!_dbus_string_set_length (str, 0))
1797     _dbus_assert_not_reached ("setting len to zero should have worked");
1798 }
1799
1800 static void
1801 test_base64_roundtrip (const unsigned char *data,
1802                        int                  len)
1803 {
1804   DBusString orig;
1805   DBusString encoded;
1806   DBusString decoded;
1807
1808   if (len < 0)
1809     len = strlen (data);
1810
1811   if (!_dbus_string_init (&orig, _DBUS_INT_MAX))
1812     _dbus_assert_not_reached ("could not init string");
1813
1814   if (!_dbus_string_init (&encoded, _DBUS_INT_MAX))
1815     _dbus_assert_not_reached ("could not init string");
1816
1817   if (!_dbus_string_init (&decoded, _DBUS_INT_MAX))
1818     _dbus_assert_not_reached ("could not init string");
1819
1820   if (!_dbus_string_append_len (&orig, data, len))
1821     _dbus_assert_not_reached ("couldn't append orig data");
1822
1823   if (!_dbus_string_base64_encode (&orig, 0, &encoded, 0))
1824     _dbus_assert_not_reached ("could not encode");
1825
1826   if (!_dbus_string_base64_decode (&encoded, 0, &decoded, 0))
1827     _dbus_assert_not_reached ("could not decode");
1828
1829   if (!_dbus_string_equal (&orig, &decoded))
1830     {
1831       const char *s;
1832
1833       printf ("Original string %d bytes encoded %d bytes decoded %d bytes\n",
1834               _dbus_string_get_length (&orig),
1835               _dbus_string_get_length (&encoded),
1836               _dbus_string_get_length (&decoded));
1837       printf ("Original: %s\n", data);
1838       _dbus_string_get_const_data (&decoded, &s);
1839       printf ("Decoded: %s\n", s);
1840       _dbus_assert_not_reached ("original string not the same as string decoded from base64");
1841     }
1842
1843   _dbus_string_free (&orig);
1844   _dbus_string_free (&encoded);
1845   _dbus_string_free (&decoded);
1846 }
1847
1848 /**
1849  * @ingroup DBusStringInternals
1850  * Unit test for DBusString.
1851  *
1852  * @todo Need to write tests for _dbus_string_copy() and
1853  * _dbus_string_move() moving to/from each of start/middle/end of a
1854  * string. Also need tests for _dbus_string_move_len ()
1855  *
1856  * @returns #TRUE on success.
1857  */
1858 dbus_bool_t
1859 _dbus_string_test (void)
1860 {
1861   DBusString str;
1862   DBusString other;
1863   int i, end;
1864   long v;
1865   double d;
1866   int lens[] = { 0, 1, 2, 3, 4, 5, 10, 16, 17, 18, 25, 31, 32, 33, 34, 35, 63, 64, 65, 66, 67, 68, 69, 70, 71, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136 };
1867   char *s;
1868   dbus_unichar_t ch;
1869
1870   i = 0;
1871   while (i < _DBUS_N_ELEMENTS (lens))
1872     {
1873       if (!_dbus_string_init (&str, lens[i]))
1874         _dbus_assert_not_reached ("failed to init string");
1875
1876       test_max_len (&str, lens[i]);
1877       _dbus_string_free (&str);
1878
1879       ++i;
1880     }
1881
1882   /* Test shortening and setting length */
1883   i = 0;
1884   while (i < _DBUS_N_ELEMENTS (lens))
1885     {
1886       int j;
1887
1888       if (!_dbus_string_init (&str, lens[i]))
1889         _dbus_assert_not_reached ("failed to init string");
1890
1891       if (!_dbus_string_set_length (&str, lens[i]))
1892         _dbus_assert_not_reached ("failed to set string length");
1893
1894       j = lens[i];
1895       while (j > 0)
1896         {
1897           _dbus_assert (_dbus_string_get_length (&str) == j);
1898           if (j > 0)
1899             {
1900               _dbus_string_shorten (&str, 1);
1901               _dbus_assert (_dbus_string_get_length (&str) == (j - 1));
1902             }
1903           --j;
1904         }
1905
1906       _dbus_string_free (&str);
1907
1908       ++i;
1909     }
1910
1911   /* Test appending data */
1912   if (!_dbus_string_init (&str, _DBUS_INT_MAX))
1913     _dbus_assert_not_reached ("failed to init string");
1914
1915   i = 0;
1916   while (i < 10)
1917     {
1918       if (!_dbus_string_append (&str, "a"))
1919         _dbus_assert_not_reached ("failed to append string to string\n");
1920
1921       _dbus_assert (_dbus_string_get_length (&str) == i * 2 + 1);
1922
1923       if (!_dbus_string_append_byte (&str, 'b'))
1924         _dbus_assert_not_reached ("failed to append byte to string\n");
1925
1926       _dbus_assert (_dbus_string_get_length (&str) == i * 2 + 2);
1927
1928       ++i;
1929     }
1930
1931   _dbus_string_free (&str);
1932
1933   /* Check steal_data */
1934
1935   if (!_dbus_string_init (&str, _DBUS_INT_MAX))
1936     _dbus_assert_not_reached ("failed to init string");
1937
1938   if (!_dbus_string_append (&str, "Hello World"))
1939     _dbus_assert_not_reached ("could not append to string");
1940
1941   i = _dbus_string_get_length (&str);
1942
1943   if (!_dbus_string_steal_data (&str, &s))
1944     _dbus_assert_not_reached ("failed to steal data");
1945
1946   _dbus_assert (_dbus_string_get_length (&str) == 0);
1947   _dbus_assert (((int)strlen (s)) == i);
1948
1949   dbus_free (s);
1950
1951   /* Check move */
1952
1953   if (!_dbus_string_append (&str, "Hello World"))
1954     _dbus_assert_not_reached ("could not append to string");
1955
1956   i = _dbus_string_get_length (&str);
1957
1958   if (!_dbus_string_init (&other, _DBUS_INT_MAX))
1959     _dbus_assert_not_reached ("could not init string");
1960
1961   if (!_dbus_string_move (&str, 0, &other, 0))
1962     _dbus_assert_not_reached ("could not move");
1963
1964   _dbus_assert (_dbus_string_get_length (&str) == 0);
1965   _dbus_assert (_dbus_string_get_length (&other) == i);
1966
1967   if (!_dbus_string_append (&str, "Hello World"))
1968     _dbus_assert_not_reached ("could not append to string");
1969
1970   if (!_dbus_string_move (&str, 0, &other, _dbus_string_get_length (&other)))
1971     _dbus_assert_not_reached ("could not move");
1972
1973   _dbus_assert (_dbus_string_get_length (&str) == 0);
1974   _dbus_assert (_dbus_string_get_length (&other) == i * 2);
1975
1976     if (!_dbus_string_append (&str, "Hello World"))
1977     _dbus_assert_not_reached ("could not append to string");
1978
1979   if (!_dbus_string_move (&str, 0, &other, _dbus_string_get_length (&other) / 2))
1980     _dbus_assert_not_reached ("could not move");
1981
1982   _dbus_assert (_dbus_string_get_length (&str) == 0);
1983   _dbus_assert (_dbus_string_get_length (&other) == i * 3);
1984
1985   _dbus_string_free (&other);
1986
1987   /* Check copy */
1988
1989   if (!_dbus_string_append (&str, "Hello World"))
1990     _dbus_assert_not_reached ("could not append to string");
1991
1992   i = _dbus_string_get_length (&str);
1993
1994   if (!_dbus_string_init (&other, _DBUS_INT_MAX))
1995     _dbus_assert_not_reached ("could not init string");
1996
1997   if (!_dbus_string_copy (&str, 0, &other, 0))
1998     _dbus_assert_not_reached ("could not copy");
1999
2000   _dbus_assert (_dbus_string_get_length (&str) == i);
2001   _dbus_assert (_dbus_string_get_length (&other) == i);
2002
2003   if (!_dbus_string_copy (&str, 0, &other, _dbus_string_get_length (&other)))
2004     _dbus_assert_not_reached ("could not copy");
2005
2006   _dbus_assert (_dbus_string_get_length (&str) == i);
2007   _dbus_assert (_dbus_string_get_length (&other) == i * 2);
2008   _dbus_assert (_dbus_string_equal_c_str (&other,
2009                                           "Hello WorldHello World"));
2010
2011   if (!_dbus_string_copy (&str, 0, &other, _dbus_string_get_length (&other) / 2))
2012     _dbus_assert_not_reached ("could not copy");
2013
2014   _dbus_assert (_dbus_string_get_length (&str) == i);
2015   _dbus_assert (_dbus_string_get_length (&other) == i * 3);
2016   _dbus_assert (_dbus_string_equal_c_str (&other,
2017                                           "Hello WorldHello WorldHello World"));
2018
2019   _dbus_string_free (&str);
2020   _dbus_string_free (&other);
2021
2022   /* Check replace */
2023
2024   if (!_dbus_string_init (&str, _DBUS_INT_MAX))
2025     _dbus_assert_not_reached ("failed to init string");
2026
2027   if (!_dbus_string_append (&str, "Hello World"))
2028     _dbus_assert_not_reached ("could not append to string");
2029
2030   i = _dbus_string_get_length (&str);
2031
2032   if (!_dbus_string_init (&other, _DBUS_INT_MAX))
2033     _dbus_assert_not_reached ("could not init string");
2034
2035   if (!_dbus_string_replace_len (&str, 0, _dbus_string_get_length (&str),
2036                                  &other, 0, _dbus_string_get_length (&other)))
2037     _dbus_assert_not_reached ("could not replace");
2038
2039   _dbus_assert (_dbus_string_get_length (&str) == i);
2040   _dbus_assert (_dbus_string_get_length (&other) == i);
2041   _dbus_assert (_dbus_string_equal_c_str (&other, "Hello World"));
2042
2043   if (!_dbus_string_replace_len (&str, 0, _dbus_string_get_length (&str),
2044                                  &other, 5, 1))
2045     _dbus_assert_not_reached ("could not replace center space");
2046
2047   _dbus_assert (_dbus_string_get_length (&str) == i);
2048   _dbus_assert (_dbus_string_get_length (&other) == i * 2 - 1);
2049   _dbus_assert (_dbus_string_equal_c_str (&other,
2050                                           "HelloHello WorldWorld"));
2051
2052
2053   if (!_dbus_string_replace_len (&str, 1, 1,
2054                                  &other,
2055                                  _dbus_string_get_length (&other) - 1,
2056                                  1))
2057     _dbus_assert_not_reached ("could not replace end character");
2058
2059   _dbus_assert (_dbus_string_get_length (&str) == i);
2060   _dbus_assert (_dbus_string_get_length (&other) == i * 2 - 1);
2061   _dbus_assert (_dbus_string_equal_c_str (&other,
2062                                           "HelloHello WorldWorle"));
2063
2064   _dbus_string_free (&str);
2065   _dbus_string_free (&other);
2066
2067   /* Check append/get unichar */
2068
2069   if (!_dbus_string_init (&str, _DBUS_INT_MAX))
2070     _dbus_assert_not_reached ("failed to init string");
2071
2072   ch = 0;
2073   if (!_dbus_string_append_unichar (&str, 0xfffc))
2074     _dbus_assert_not_reached ("failed to append unichar");
2075
2076   _dbus_string_get_unichar (&str, 0, &ch, &i);
2077
2078   _dbus_assert (ch == 0xfffc);
2079   _dbus_assert (i == _dbus_string_get_length (&str));
2080
2081   _dbus_string_free (&str);
2082
2083   /* Check append/parse int/double */
2084
2085   if (!_dbus_string_init (&str, _DBUS_INT_MAX))
2086     _dbus_assert_not_reached ("failed to init string");
2087
2088   if (!_dbus_string_append_int (&str, 27))
2089     _dbus_assert_not_reached ("failed to append int");
2090
2091   i = _dbus_string_get_length (&str);
2092
2093   if (!_dbus_string_parse_int (&str, 0, &v, &end))
2094     _dbus_assert_not_reached ("failed to parse int");
2095
2096   _dbus_assert (v == 27);
2097   _dbus_assert (end == i);
2098
2099   _dbus_string_free (&str);
2100
2101   if (!_dbus_string_init (&str, _DBUS_INT_MAX))
2102     _dbus_assert_not_reached ("failed to init string");
2103
2104   if (!_dbus_string_append_double (&str, 50.3))
2105     _dbus_assert_not_reached ("failed to append float");
2106
2107   i = _dbus_string_get_length (&str);
2108
2109   if (!_dbus_string_parse_double (&str, 0, &d, &end))
2110     _dbus_assert_not_reached ("failed to parse float");
2111
2112   _dbus_assert (d > (50.3 - 1e-6) && d < (50.3 + 1e-6));
2113   _dbus_assert (end == i);
2114
2115   _dbus_string_free (&str);
2116
2117   /* Test find */
2118   if (!_dbus_string_init (&str, _DBUS_INT_MAX))
2119     _dbus_assert_not_reached ("failed to init string");
2120
2121   if (!_dbus_string_append (&str, "Hello"))
2122     _dbus_assert_not_reached ("couldn't append to string");
2123
2124   if (!_dbus_string_find (&str, 0, "He", &i))
2125     _dbus_assert_not_reached ("didn't find 'He'");
2126   _dbus_assert (i == 0);
2127
2128   if (!_dbus_string_find (&str, 0, "ello", &i))
2129     _dbus_assert_not_reached ("didn't find 'ello'");
2130   _dbus_assert (i == 1);
2131
2132   if (!_dbus_string_find (&str, 0, "lo", &i))
2133     _dbus_assert_not_reached ("didn't find 'lo'");
2134   _dbus_assert (i == 3);
2135
2136   if (!_dbus_string_find (&str, 2, "lo", &i))
2137     _dbus_assert_not_reached ("didn't find 'lo'");
2138   _dbus_assert (i == 3);
2139
2140   if (_dbus_string_find (&str, 4, "lo", &i))
2141     _dbus_assert_not_reached ("did find 'lo'");
2142
2143   if (!_dbus_string_find (&str, 0, "l", &i))
2144     _dbus_assert_not_reached ("didn't find 'l'");
2145   _dbus_assert (i == 2);
2146
2147   if (!_dbus_string_find (&str, 0, "H", &i))
2148     _dbus_assert_not_reached ("didn't find 'H'");
2149   _dbus_assert (i == 0);
2150
2151   if (!_dbus_string_find (&str, 0, "", &i))
2152     _dbus_assert_not_reached ("didn't find ''");
2153   _dbus_assert (i == 0);
2154
2155   if (_dbus_string_find (&str, 0, "Hello!", NULL))
2156     _dbus_assert_not_reached ("Did find 'Hello!'");
2157
2158   if (_dbus_string_find (&str, 0, "Oh, Hello", NULL))
2159     _dbus_assert_not_reached ("Did find 'Oh, Hello'");
2160
2161   if (_dbus_string_find (&str, 0, "ill", NULL))
2162     _dbus_assert_not_reached ("Did find 'ill'");
2163
2164   if (_dbus_string_find (&str, 0, "q", NULL))
2165     _dbus_assert_not_reached ("Did find 'q'");
2166
2167   _dbus_string_free (&str);
2168
2169   /* Base 64 */
2170   test_base64_roundtrip ("Hello this is a string\n", -1);
2171   test_base64_roundtrip ("Hello this is a string\n1", -1);
2172   test_base64_roundtrip ("Hello this is a string\n12", -1);
2173   test_base64_roundtrip ("Hello this is a string\n123", -1);
2174   test_base64_roundtrip ("Hello this is a string\n1234", -1);
2175   test_base64_roundtrip ("Hello this is a string\n12345", -1);
2176   test_base64_roundtrip ("", 0);
2177   test_base64_roundtrip ("1", 1);
2178   test_base64_roundtrip ("12", 2);
2179   test_base64_roundtrip ("123", 3);
2180   test_base64_roundtrip ("1234", 4);
2181   test_base64_roundtrip ("12345", 5);
2182   test_base64_roundtrip ("", 1);
2183   test_base64_roundtrip ("1", 2);
2184   test_base64_roundtrip ("12", 3);
2185   test_base64_roundtrip ("123", 4);
2186   test_base64_roundtrip ("1234", 5);
2187   test_base64_roundtrip ("12345", 6);
2188   {
2189     unsigned char buf[512];
2190     i = 0;
2191     while (i < _DBUS_N_ELEMENTS (buf))
2192       {
2193         buf[i] = i;
2194         ++i;
2195       }
2196     i = 0;
2197     while (i < _DBUS_N_ELEMENTS (buf))
2198       {
2199         test_base64_roundtrip (buf, i);
2200         ++i;
2201       }
2202   }
2203
2204   return TRUE;
2205 }
2206
2207 #endif /* DBUS_BUILD_TESTS */