libcitadel/lib/stringbuf.c

   1 #include "sysdep.h"
   2 #include <ctype.h>
   3 #include <errno.h>
   4 #include <string.h>
   5 #include <unistd.h>
   6 #include <string.h>
   7 #include <stdio.h>
   8 #include <sys/select.h>
   9 #include <fcntl.h>
  10 #include <sys/types.h>
  11 #define SHOW_ME_VAPPEND_PRINTF
  12 #include <stdarg.h>
  13 #include "libcitadel.h"
  14
  15 #ifdef HAVE_ICONV
  16 #include <iconv.h>
  17 #endif
  18
  19 #ifdef HAVE_BACKTRACE
  20 #include <execinfo.h>
  21 #endif
  22
  23 #ifdef HAVE_ZLIB
  24 #include <zlib.h>
  25 int ZEXPORT compress_gzip(Bytef * dest, size_t * destLen,
  26                           const Bytef * source, uLong sourceLen, int level);
  27 #endif
  28 int BaseStrBufSize = 64;
  29
  30 const char *StrBufNOTNULL = ((char*) NULL) - 1;
  31
  32 const char HexList[256][3] = {
  33         "00","01","02","03","04","05","06","07","08","09","0A","0B","0C","0D","0E","0F",
  34         "10","11","12","13","14","15","16","17","18","19","1A","1B","1C","1D","1E","1F",
  35         "20","21","22","23","24","25","26","27","28","29","2A","2B","2C","2D","2E","2F",
  36         "30","31","32","33","34","35","36","37","38","39","3A","3B","3C","3D","3E","3F",
  37         "40","41","42","43","44","45","46","47","48","49","4A","4B","4C","4D","4E","4F",
  38         "50","51","52","53","54","55","56","57","58","59","5A","5B","5C","5D","5E","5F",
  39         "60","61","62","63","64","65","66","67","68","69","6A","6B","6C","6D","6E","6F",
  40         "70","71","72","73","74","75","76","77","78","79","7A","7B","7C","7D","7E","7F",
  41         "80","81","82","83","84","85","86","87","88","89","8A","8B","8C","8D","8E","8F",
  42         "90","91","92","93","94","95","96","97","98","99","9A","9B","9C","9D","9E","9F",
  43         "A0","A1","A2","A3","A4","A5","A6","A7","A8","A9","AA","AB","AC","AD","AE","AF",
  44         "B0","B1","B2","B3","B4","B5","B6","B7","B8","B9","BA","BB","BC","BD","BE","BF",
  45         "C0","C1","C2","C3","C4","C5","C6","C7","C8","C9","CA","CB","CC","CD","CE","CF",
  46         "D0","D1","D2","D3","D4","D5","D6","D7","D8","D9","DA","DB","DC","DD","DE","DF",
  47         "E0","E1","E2","E3","E4","E5","E6","E7","E8","E9","EA","EB","EC","ED","EE","EF",
  48         "F0","F1","F2","F3","F4","F5","F6","F7","F8","F9","FA","FB","FC","FD","FE","FF"};
  49
  50 /**
  51  * @defgroup StrBuf Stringbuffer, A class for manipulating strings with dynamic buffers
  52  * StrBuf is a versatile class, aiding the handling of dynamic strings
  53  *  * reduce de/reallocations
  54  *  * reduce the need to remeasure it
  55  *  * reduce scanning over the string (in @ref StrBuf_NextTokenizer "Tokenizers")
  56  *  * allow asyncroneous IO for line and Blob based operations
  57  *  * reduce the use of memove in those
  58  *  * Quick filling in several operations with append functions
  59  */
  60
  61 /**
  62  * @defgroup StrBuf_DeConstructors Create/Destroy StrBufs
  63  * @ingroup StrBuf
  64  */
  65
  66 /**
  67  * @defgroup StrBuf_Cast Cast operators to interact with char* based code
  68  * @ingroup StrBuf
  69  * use these operators to interfere with code demanding char*;
  70  * if you need to own the content, smash me. Avoid, since we loose the length information.
  71  */
  72
  73 /**
  74  * @defgroup StrBuf_Filler Create/Replace/Append Content into a StrBuf
  75  * @ingroup StrBuf
  76  * operations to get your Strings into a StrBuf, manipulating them, or appending
  77  */
  78 /**
  79  * @defgroup StrBuf_NextTokenizer Fast tokenizer to pull tokens in sequence
  80  * @ingroup StrBuf
  81  * Quick tokenizer; demands of the user to pull its tokens in sequence
  82  */
  83
  84 /**
  85  * @defgroup StrBuf_Tokenizer tokenizer Functions; Slow ones.
  86  * @ingroup StrBuf
  87  * versatile tokenizer; random access to tokens, but slower; Prefer the @ref StrBuf_NextTokenizer "Next Tokenizer"
  88  */
  89
  90 /**
  91  * @defgroup StrBuf_BufferedIO Buffered IO with Asynchroneous reads and no unneeded memmoves (the fast ones)
  92  * @ingroup StrBuf
  93  * File IO to fill StrBufs; Works with work-buffer shared across several calls;
  94  * External Cursor to maintain the current read position inside of the buffer
  95  * the non-fast ones will use memove to keep the start of the buffer the read buffer (which is slower)
  96  */
  97
  98 /**
  99  * @defgroup StrBuf_IO FileIO; Prefer @ref StrBuf_BufferedIO
 100  * @ingroup StrBuf
 101  * Slow I/O; avoid.
 102  */
 103
 104 /**
 105  * @defgroup StrBuf_DeEnCoder functions to translate the contents of a buffer
 106  * @ingroup StrBuf
 107  * these functions translate the content of a buffer into another representation;
 108  * some are combined Fillers and encoders
 109  */
 110
 111 /**
 112  * Private Structure for the Stringbuffer
 113  */
 114 struct StrBuf {
 115         char *buf;         /**< the pointer to the dynamic buffer */
 116         long BufSize;      /**< how many spcae do we optain */
 117         long BufUsed;      /**< StNumber of Chars used excluding the trailing \\0 */
 118         int ConstBuf;      /**< are we just a wrapper arround a static buffer and musn't we be changed? */
 119 #ifdef SIZE_DEBUG
 120         long nIncreases;   /**< for profiling; cound how many times we needed more */
 121         char bt [SIZ];     /**< Stacktrace of last increase */
 122         char bt_lastinc [SIZ]; /**< How much did we increase last time? */
 123 #endif
 124 };
 125
 126
 127 static inline int Ctdl_GetUtf8SequenceLength(const char *CharS, const char *CharE);
 128 static inline int Ctdl_IsUtf8SequenceStart(const char Char);
 129
 130 #ifdef SIZE_DEBUG
 131 #ifdef HAVE_BACKTRACE
 132 static void StrBufBacktrace(StrBuf *Buf, int which)
 133 {
 134         int n;
 135         char *pstart, *pch;
 136         void *stack_frames[50];
 137         size_t size, i;
 138         char **strings;
 139
 140         if (which)
 141                 pstart = pch = Buf->bt;
 142         else
 143                 pstart = pch = Buf->bt_lastinc;
 144         size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
 145         strings = backtrace_symbols(stack_frames, size);
 146         for (i = 0; i < size; i++) {
 147                 if (strings != NULL)
 148                         n = snprintf(pch, SIZ - (pch - pstart), "%s\\n", strings[i]);
 149                 else
 150                         n = snprintf(pch, SIZ - (pch - pstart), "%p\\n", stack_frames[i]);
 151                 pch += n;
 152         }
 153         free(strings);
 154
 155
 156 }
 157 #endif
 158
 159 void dbg_FreeStrBuf(StrBuf *FreeMe, char *FromWhere)
 160 {
 161         if (hFreeDbglog == -1){
 162                 pid_t pid = getpid();
 163                 char path [SIZ];
 164                 snprintf(path, SIZ, "/tmp/libcitadel_strbuf_realloc.log.%d", pid);
 165                 hFreeDbglog = open(path, O_APPEND|O_CREAT|O_WRONLY);
 166         }
 167         if ((*FreeMe)->nIncreases > 0)
 168         {
 169                 char buf[SIZ * 3];
 170                 long n;
 171                 n = snprintf(buf, SIZ * 3, "%c+|%ld|%ld|%ld|%s|%s|\n",
 172                              FromWhere,
 173                              (*FreeMe)->nIncreases,
 174                              (*FreeMe)->BufUsed,
 175                              (*FreeMe)->BufSize,
 176                              (*FreeMe)->bt,
 177                              (*FreeMe)->bt_lastinc);
 178                 n = write(hFreeDbglog, buf, n);
 179         }
 180         else
 181         {
 182                 char buf[128];
 183                 long n;
 184                 n = snprintf(buf, 128, "%c_|0|%ld%ld|\n",
 185                              FromWhere,
 186                              (*FreeMe)->BufUsed,
 187                              (*FreeMe)->BufSize);
 188                 n = write(hFreeDbglog, buf, n);
 189         }
 190 }
 191
 192 void dbg_IncreaseBuf(StrBuf *IncMe)
 193 {
 194         Buf->nIncreases++;
 195 #ifdef HAVE_BACKTRACE
 196         StrBufBacktrace(Buf, 1);
 197 #endif
 198 }
 199
 200 void dbg_Init(StrBuf *Buf)
 201 {
 202         Buf->nIncreases = 0;
 203         Buf->bt[0] = '\0';
 204         Buf->bt_lastinc[0] = '\0';
 205 #ifdef HAVE_BACKTRACE
 206         StrBufBacktrace(Buf, 0);
 207 #endif
 208 }
 209
 210 #else
 211 /* void it... */
 212 #define dbg_FreeStrBuf(a, b)
 213 #define dbg_IncreaseBuf(a)
 214 #define dbg_Init(a)
 215
 216 #endif
 217
 218 /**
 219  * @ingroup StrBuf_Cast
 220  * @brief Cast operator to Plain String
 221  * @note if the buffer is altered by StrBuf operations, this pointer may become
 222  *  invalid. So don't lean on it after altering the buffer!
 223  *  Since this operation is considered cheap, rather call it often than risking
 224  *  your pointer to become invalid!
 225  * @param Str the string we want to get the c-string representation for
 226  * @returns the Pointer to the Content. Don't mess with it!
 227  */
 228 inline const char *ChrPtr(const StrBuf *Str)
 229 {
 230         if (Str == NULL)
 231                 return "";
 232         return Str->buf;
 233 }
 234
 235 /**
 236  * @ingroup StrBuf_Cast
 237  * @brief since we know strlen()'s result, provide it here.
 238  * @param Str the string to return the length to
 239  * @returns contentlength of the buffer
 240  */
 241 inline int StrLength(const StrBuf *Str)
 242 {
 243         return (Str != NULL) ? Str->BufUsed : 0;
 244 }
 245
 246 /**
 247  * @ingroup StrBuf_DeConstructors
 248  * @brief local utility function to resize the buffer
 249  * @param Buf the buffer whichs storage we should increase
 250  * @param KeepOriginal should we copy the original buffer or just start over with a new one
 251  * @param DestSize what should fit in after?
 252  */
 253 static int IncreaseBuf(StrBuf *Buf, int KeepOriginal, int DestSize)
 254 {
 255         char *NewBuf;
 256         size_t NewSize = Buf->BufSize * 2;
 257
 258         if (Buf->ConstBuf)
 259                 return -1;
 260
 261         if (DestSize > 0)
 262                 while ((NewSize <= DestSize) && (NewSize != 0))
 263                         NewSize *= 2;
 264
 265         if (NewSize == 0)
 266                 return -1;
 267
 268         NewBuf= (char*) malloc(NewSize);
 269         if (NewBuf == NULL)
 270                 return -1;
 271
 272         if (KeepOriginal && (Buf->BufUsed > 0))
 273         {
 274                 memcpy(NewBuf, Buf->buf, Buf->BufUsed);
 275         }
 276         else
 277         {
 278                 NewBuf[0] = '\0';
 279                 Buf->BufUsed = 0;
 280         }
 281         free (Buf->buf);
 282         Buf->buf = NewBuf;
 283         Buf->BufSize = NewSize;
 284
 285         dbg_IncreaseBuf(Buf);
 286
 287         return Buf->BufSize;
 288 }
 289
 290 /**
 291  * @ingroup StrBuf_DeConstructors
 292  * @brief shrink / increase an _EMPTY_ buffer to NewSize. Buffercontent is thoroughly ignored and flushed.
 293  * @param Buf Buffer to shrink (has to be empty)
 294  * @param ThreshHold if the buffer is bigger then this, its readjusted
 295  * @param NewSize if we Shrink it, how big are we going to be afterwards?
 296  */
 297 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize)
 298 {
 299         if ((Buf != NULL) &&
 300             (Buf->BufUsed == 0) &&
 301             (Buf->BufSize < ThreshHold)) {
 302                 free(Buf->buf);
 303                 Buf->buf = (char*) malloc(NewSize);
 304                 Buf->BufUsed = 0;
 305                 Buf->BufSize = NewSize;
 306         }
 307 }
 308
 309 /**
 310  * @ingroup StrBuf_DeConstructors
 311  * @brief shrink long term buffers to their real size so they don't waste memory
 312  * @param Buf buffer to shrink
 313  * @param Force if not set, will just executed if the buffer is much to big; set for lifetime strings
 314  * @returns physical size of the buffer
 315  */
 316 long StrBufShrinkToFit(StrBuf *Buf, int Force)
 317 {
 318         if (Buf == NULL)
 319                 return -1;
 320         if (Force ||
 321             (Buf->BufUsed + (Buf->BufUsed / 3) > Buf->BufSize))
 322         {
 323                 char *TmpBuf = (char*) malloc(Buf->BufUsed + 1);
 324                 memcpy (TmpBuf, Buf->buf, Buf->BufUsed + 1);
 325                 Buf->BufSize = Buf->BufUsed + 1;
 326                 free(Buf->buf);
 327                 Buf->buf = TmpBuf;
 328         }
 329         return Buf->BufUsed;
 330 }
 331
 332 /**
 333  * @ingroup StrBuf_DeConstructors
 334  * @brief Allocate a new buffer with default buffer size
 335  * @returns the new stringbuffer
 336  */
 337 StrBuf* NewStrBuf(void)
 338 {
 339         StrBuf *NewBuf;
 340
 341         NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
 342         NewBuf->buf = (char*) malloc(BaseStrBufSize);
 343         NewBuf->buf[0] = '\0';
 344         NewBuf->BufSize = BaseStrBufSize;
 345         NewBuf->BufUsed = 0;
 346         NewBuf->ConstBuf = 0;
 347
 348         dbg_Init (NewBuf);
 349
 350         return NewBuf;
 351 }
 352
 353 /**
 354  * @ingroup StrBuf_DeConstructors
 355  * @brief Copy Constructor; returns a duplicate of CopyMe
 356  * @param CopyMe Buffer to faxmilate
 357  * @returns the new stringbuffer
 358  */
 359 StrBuf* NewStrBufDup(const StrBuf *CopyMe)
 360 {
 361         StrBuf *NewBuf;
 362
 363         if (CopyMe == NULL)
 364                 return NewStrBuf();
 365
 366         NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
 367         NewBuf->buf = (char*) malloc(CopyMe->BufSize);
 368         memcpy(NewBuf->buf, CopyMe->buf, CopyMe->BufUsed + 1);
 369         NewBuf->BufUsed = CopyMe->BufUsed;
 370         NewBuf->BufSize = CopyMe->BufSize;
 371         NewBuf->ConstBuf = 0;
 372
 373         dbg_Init(NewBuf);
 374
 375         return NewBuf;
 376 }
 377
 378 /**
 379  * @ingroup StrBuf_DeConstructors
 380  * @brief create a new Buffer using an existing c-string
 381  * this function should also be used if you want to pre-suggest
 382  * the buffer size to allocate in conjunction with ptr == NULL
 383  * @param ptr the c-string to copy; may be NULL to create a blank instance
 384  * @param nChars How many chars should we copy; -1 if we should measure the length ourselves
 385  * @returns the new stringbuffer
 386  */
 387 StrBuf* NewStrBufPlain(const char* ptr, int nChars)
 388 {
 389         StrBuf *NewBuf;
 390         size_t Siz = BaseStrBufSize;
 391         size_t CopySize;
 392
 393         NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
 394         if (nChars < 0)
 395                 CopySize = strlen((ptr != NULL)?ptr:"");
 396         else
 397                 CopySize = nChars;
 398
 399         while ((Siz <= CopySize) && (Siz != 0))
 400                 Siz *= 2;
 401
 402         if (Siz == 0)
 403         {
 404                 return NULL;
 405         }
 406
 407         NewBuf->buf = (char*) malloc(Siz);
 408         NewBuf->BufSize = Siz;
 409         if (ptr != NULL) {
 410                 memcpy(NewBuf->buf, ptr, CopySize);
 411                 NewBuf->buf[CopySize] = '\0';
 412                 NewBuf->BufUsed = CopySize;
 413         }
 414         else {
 415                 NewBuf->buf[0] = '\0';
 416                 NewBuf->BufUsed = 0;
 417         }
 418         NewBuf->ConstBuf = 0;
 419
 420         dbg_Init(NewBuf)
 421
 422                 return NewBuf;
 423 }
 424
 425 /**
 426  * @ingroup StrBuf_DeConstructors
 427  * @brief Set an existing buffer from a c-string
 428  * @param Buf buffer to load
 429  * @param ptr c-string to put into
 430  * @param nChars set to -1 if we should work 0-terminated
 431  * @returns the new length of the string
 432  */
 433 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars)
 434 {
 435         size_t Siz;
 436         size_t CopySize;
 437
 438         if (Buf == NULL)
 439                 return -1;
 440         if (ptr == NULL) {
 441                 FlushStrBuf(Buf);
 442                 return -1;
 443         }
 444
 445         Siz = Buf->BufSize;
 446
 447         if (nChars < 0)
 448                 CopySize = strlen(ptr);
 449         else
 450                 CopySize = nChars;
 451
 452         while ((Siz <= CopySize) && (Siz != 0))
 453                 Siz *= 2;
 454
 455         if (Siz == 0) {
 456                 FlushStrBuf(Buf);
 457                 return -1;
 458         }
 459
 460         if (Siz != Buf->BufSize)
 461                 IncreaseBuf(Buf, 0, Siz);
 462         memcpy(Buf->buf, ptr, CopySize);
 463         Buf->buf[CopySize] = '\0';
 464         Buf->BufUsed = CopySize;
 465         Buf->ConstBuf = 0;
 466         return CopySize;
 467 }
 468
 469
 470 /**
 471  * @ingroup StrBuf_DeConstructors
 472  * @brief use strbuf as wrapper for a string constant for easy handling
 473  * @param StringConstant a string to wrap
 474  * @param SizeOfStrConstant should be sizeof(StringConstant)-1
 475  */
 476 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant)
 477 {
 478         StrBuf *NewBuf;
 479
 480         NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
 481         NewBuf->buf = (char*) StringConstant;
 482         NewBuf->BufSize = SizeOfStrConstant;
 483         NewBuf->BufUsed = SizeOfStrConstant;
 484         NewBuf->ConstBuf = 1;
 485
 486         dbg_Init(NewBuf);
 487
 488         return NewBuf;
 489 }
 490
 491
 492 /**
 493  * @ingroup StrBuf_DeConstructors
 494  * @brief flush the content of a Buf; keep its struct
 495  * @param buf Buffer to flush
 496  */
 497 int FlushStrBuf(StrBuf *buf)
 498 {
 499         if (buf == NULL)
 500                 return -1;
 501         if (buf->ConstBuf)
 502                 return -1;
 503         buf->buf[0] ='\0';
 504         buf->BufUsed = 0;
 505         return 0;
 506 }
 507
 508 /**
 509  * @ingroup StrBuf_DeConstructors
 510  * @brief wipe the content of a Buf thoroughly (overwrite it -> expensive); keep its struct
 511  * @param buf Buffer to wipe
 512  */
 513 int FLUSHStrBuf(StrBuf *buf)
 514 {
 515         if (buf == NULL)
 516                 return -1;
 517         if (buf->ConstBuf)
 518                 return -1;
 519         if (buf->BufUsed > 0) {
 520                 memset(buf->buf, 0, buf->BufUsed);
 521                 buf->BufUsed = 0;
 522         }
 523         return 0;
 524 }
 525
 526 #ifdef SIZE_DEBUG
 527 int hFreeDbglog = -1;
 528 #endif
 529 /**
 530  * @ingroup StrBuf_DeConstructors
 531  * @brief Release a Buffer
 532  * Its a double pointer, so it can NULL your pointer
 533  * so fancy SIG11 appear instead of random results
 534  * @param FreeMe Pointer Pointer to the buffer to free
 535  */
 536 void FreeStrBuf (StrBuf **FreeMe)
 537 {
 538         if (*FreeMe == NULL)
 539                 return;
 540
 541         dbg_FreeStrBuf(FreeMe, 'F');
 542
 543         if (!(*FreeMe)->ConstBuf)
 544                 free((*FreeMe)->buf);
 545         free(*FreeMe);
 546         *FreeMe = NULL;
 547 }
 548
 549 /**
 550  * @ingroup StrBuf_DeConstructors
 551  * @brief flatten a Buffer to the Char * we return
 552  * Its a double pointer, so it can NULL your pointer
 553  * so fancy SIG11 appear instead of random results
 554  * The Callee then owns the buffer and is responsible for freeing it.
 555  * @param SmashMe Pointer Pointer to the buffer to release Buf from and free
 556  * @returns the pointer of the buffer; Callee owns the memory thereafter.
 557  */
 558 char *SmashStrBuf (StrBuf **SmashMe)
 559 {
 560         char *Ret;
 561
 562         if ((SmashMe == NULL) || (*SmashMe == NULL))
 563                 return NULL;
 564
 565         dbg_FreeStrBuf(SmashMe, 'S');
 566
 567         Ret = (*SmashMe)->buf;
 568         free(*SmashMe);
 569         *SmashMe = NULL;
 570         return Ret;
 571 }
 572
 573 /**
 574  * @ingroup StrBuf_DeConstructors
 575  * @brief Release the buffer
 576  * If you want put your StrBuf into a Hash, use this as Destructor.
 577  * @param VFreeMe untyped pointer to a StrBuf. be shure to do the right thing [TM]
 578  */
 579 void HFreeStrBuf (void *VFreeMe)
 580 {
 581         StrBuf *FreeMe = (StrBuf*)VFreeMe;
 582         if (FreeMe == NULL)
 583                 return;
 584
 585         dbg_FreeStrBuf(SmashMe, 'H');
 586
 587         if (!FreeMe->ConstBuf)
 588                 free(FreeMe->buf);
 589         free(FreeMe);
 590 }
 591
 592
 593 /*******************************************************************************
 594  *                      Simple string transformations                          *
 595  *******************************************************************************/
 596
 597 /**
 598  * @ingroup StrBuf
 599  * @brief Wrapper around atol
 600  */
 601 long StrTol(const StrBuf *Buf)
 602 {
 603         if (Buf == NULL)
 604                 return 0;
 605         if(Buf->BufUsed > 0)
 606                 return atol(Buf->buf);
 607         else
 608                 return 0;
 609 }
 610
 611 /**
 612  * @ingroup StrBuf
 613  * @brief Wrapper around atoi
 614  */
 615 int StrToi(const StrBuf *Buf)
 616 {
 617         if (Buf == NULL)
 618                 return 0;
 619         if (Buf->BufUsed > 0)
 620                 return atoi(Buf->buf);
 621         else
 622                 return 0;
 623 }
 624
 625 /**
 626  * @ingroup StrBuf
 627  * @brief Checks to see if the string is a pure number
 628  * @param Buf The buffer to inspect
 629  * @returns 1 if its a pure number, 0, if not.
 630  */
 631 int StrBufIsNumber(const StrBuf *Buf) {
 632         char * pEnd;
 633         if ((Buf == NULL) || (Buf->BufUsed == 0)) {
 634                 return 0;
 635         }
 636         strtoll(Buf->buf, &pEnd, 10);
 637         if (pEnd == Buf->buf)
 638                 return 0;
 639         if ((pEnd != NULL) && (pEnd == Buf->buf + Buf->BufUsed))
 640                 return 1;
 641         if (Buf->buf == pEnd)
 642                 return 0;
 643         return 0;
 644 }
 645
 646 /**
 647  * @ingroup StrBuf_Filler
 648  * @brief modifies a Single char of the Buf
 649  * You can point to it via char* or a zero-based integer
 650  * @param Buf The buffer to manipulate
 651  * @param ptr char* to zero; use NULL if unused
 652  * @param nThChar zero based pointer into the string; use -1 if unused
 653  * @param PeekValue The Character to place into the position
 654  */
 655 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue)
 656 {
 657         if (Buf == NULL)
 658                 return -1;
 659         if (ptr != NULL)
 660                 nThChar = ptr - Buf->buf;
 661         if ((nThChar < 0) || (nThChar > Buf->BufUsed))
 662                 return -1;
 663         Buf->buf[nThChar] = PeekValue;
 664         return nThChar;
 665 }
 666
 667 /**
 668  * @ingroup StrBuf_Filler
 669  * @brief modifies a range of chars of the Buf
 670  * You can point to it via char* or a zero-based integer
 671  * @param Buf The buffer to manipulate
 672  * @param ptr char* to zero; use NULL if unused
 673  * @param nThChar zero based pointer into the string; use -1 if unused
 674  * @param nChars how many chars are to be flushed?
 675  * @param PookValue The Character to place into that area
 676  */
 677 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue)
 678 {
 679         if (Buf == NULL)
 680                 return -1;
 681         if (ptr != NULL)
 682                 nThChar = ptr - Buf->buf;
 683         if ((nThChar < 0) || (nThChar > Buf->BufUsed))
 684                 return -1;
 685         if (nThChar + nChars > Buf->BufUsed)
 686                 nChars =  Buf->BufUsed - nThChar;
 687
 688         memset(Buf->buf + nThChar, PookValue, nChars);
 689         /* just to be shure... */
 690         Buf->buf[Buf->BufUsed] = 0;
 691         return nChars;
 692 }
 693
 694 /**
 695  * @ingroup StrBuf_Filler
 696  * @brief Append a StringBuffer to the buffer
 697  * @param Buf Buffer to modify
 698  * @param AppendBuf Buffer to copy at the end of our buffer
 699  * @param Offset Should we start copying from an offset?
 700  */
 701 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset)
 702 {
 703         if ((AppendBuf == NULL) || (Buf == NULL) || (AppendBuf->buf == NULL))
 704                 return;
 705
 706         if (Buf->BufSize - Offset < AppendBuf->BufUsed + Buf->BufUsed + 1)
 707                 IncreaseBuf(Buf,
 708                             (Buf->BufUsed > 0),
 709                             AppendBuf->BufUsed + Buf->BufUsed);
 710
 711         memcpy(Buf->buf + Buf->BufUsed,
 712                AppendBuf->buf + Offset,
 713                AppendBuf->BufUsed - Offset);
 714         Buf->BufUsed += AppendBuf->BufUsed - Offset;
 715         Buf->buf[Buf->BufUsed] = '\0';
 716 }
 717
 718
 719 /**
 720  * @ingroup StrBuf_Filler
 721  * @brief Append a C-String to the buffer
 722  * @param Buf Buffer to modify
 723  * @param AppendBuf Buffer to copy at the end of our buffer
 724  * @param AppendSize number of bytes to copy; set to -1 if we should count it in advance
 725  * @param Offset Should we start copying from an offset?
 726  */
 727 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset)
 728 {
 729         long aps;
 730         long BufSizeRequired;
 731
 732         if ((AppendBuf == NULL) || (Buf == NULL))
 733                 return;
 734
 735         if (AppendSize < 0 )
 736                 aps = strlen(AppendBuf + Offset);
 737         else
 738                 aps = AppendSize - Offset;
 739
 740         BufSizeRequired = Buf->BufUsed + aps + 1;
 741         if (Buf->BufSize <= BufSizeRequired)
 742                 IncreaseBuf(Buf, (Buf->BufUsed > 0), BufSizeRequired);
 743
 744         memcpy(Buf->buf + Buf->BufUsed,
 745                AppendBuf + Offset,
 746                aps);
 747         Buf->BufUsed += aps;
 748         Buf->buf[Buf->BufUsed] = '\0';
 749 }
 750
 751 /**
 752  * @ingroup StrBuf_Filler
 753  * @brief sprintf like function appending the formated string to the buffer
 754  * vsnprintf version to wrap into own calls
 755  * @param Buf Buffer to extend by format and Params
 756  * @param format printf alike format to add
 757  * @param ap va_list containing the items for format
 758  */
 759 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap)
 760 {
 761         va_list apl;
 762         size_t BufSize;
 763         size_t nWritten;
 764         size_t Offset;
 765         size_t newused;
 766
 767         if ((Buf == NULL)  || (format == NULL))
 768                 return;
 769
 770         BufSize = Buf->BufSize;
 771         nWritten = Buf->BufSize + 1;
 772         Offset = Buf->BufUsed;
 773         newused = Offset + nWritten;
 774
 775         while (newused >= BufSize) {
 776                 va_copy(apl, ap);
 777                 nWritten = vsnprintf(Buf->buf + Offset,
 778                                      Buf->BufSize - Offset,
 779                                      format, apl);
 780                 va_end(apl);
 781                 newused = Offset + nWritten;
 782                 if (newused >= Buf->BufSize) {
 783                         if (IncreaseBuf(Buf, 1, newused) == -1)
 784                                 return; /* TODO: error handling? */
 785                         newused = Buf->BufSize + 1;
 786                 }
 787                 else {
 788                         Buf->BufUsed = Offset + nWritten;
 789                         BufSize = Buf->BufSize;
 790                 }
 791
 792         }
 793 }
 794
 795 /**
 796  * @ingroup StrBuf_Filler
 797  * @brief sprintf like function appending the formated string to the buffer
 798  * @param Buf Buffer to extend by format and Params
 799  * @param format printf alike format to add
 800  */
 801 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...)
 802 {
 803         size_t BufSize;
 804         size_t nWritten;
 805         size_t Offset;
 806         size_t newused;
 807         va_list arg_ptr;
 808
 809         if ((Buf == NULL)  || (format == NULL))
 810                 return;
 811
 812         BufSize = Buf->BufSize;
 813         nWritten = Buf->BufSize + 1;
 814         Offset = Buf->BufUsed;
 815         newused = Offset + nWritten;
 816
 817         while (newused >= BufSize) {
 818                 va_start(arg_ptr, format);
 819                 nWritten = vsnprintf(Buf->buf + Buf->BufUsed,
 820                                      Buf->BufSize - Buf->BufUsed,
 821                                      format, arg_ptr);
 822                 va_end(arg_ptr);
 823                 newused = Buf->BufUsed + nWritten;
 824                 if (newused >= Buf->BufSize) {
 825                         if (IncreaseBuf(Buf, 1, newused) == -1)
 826                                 return; /* TODO: error handling? */
 827                         newused = Buf->BufSize + 1;
 828                 }
 829                 else {
 830                         Buf->BufUsed += nWritten;
 831                         BufSize = Buf->BufSize;
 832                 }
 833
 834         }
 835 }
 836
 837 /**
 838  * @ingroup StrBuf_Filler
 839  * @brief sprintf like function putting the formated string into the buffer
 840  * @param Buf Buffer to extend by format and Parameters
 841  * @param format printf alike format to add
 842  */
 843 void StrBufPrintf(StrBuf *Buf, const char *format, ...)
 844 {
 845         size_t nWritten;
 846         va_list arg_ptr;
 847
 848         if ((Buf == NULL)  || (format == NULL))
 849                 return;
 850
 851         nWritten = Buf->BufSize + 1;
 852         while (nWritten >= Buf->BufSize) {
 853                 va_start(arg_ptr, format);
 854                 nWritten = vsnprintf(Buf->buf, Buf->BufSize, format, arg_ptr);
 855                 va_end(arg_ptr);
 856                 if (nWritten >= Buf->BufSize) {
 857                         if (IncreaseBuf(Buf, 0, 0) == -1)
 858                                 return; /* TODO: error handling? */
 859                         nWritten = Buf->BufSize + 1;
 860                         continue;
 861                 }
 862                 Buf->BufUsed = nWritten ;
 863         }
 864 }
 865
 866 /**
 867  * @ingroup StrBuf_Filler
 868  * @brief Callback for cURL to append the webserver reply to a buffer
 869  * @param ptr pre-defined by the cURL API; see man 3 curl for mre info
 870  * @param size pre-defined by the cURL API; see man 3 curl for mre info
 871  * @param nmemb pre-defined by the cURL API; see man 3 curl for mre info
 872  * @param stream pre-defined by the cURL API; see man 3 curl for mre info
 873  */
 874 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream)
 875 {
 876
 877         StrBuf *Target;
 878
 879         Target = stream;
 880         if (ptr == NULL)
 881                 return 0;
 882
 883         StrBufAppendBufPlain(Target, ptr, size * nmemb, 0);
 884         return size * nmemb;
 885 }
 886
 887
 888 /**
 889  * @ingroup StrBuf
 890  * @brief extracts a substring from Source into dest
 891  * @param dest buffer to place substring into
 892  * @param Source string to copy substring from
 893  * @param Offset chars to skip from start
 894  * @param nChars number of chars to copy
 895  * @returns the number of chars copied; may be different from nChars due to the size of Source
 896  */
 897 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars)
 898 {
 899         size_t NCharsRemain;
 900         if (Offset > Source->BufUsed)
 901         {
 902                 if (dest != NULL)
 903                         FlushStrBuf(dest);
 904                 return 0;
 905         }
 906         if (Offset + nChars < Source->BufUsed)
 907         {
 908                 if (nChars >= dest->BufSize)
 909                         IncreaseBuf(dest, 0, nChars + 1);
 910                 memcpy(dest->buf, Source->buf + Offset, nChars);
 911                 dest->BufUsed = nChars;
 912                 dest->buf[dest->BufUsed] = '\0';
 913                 return nChars;
 914         }
 915         NCharsRemain = Source->BufUsed - Offset;
 916         if (NCharsRemain  >= dest->BufSize)
 917                 IncreaseBuf(dest, 0, NCharsRemain + 1);
 918         memcpy(dest->buf, Source->buf + Offset, NCharsRemain);
 919         dest->BufUsed = NCharsRemain;
 920         dest->buf[dest->BufUsed] = '\0';
 921         return NCharsRemain;
 922 }
 923
 924 /**
 925  * @ingroup StrBuf
 926  * @brief Cut nChars from the start of the string
 927  * @param Buf Buffer to modify
 928  * @param nChars how many chars should be skipped?
 929  */
 930 void StrBufCutLeft(StrBuf *Buf, int nChars)
 931 {
 932         if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
 933         if (nChars >= Buf->BufUsed) {
 934                 FlushStrBuf(Buf);
 935                 return;
 936         }
 937         memmove(Buf->buf, Buf->buf + nChars, Buf->BufUsed - nChars);
 938         Buf->BufUsed -= nChars;
 939         Buf->buf[Buf->BufUsed] = '\0';
 940 }
 941
 942 /**
 943  * @ingroup StrBuf
 944  * @brief Cut the trailing n Chars from the string
 945  * @param Buf Buffer to modify
 946  * @param nChars how many chars should be trunkated?
 947  */
 948 void StrBufCutRight(StrBuf *Buf, int nChars)
 949 {
 950         if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
 951         if (nChars >= Buf->BufUsed) {
 952                 FlushStrBuf(Buf);
 953                 return;
 954         }
 955         Buf->BufUsed -= nChars;
 956         Buf->buf[Buf->BufUsed] = '\0';
 957 }
 958
 959 /**
 960  * @ingroup StrBuf
 961  * @brief Cut the string after n Chars
 962  * @param Buf Buffer to modify
 963  * @param AfternChars after how many chars should we trunkate the string?
 964  * @param At if non-null and points inside of our string, cut it there.
 965  */
 966 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At)
 967 {
 968         if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
 969         if (At != NULL){
 970                 AfternChars = At - Buf->buf;
 971         }
 972
 973         if ((AfternChars < 0) || (AfternChars >= Buf->BufUsed))
 974                 return;
 975         Buf->BufUsed = AfternChars;
 976         Buf->buf[Buf->BufUsed] = '\0';
 977 }
 978
 979
 980 /**
 981  * @ingroup StrBuf
 982  * @brief Strip leading and trailing spaces from a string; with premeasured and adjusted length.
 983  * @param Buf the string to modify
 984  */
 985 void StrBufTrim(StrBuf *Buf)
 986 {
 987         int delta = 0;
 988         if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
 989
 990         while ((Buf->BufUsed > 0) &&
 991                isspace(Buf->buf[Buf->BufUsed - 1]))
 992         {
 993                 Buf->BufUsed --;
 994         }
 995         Buf->buf[Buf->BufUsed] = '\0';
 996
 997         if (Buf->BufUsed == 0) return;
 998
 999         while ((Buf->BufUsed > delta) && (isspace(Buf->buf[delta]))){
1000                 delta ++;
1001         }
1002         if (delta > 0) StrBufCutLeft(Buf, delta);
1003 }
1004
1005 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary)
1006 {
1007         const char *pBuff;
1008         const char *pLeft;
1009         const char *pRight;
1010
1011         if (Buf == NULL)
1012                 return;
1013         pLeft = pBuff = Buf->buf;
1014         while (pBuff != NULL) {
1015                 pLeft = pBuff;
1016                 pBuff = strchr(pBuff, leftboundary);
1017                 if (pBuff != NULL)
1018                         pBuff++;
1019         }
1020
1021         if (pLeft != NULL)
1022                 pBuff = pLeft;
1023         else
1024                 pBuff = Buf->buf;
1025         pRight = strchr(pBuff, rightboundary);
1026         if (pRight != NULL)
1027                 StrBufCutAt(Buf, 0, pRight);
1028         if (pLeft != NULL)
1029                 StrBufCutLeft(Buf, pLeft - Buf->buf);
1030 }
1031
1032
1033 /**
1034  * @ingroup StrBuf_Filler
1035  * @brief uppercase the contents of a buffer
1036  * @param Buf the buffer to translate
1037  */
1038 void StrBufUpCase(StrBuf *Buf)
1039 {
1040         char *pch, *pche;
1041
1042         if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1043
1044         pch = Buf->buf;
1045         pche = pch + Buf->BufUsed;
1046         while (pch < pche) {
1047                 *pch = toupper(*pch);
1048                 pch ++;
1049         }
1050 }
1051
1052
1053 /**
1054  * @ingroup StrBuf_Filler
1055  * @brief lowercase the contents of a buffer
1056  * @param Buf the buffer to translate
1057  */
1058 void StrBufLowerCase(StrBuf *Buf)
1059 {
1060         char *pch, *pche;
1061
1062         if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1063
1064         pch = Buf->buf;
1065         pche = pch + Buf->BufUsed;
1066         while (pch < pche) {
1067                 *pch = tolower(*pch);
1068                 pch ++;
1069         }
1070 }
1071
1072
1073 /*******************************************************************************
1074  *           a tokenizer that kills, maims, and destroys                       *
1075  *******************************************************************************/
1076
1077 /**
1078  * @ingroup StrBuf_Tokenizer
1079  * @brief Replace a token at a given place with a given length by another token with given length
1080  * @param Buf String where to work on
1081  * @param where where inside of the Buf is the search-token
1082  * @param HowLong How long is the token to be replaced
1083  * @param Repl Token to insert at 'where'
1084  * @param ReplLen Length of repl
1085  * @returns -1 if fail else length of resulting Buf
1086  */
1087 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong,
1088                        const char *Repl, long ReplLen)
1089 {
1090
1091         if ((Buf == NULL) ||
1092             (where > Buf->BufUsed) ||
1093             (where + HowLong > Buf->BufUsed))
1094                 return -1;
1095
1096         if (where + ReplLen - HowLong > Buf->BufSize)
1097                 if (IncreaseBuf(Buf, 1, Buf->BufUsed + ReplLen) < 0)
1098                         return -1;
1099
1100         memmove(Buf->buf + where + ReplLen,
1101                 Buf->buf + where + HowLong,
1102                 Buf->BufUsed - where - HowLong);
1103
1104         memcpy(Buf->buf + where,
1105                Repl, ReplLen);
1106
1107         Buf->BufUsed += ReplLen - HowLong;
1108
1109         return Buf->BufUsed;
1110 }
1111
1112 /**
1113  * @ingroup StrBuf_Tokenizer
1114  * @brief Counts the numbmer of tokens in a buffer
1115  * @param source String to count tokens in
1116  * @param tok    Tokenizer char to count
1117  * @returns numbers of tokenizer chars found
1118  */
1119 int StrBufNum_tokens(const StrBuf *source, char tok)
1120 {
1121         char *pch, *pche;
1122         long NTokens;
1123         if ((source == NULL) || (source->BufUsed == 0))
1124                 return 0;
1125         if ((source->BufUsed == 1) && (*source->buf == tok))
1126                 return 2;
1127         NTokens = 1;
1128         pch = source->buf;
1129         pche = pch + source->BufUsed;
1130         while (pch < pche)
1131         {
1132                 if (*pch == tok)
1133                         NTokens ++;
1134                 pch ++;
1135         }
1136         return NTokens;
1137 }
1138
1139 /**
1140  * @ingroup StrBuf_Tokenizer
1141  * @brief a string tokenizer
1142  * @param Source StringBuffer to read into
1143  * @param parmnum n'th Parameter to remove
1144  * @param separator tokenizer character
1145  * @returns -1 if not found, else length of token.
1146  */
1147 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator)
1148 {
1149         int ReducedBy;
1150         char *d, *s, *end;              /* dest, source */
1151         int count = 0;
1152
1153         /* Find desired @parameter */
1154         end = Source->buf + Source->BufUsed;
1155         d = Source->buf;
1156         while ((d <= end) &&
1157                (count < parmnum))
1158         {
1159                 /* End of string, bail! */
1160                 if (!*d) {
1161                         d = NULL;
1162                         break;
1163                 }
1164                 if (*d == separator) {
1165                         count++;
1166                 }
1167                 d++;
1168         }
1169         if ((d == NULL) || (d >= end))
1170                 return 0;               /* @Parameter not found */
1171
1172         /* Find next @parameter */
1173         s = d;
1174         while ((s <= end) &&
1175                (*s && *s != separator))
1176         {
1177                 s++;
1178         }
1179         if (*s == separator)
1180                 s++;
1181         ReducedBy = d - s;
1182
1183         /* Hack and slash */
1184         if (s >= end) {
1185                 return 0;
1186         }
1187         else if (*s) {
1188                 memmove(d, s, Source->BufUsed - (s - Source->buf));
1189                 Source->BufUsed += ReducedBy;
1190                 Source->buf[Source->BufUsed] = '\0';
1191         }
1192         else if (d == Source->buf) {
1193                 *d = 0;
1194                 Source->BufUsed = 0;
1195         }
1196         else {
1197                 *--d = '\0';
1198                 Source->BufUsed += ReducedBy;
1199         }
1200         /*
1201         while (*s) {
1202                 *d++ = *s++;
1203         }
1204         *d = 0;
1205         */
1206         return ReducedBy;
1207 }
1208
1209
1210 /**
1211  * @ingroup StrBuf_Tokenizer
1212  * @brief a string tokenizer
1213  * @param dest Destination StringBuffer
1214  * @param Source StringBuffer to read into
1215  * @param parmnum n'th Parameter to extract
1216  * @param separator tokenizer character
1217  * @returns -1 if not found, else length of token.
1218  */
1219 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator)
1220 {
1221         const char *s, *e;              //* source * /
1222         int len = 0;                    //* running total length of extracted string * /
1223         int current_token = 0;          //* token currently being processed * /
1224
1225         if (dest != NULL) {
1226                 dest->buf[0] = '\0';
1227                 dest->BufUsed = 0;
1228         }
1229         else
1230                 return(-1);
1231
1232         if ((Source == NULL) || (Source->BufUsed ==0)) {
1233                 return(-1);
1234         }
1235         s = Source->buf;
1236         e = s + Source->BufUsed;
1237
1238         //cit_backtrace();
1239         //lprintf (CTDL_DEBUG, "test >: n: %d sep: %c source: %s \n willi \n", parmnum, separator, source);
1240
1241         while ((s < e) && !IsEmptyStr(s)) {
1242                 if (*s == separator) {
1243                         ++current_token;
1244                 }
1245                 if (len >= dest->BufSize) {
1246                         dest->BufUsed = len;
1247                         if (IncreaseBuf(dest, 1, -1) < 0) {
1248                                 dest->BufUsed --;
1249                                 break;
1250                         }
1251                 }
1252                 if ( (current_token == parmnum) &&
1253                      (*s != separator)) {
1254                         dest->buf[len] = *s;
1255                         ++len;
1256                 }
1257                 else if (current_token > parmnum) {
1258                         break;
1259                 }
1260                 ++s;
1261         }
1262
1263         dest->buf[len] = '\0';
1264         dest->BufUsed = len;
1265
1266         if (current_token < parmnum) {
1267                 //lprintf (CTDL_DEBUG,"test <!: %s\n", dest);
1268                 return(-1);
1269         }
1270         //lprintf (CTDL_DEBUG,"test <: %d; %s\n", len, dest);
1271         return(len);
1272 }
1273
1274
1275
1276
1277
1278 /**
1279  * @ingroup StrBuf_Tokenizer
1280  * @brief a string tokenizer to fetch an integer
1281  * @param Source String containing tokens
1282  * @param parmnum n'th Parameter to extract
1283  * @param separator tokenizer character
1284  * @returns 0 if not found, else integer representation of the token
1285  */
1286 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator)
1287 {
1288         StrBuf tmp;
1289         char buf[64];
1290
1291         tmp.buf = buf;
1292         buf[0] = '\0';
1293         tmp.BufSize = 64;
1294         tmp.BufUsed = 0;
1295         tmp.ConstBuf = 1;
1296         if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0)
1297                 return(atoi(buf));
1298         else
1299                 return 0;
1300 }
1301
1302 /**
1303  * @ingroup StrBuf_Tokenizer
1304  * @brief a string tokenizer to fetch a long integer
1305  * @param Source String containing tokens
1306  * @param parmnum n'th Parameter to extract
1307  * @param separator tokenizer character
1308  * @returns 0 if not found, else long integer representation of the token
1309  */
1310 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator)
1311 {
1312         StrBuf tmp;
1313         char buf[64];
1314
1315         tmp.buf = buf;
1316         buf[0] = '\0';
1317         tmp.BufSize = 64;
1318         tmp.BufUsed = 0;
1319         tmp.ConstBuf = 1;
1320         if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0)
1321                 return(atoi(buf));
1322         else
1323                 return 0;
1324 }
1325
1326
1327 /**
1328  * @ingroup StrBuf_Tokenizer
1329  * @brief a string tokenizer to fetch an unsigned long
1330  * @param Source String containing tokens
1331  * @param parmnum n'th Parameter to extract
1332  * @param separator tokenizer character
1333  * @returns 0 if not found, else unsigned long representation of the token
1334  */
1335 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator)
1336 {
1337         StrBuf tmp;
1338         char buf[64];
1339         char *pnum;
1340
1341         tmp.buf = buf;
1342         buf[0] = '\0';
1343         tmp.BufSize = 64;
1344         tmp.BufUsed = 0;
1345         tmp.ConstBuf = 1;
1346         if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0) {
1347                 pnum = &buf[0];
1348                 if (*pnum == '-')
1349                         pnum ++;
1350                 return (unsigned long) atol(pnum);
1351         }
1352         else
1353                 return 0;
1354 }
1355
1356
1357
1358 /**
1359  * @ingroup StrBuf_NextTokenizer
1360  * @brief a string tokenizer; Bounds checker
1361  *  function to make shure whether StrBufExtract_NextToken and friends have reached the end of the string.
1362  * @param Source our tokenbuffer
1363  * @param pStart the token iterator pointer to inspect
1364  * @returns whether the revolving pointer is inside of the search range
1365  */
1366 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart)
1367 {
1368         if ((Source == NULL) ||
1369             (*pStart == StrBufNOTNULL) ||
1370             (Source->BufUsed == 0))
1371         {
1372                 return 0;
1373         }
1374         if (*pStart == NULL)
1375         {
1376                 return 1;
1377         }
1378         else if (*pStart > Source->buf + Source->BufUsed)
1379         {
1380                 return 0;
1381         }
1382         else if (*pStart <= Source->buf)
1383         {
1384                 return 0;
1385         }
1386
1387         return 1;
1388 }
1389
1390 /**
1391  * @ingroup StrBuf_NextTokenizer
1392  * @brief a string tokenizer
1393  * @param dest Destination StringBuffer
1394  * @param Source StringBuffer to read into
1395  * @param pStart pointer to the end of the last token. Feed with NULL on start.
1396  * @param separator tokenizer
1397  * @returns -1 if not found, else length of token.
1398  */
1399 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator)
1400 {
1401         const char *s;          /* source */
1402         const char *EndBuffer;  /* end stop of source buffer */
1403         int current_token = 0;  /* token currently being processed */
1404         int len = 0;            /* running total length of extracted string */
1405
1406         if ((Source          == NULL) ||
1407             (Source->BufUsed == 0)      )
1408         {
1409                 *pStart = StrBufNOTNULL;
1410                 return -1;
1411         }
1412
1413         EndBuffer = Source->buf + Source->BufUsed;
1414
1415         if (dest != NULL)
1416         {
1417                 dest->buf[0] = '\0';
1418                 dest->BufUsed = 0;
1419         }
1420         else
1421         {
1422                 *pStart = EndBuffer + 1;
1423                 return -1;
1424         }
1425
1426         if (*pStart == NULL)
1427         {
1428                 *pStart = Source->buf; /* we're starting to examine this buffer. */
1429         }
1430         else if ((*pStart < Source->buf) ||
1431                  (*pStart > EndBuffer  )   )
1432         {
1433                 return -1; /* no more tokens to find. */
1434         }
1435
1436         s = *pStart;
1437         /* start to find the next token */
1438         while ((s <= EndBuffer)      &&
1439                (current_token == 0) )
1440         {
1441                 if (*s == separator)
1442                 {
1443                         /* we found the next token */
1444                         ++current_token;
1445                 }
1446
1447                 if (len >= dest->BufSize)
1448                 {
1449                         /* our Dest-buffer isn't big enough, increase it. */
1450                         dest->BufUsed = len;
1451
1452                         if (IncreaseBuf(dest, 1, -1) < 0) {
1453                                 /* WHUT? no more mem? bail out. */
1454                                 s = EndBuffer;
1455                                 dest->BufUsed --;
1456                                 break;
1457                         }
1458                 }
1459
1460                 if ( (current_token == 0 ) &&   /* are we in our target token? */
1461                      (!IsEmptyStr(s)     ) &&
1462                      (separator     != *s)    ) /* don't copy the token itself */
1463                 {
1464                         dest->buf[len] = *s;    /* Copy the payload */
1465                         ++len;                  /* remember the bigger size. */
1466                 }
1467
1468                 ++s;
1469         }
1470
1471         /* did we reach the end? */
1472         if ((s > EndBuffer)) {
1473                 EndBuffer = StrBufNOTNULL;
1474                 *pStart = EndBuffer;
1475         }
1476         else {
1477                 *pStart = s;  /* remember the position for the next run */
1478         }
1479
1480         /* sanitize our extracted token */
1481         dest->buf[len] = '\0';
1482         dest->BufUsed  = len;
1483
1484         return (len);
1485 }
1486
1487
1488 /**
1489  * @ingroup StrBuf_NextTokenizer
1490  * @brief a string tokenizer
1491  * @param Source StringBuffer to read from
1492  * @param pStart pointer to the end of the last token. Feed with NULL.
1493  * @param separator tokenizer character
1494  * @param nTokens number of tokens to fastforward over
1495  * @returns -1 if not found, else length of token.
1496  */
1497 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens)
1498 {
1499         const char *s, *EndBuffer;      //* source * /
1500         int len = 0;                    //* running total length of extracted string * /
1501         int current_token = 0;          //* token currently being processed * /
1502
1503         if ((Source == NULL) ||
1504             (Source->BufUsed ==0)) {
1505                 return(-1);
1506         }
1507         if (nTokens == 0)
1508                 return Source->BufUsed;
1509
1510         if (*pStart == NULL)
1511                 *pStart = Source->buf;
1512
1513         EndBuffer = Source->buf + Source->BufUsed;
1514
1515         if ((*pStart < Source->buf) ||
1516             (*pStart >  EndBuffer)) {
1517                 return (-1);
1518         }
1519
1520
1521         s = *pStart;
1522
1523         //cit_backtrace();
1524         //lprintf (CTDL_DEBUG, "test >: n: %d sep: %c source: %s \n willi \n", parmnum, separator, source);
1525
1526         while ((s < EndBuffer) && !IsEmptyStr(s)) {
1527                 if (*s == separator) {
1528                         ++current_token;
1529                 }
1530                 if (current_token >= nTokens) {
1531                         break;
1532                 }
1533                 ++s;
1534         }
1535         *pStart = s;
1536         (*pStart) ++;
1537
1538         return(len);
1539 }
1540
1541 /**
1542  * @ingroup StrBuf_NextTokenizer
1543  * @brief a string tokenizer to fetch an integer
1544  * @param Source StringBuffer to read from
1545  * @param pStart Cursor on the tokenstring
1546  * @param separator tokenizer character
1547  * @returns 0 if not found, else integer representation of the token
1548  */
1549 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator)
1550 {
1551         StrBuf tmp;
1552         char buf[64];
1553
1554         tmp.buf = buf;
1555         buf[0] = '\0';
1556         tmp.BufSize = 64;
1557         tmp.BufUsed = 0;
1558         tmp.ConstBuf = 1;
1559         if (StrBufExtract_NextToken(&tmp, Source, pStart, separator) > 0)
1560                 return(atoi(buf));
1561         else
1562                 return 0;
1563 }
1564
1565 /**
1566  * @ingroup StrBuf_NextTokenizer
1567  * @brief a string tokenizer to fetch a long integer
1568  * @param Source StringBuffer to read from
1569  * @param pStart Cursor on the tokenstring
1570  * @param separator tokenizer character
1571  * @returns 0 if not found, else long integer representation of the token
1572  */
1573 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator)
1574 {
1575         StrBuf tmp;
1576         char buf[64];
1577
1578         tmp.buf = buf;
1579         buf[0] = '\0';
1580         tmp.BufSize = 64;
1581         tmp.BufUsed = 0;
1582         tmp.ConstBuf = 1;
1583         if (StrBufExtract_NextToken(&tmp, Source, pStart, separator) > 0)
1584                 return(atoi(buf));
1585         else
1586                 return 0;
1587 }
1588
1589
1590 /**
1591  * @ingroup StrBuf_NextTokenizer
1592  * @brief a string tokenizer to fetch an unsigned long
1593  * @param Source StringBuffer to read from
1594  * @param pStart Cursor on the tokenstring
1595  * @param separator tokenizer character
1596  * @returns 0 if not found, else unsigned long representation of the token
1597  */
1598 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator)
1599 {
1600         StrBuf tmp;
1601         char buf[64];
1602         char *pnum;
1603
1604         tmp.buf = buf;
1605         buf[0] = '\0';
1606         tmp.BufSize = 64;
1607         tmp.BufUsed = 0;
1608         tmp.ConstBuf = 1;
1609         if (StrBufExtract_NextToken(&tmp, Source, pStart, separator) > 0) {
1610                 pnum = &buf[0];
1611                 if (*pnum == '-')
1612                         pnum ++;
1613                 return (unsigned long) atol(pnum);
1614         }
1615         else
1616                 return 0;
1617 }
1618
1619
1620
1621
1622
1623 /*******************************************************************************
1624  *                             Escape Appending                                *
1625  *******************************************************************************/
1626
1627 /**
1628  * @ingroup StrBuf_DeEnCoder
1629  * @brief Escape a string for feeding out as a URL while appending it to a Buffer
1630  * @param OutBuf the output buffer
1631  * @param In Buffer to encode
1632  * @param PlainIn way in from plain old c strings
1633  */
1634 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn)
1635 {
1636         const char *pch, *pche;
1637         char *pt, *pte;
1638         int len;
1639
1640         if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
1641                 return;
1642         if (PlainIn != NULL) {
1643                 len = strlen(PlainIn);
1644                 pch = PlainIn;
1645                 pche = pch + len;
1646         }
1647         else {
1648                 pch = In->buf;
1649                 pche = pch + In->BufUsed;
1650                 len = In->BufUsed;
1651         }
1652
1653         if (len == 0)
1654                 return;
1655
1656         pt = OutBuf->buf + OutBuf->BufUsed;
1657         pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
1658
1659         while (pch < pche) {
1660                 if (pt >= pte) {
1661                         IncreaseBuf(OutBuf, 1, -1);
1662                         pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
1663                         pt = OutBuf->buf + OutBuf->BufUsed;
1664                 }
1665
1666                 if((*pch >= 'a' && *pch <= 'z') ||
1667                    (*pch >= '@' && *pch <= 'Z') || /* @ A-Z */
1668                    (*pch >= '0' && *pch <= ':') || /* 0-9 : */
1669                    (*pch == '!') || (*pch == '_') ||
1670                    (*pch == ',') || (*pch == '.'))
1671                 {
1672                         *(pt++) = *(pch++);
1673                         OutBuf->BufUsed++;
1674                 }
1675                 else {
1676                         *pt = '%';
1677                         *(pt + 1) = HexList[(unsigned char)*pch][0];
1678                         *(pt + 2) = HexList[(unsigned char)*pch][1];
1679                         pt += 3;
1680                         OutBuf->BufUsed += 3;
1681                         pch ++;
1682                 }
1683         }
1684         *pt = '\0';
1685 }
1686
1687 /**
1688  * @ingroup StrBuf_DeEnCoder
1689  * @brief append a string in hex encoding to the buffer
1690  * @param OutBuf the output buffer
1691  * @param In Buffer to encode
1692  * @param PlainIn way in from plain old c strings
1693  */
1694 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn)
1695 {
1696         const char *pch, *pche;
1697         char *pt, *pte;
1698         int len;
1699
1700         if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
1701                 return;
1702         if (PlainIn != NULL) {
1703                 len = strlen(PlainIn);
1704                 pch = PlainIn;
1705                 pche = pch + len;
1706         }
1707         else {
1708                 pch = In->buf;
1709                 pche = pch + In->BufUsed;
1710                 len = In->BufUsed;
1711         }
1712
1713         if (len == 0)
1714                 return;
1715
1716         pt = OutBuf->buf + OutBuf->BufUsed;
1717         pte = OutBuf->buf + OutBuf->BufSize - 3; /**< we max append 3 chars at once plus the \0 */
1718
1719         while (pch < pche) {
1720                 if (pt >= pte) {
1721                         IncreaseBuf(OutBuf, 1, -1);
1722                         pte = OutBuf->buf + OutBuf->BufSize - 3; /**< we max append 3 chars at once plus the \0 */
1723                         pt = OutBuf->buf + OutBuf->BufUsed;
1724                 }
1725
1726                 *pt = HexList[(unsigned char)*pch][0];
1727                 pt ++;
1728                 *pt = HexList[(unsigned char)*pch][1];
1729                 pt ++; pch ++; OutBuf->BufUsed += 2;
1730         }
1731         *pt = '\0';
1732 }
1733
1734 /**
1735  * @ingroup StrBuf_DeEnCoder
1736  * @brief Append a string, escaping characters which have meaning in HTML.
1737  *
1738  * @param Target        target buffer
1739  * @param Source        source buffer; set to NULL if you just have a C-String
1740  * @param PlainIn       Plain-C string to append; set to NULL if unused
1741  * @param nbsp          If nonzero, spaces are converted to non-breaking spaces.
1742  * @param nolinebreaks  if set to 1, linebreaks are removed from the string.
1743  *                      if set to 2, linebreaks are replaced by &ltbr/&gt
1744  */
1745 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks)
1746 {
1747         const char *aptr, *eiptr;
1748         char *bptr, *eptr;
1749         long len;
1750
1751         if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
1752                 return -1;
1753
1754         if (PlainIn != NULL) {
1755                 aptr = PlainIn;
1756                 len = strlen(PlainIn);
1757                 eiptr = aptr + len;
1758         }
1759         else {
1760                 aptr = Source->buf;
1761                 eiptr = aptr + Source->BufUsed;
1762                 len = Source->BufUsed;
1763         }
1764
1765         if (len == 0)
1766                 return -1;
1767
1768         bptr = Target->buf + Target->BufUsed;
1769         eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in...  */
1770
1771         while (aptr < eiptr){
1772                 if(bptr >= eptr) {
1773                         IncreaseBuf(Target, 1, -1);
1774                         eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in...  */
1775                         bptr = Target->buf + Target->BufUsed;
1776                 }
1777                 if (*aptr == '<') {
1778                         memcpy(bptr, "&lt;", 4);
1779                         bptr += 4;
1780                         Target->BufUsed += 4;
1781                 }
1782                 else if (*aptr == '>') {
1783                         memcpy(bptr, "&gt;", 4);
1784                         bptr += 4;
1785                         Target->BufUsed += 4;
1786                 }
1787                 else if (*aptr == '&') {
1788                         memcpy(bptr, "&amp;", 5);
1789                         bptr += 5;
1790                         Target->BufUsed += 5;
1791                 }
1792                 else if (*aptr == '"') {
1793                         memcpy(bptr, "&quot;", 6);
1794                         bptr += 6;
1795                         Target->BufUsed += 6;
1796                 }
1797                 else if (*aptr == '\'') {
1798                         memcpy(bptr, "&#39;", 5);
1799                         bptr += 5;
1800                         Target->BufUsed += 5;
1801                 }
1802                 else if (*aptr == LB) {
1803                         *bptr = '<';
1804                         bptr ++;
1805                         Target->BufUsed ++;
1806                 }
1807                 else if (*aptr == RB) {
1808                         *bptr = '>';
1809                         bptr ++;
1810                         Target->BufUsed ++;
1811                 }
1812                 else if (*aptr == QU) {
1813                         *bptr ='"';
1814                         bptr ++;
1815                         Target->BufUsed ++;
1816                 }
1817                 else if ((*aptr == 32) && (nbsp == 1)) {
1818                         memcpy(bptr, "&nbsp;", 6);
1819                         bptr += 6;
1820                         Target->BufUsed += 6;
1821                 }
1822                 else if ((*aptr == '\n') && (nolinebreaks == 1)) {
1823                         *bptr='\0';     /* nothing */
1824                 }
1825                 else if ((*aptr == '\n') && (nolinebreaks == 2)) {
1826                         memcpy(bptr, "&lt;br/&gt;", 11);
1827                         bptr += 11;
1828                         Target->BufUsed += 11;
1829                 }
1830
1831
1832                 else if ((*aptr == '\r') && (nolinebreaks != 0)) {
1833                         *bptr='\0';     /* nothing */
1834                 }
1835                 else{
1836                         *bptr = *aptr;
1837                         bptr++;
1838                         Target->BufUsed ++;
1839                 }
1840                 aptr ++;
1841         }
1842         *bptr = '\0';
1843         if ((bptr = eptr - 1 ) && !IsEmptyStr(aptr) )
1844                 return -1;
1845         return Target->BufUsed;
1846 }
1847
1848 /**
1849  * @ingroup StrBuf_DeEnCoder
1850  * @brief Append a string, escaping characters which have meaning in HTML.
1851  * Converts linebreaks into blanks; escapes single quotes
1852  * @param Target        target buffer
1853  * @param Source        source buffer; set to NULL if you just have a C-String
1854  * @param PlainIn       Plain-C string to append; set to NULL if unused
1855  */
1856 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn)
1857 {
1858         const char *aptr, *eiptr;
1859         char *tptr, *eptr;
1860         long len;
1861
1862         if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
1863                 return ;
1864
1865         if (PlainIn != NULL) {
1866                 aptr = PlainIn;
1867                 len = strlen(PlainIn);
1868                 eiptr = aptr + len;
1869         }
1870         else {
1871                 aptr = Source->buf;
1872                 eiptr = aptr + Source->BufUsed;
1873                 len = Source->BufUsed;
1874         }
1875
1876         if (len == 0)
1877                 return;
1878
1879         eptr = Target->buf + Target->BufSize - 8;
1880         tptr = Target->buf + Target->BufUsed;
1881
1882         while (aptr < eiptr){
1883                 if(tptr >= eptr) {
1884                         IncreaseBuf(Target, 1, -1);
1885                         eptr = Target->buf + Target->BufSize - 8;
1886                         tptr = Target->buf + Target->BufUsed;
1887                 }
1888
1889                 if (*aptr == '\n') {
1890                         *tptr = ' ';
1891                         Target->BufUsed++;
1892                 }
1893                 else if (*aptr == '\r') {
1894                         *tptr = ' ';
1895                         Target->BufUsed++;
1896                 }
1897                 else if (*aptr == '\'') {
1898                         *(tptr++) = '&';
1899                         *(tptr++) = '#';
1900                         *(tptr++) = '3';
1901                         *(tptr++) = '9';
1902                         *tptr = ';';
1903                         Target->BufUsed += 5;
1904                 } else {
1905                         *tptr = *aptr;
1906                         Target->BufUsed++;
1907                 }
1908                 tptr++; aptr++;
1909         }
1910         *tptr = '\0';
1911 }
1912
1913
1914
1915 /**
1916  * @ingroup StrBuf_DeEnCoder
1917  * @brief Append a string, escaping characters which have meaning in ICAL.
1918  * [\n,]
1919  * @param Target        target buffer
1920  * @param Source        source buffer; set to NULL if you just have a C-String
1921  * @param PlainIn       Plain-C string to append; set to NULL if unused
1922  */
1923 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn)
1924 {
1925         const char *aptr, *eiptr;
1926         char *tptr, *eptr;
1927         long len;
1928
1929         if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
1930                 return ;
1931
1932         if (PlainIn != NULL) {
1933                 aptr = PlainIn;
1934                 len = strlen(PlainIn);
1935                 eiptr = aptr + len;
1936         }
1937         else {
1938                 aptr = Source->buf;
1939                 eiptr = aptr + Source->BufUsed;
1940                 len = Source->BufUsed;
1941         }
1942
1943         if (len == 0)
1944                 return;
1945
1946         eptr = Target->buf + Target->BufSize - 8;
1947         tptr = Target->buf + Target->BufUsed;
1948
1949         while (aptr < eiptr){
1950                 if(tptr + 3 >= eptr) {
1951                         IncreaseBuf(Target, 1, -1);
1952                         eptr = Target->buf + Target->BufSize - 8;
1953                         tptr = Target->buf + Target->BufUsed;
1954                 }
1955
1956                 if (*aptr == '\n') {
1957                         *tptr = '\\';
1958                         Target->BufUsed++;
1959                         tptr++;
1960                         *tptr = 'n';
1961                         Target->BufUsed++;
1962                 }
1963                 else if (*aptr == '\r') {
1964                         *tptr = '\\';
1965                         Target->BufUsed++;
1966                         tptr++;
1967                         *tptr = 'r';
1968                         Target->BufUsed++;
1969                 }
1970                 else if (*aptr == ',') {
1971                         *tptr = '\\';
1972                         Target->BufUsed++;
1973                         tptr++;
1974                         *tptr = ',';
1975                         Target->BufUsed++;
1976                 } else {
1977                         *tptr = *aptr;
1978                         Target->BufUsed++;
1979                 }
1980                 tptr++; aptr++;
1981         }
1982         *tptr = '\0';
1983 }
1984
1985 /**
1986  * @ingroup StrBuf_DeEnCoder
1987  * @brief Append a string, escaping characters which have meaning in JavaScript strings .
1988  *
1989  * @param Target        target buffer
1990  * @param Source        source buffer; set to NULL if you just have a C-String
1991  * @param PlainIn       Plain-C string to append; set to NULL if unused
1992  * @returns size of result or -1
1993  */
1994 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn)
1995 {
1996         const char *aptr, *eiptr;
1997         char *bptr, *eptr;
1998         long len;
1999
2000         if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2001                 return -1;
2002
2003         if (PlainIn != NULL) {
2004                 aptr = PlainIn;
2005                 len = strlen(PlainIn);
2006                 eiptr = aptr + len;
2007         }
2008         else {
2009                 aptr = Source->buf;
2010                 eiptr = aptr + Source->BufUsed;
2011                 len = Source->BufUsed;
2012         }
2013
2014         if (len == 0)
2015                 return -1;
2016
2017         bptr = Target->buf + Target->BufUsed;
2018         eptr = Target->buf + Target->BufSize - 7; /* our biggest unit to put in...  */
2019
2020         while (aptr < eiptr){
2021                 if(bptr >= eptr) {
2022                         IncreaseBuf(Target, 1, -1);
2023                         eptr = Target->buf + Target->BufSize - 7; /* our biggest unit to put in...  */
2024                         bptr = Target->buf + Target->BufUsed;
2025                 }
2026                 switch (*aptr) {
2027                 case '\n':
2028                         memcpy(bptr, HKEY("\\n"));
2029                         bptr += 2;
2030                         Target->BufUsed += 2;
2031                         break;
2032                 case '\r':
2033                         memcpy(bptr, HKEY("\\r"));
2034                         bptr += 2;
2035                         Target->BufUsed += 2;
2036                         break;
2037                 case '"':
2038                         *bptr = '\\';
2039                         bptr ++;
2040                         *bptr = '"';
2041                         bptr ++;
2042                         Target->BufUsed += 2;
2043                         break;
2044                 case '\\':
2045                         if ((*(aptr + 1) == 'u') &&
2046                             isxdigit(*(aptr + 2)) &&
2047                             isxdigit(*(aptr + 3)) &&
2048                             isxdigit(*(aptr + 4)) &&
2049                             isxdigit(*(aptr + 5)))
2050                         { /* oh, a unicode escaper. let it pass through. */
2051                                 memcpy(bptr, aptr, 6);
2052                                 aptr += 5;
2053                                 bptr +=6;
2054                                 Target->BufUsed += 6;
2055                         }
2056                         else
2057                         {
2058                                 *bptr = '\\';
2059                                 bptr ++;
2060                                 *bptr = '\\';
2061                                 bptr ++;
2062                                 Target->BufUsed += 2;
2063                         }
2064                         break;
2065                 case '\b':
2066                         *bptr = '\\';
2067                         bptr ++;
2068                         *bptr = 'b';
2069                         bptr ++;
2070                         Target->BufUsed += 2;
2071                         break;
2072                 case '\f':
2073                         *bptr = '\\';
2074                         bptr ++;
2075                         *bptr = 'f';
2076                         bptr ++;
2077                         Target->BufUsed += 2;
2078                         break;
2079                 case '\t':
2080                         *bptr = '\\';
2081                         bptr ++;
2082                         *bptr = 't';
2083                         bptr ++;
2084                         Target->BufUsed += 2;
2085                         break;
2086                 default:
2087                         IsUtf8Sequence =  Ctdl_GetUtf8SequenceLength(aptr, eiptr);
2088                         while (IsUtf8Sequence > 0){
2089                                 *bptr = *aptr;
2090                                 Target->BufUsed ++;
2091                                 if (--IsUtf8Sequence)
2092                                         aptr++;
2093                                 bptr++;
2094                         }
2095                 }
2096                 aptr ++;
2097         }
2098         *bptr = '\0';
2099         if ((bptr == eptr - 1 ) && !IsEmptyStr(aptr) )
2100                 return -1;
2101         return Target->BufUsed;
2102 }
2103
2104 /**
2105  * @ingroup StrBuf_DeEnCoder
2106  * @brief Append a string, escaping characters which have meaning in HTML + json.
2107  *
2108  * @param Target        target buffer
2109  * @param Source        source buffer; set to NULL if you just have a C-String
2110  * @param PlainIn       Plain-C string to append; set to NULL if unused
2111  * @param nbsp          If nonzero, spaces are converted to non-breaking spaces.
2112  * @param nolinebreaks  if set to 1, linebreaks are removed from the string.
2113  *                      if set to 2, linebreaks are replaced by &ltbr/&gt
2114  */
2115 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks)
2116 {
2117         const char *aptr, *eiptr;
2118         char *bptr, *eptr;
2119         long len;
2120         int IsUtf8Sequence = 0;
2121
2122         if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2123                 return -1;
2124
2125         if (PlainIn != NULL) {
2126                 aptr = PlainIn;
2127                 len = strlen(PlainIn);
2128                 eiptr = aptr + len;
2129         }
2130         else {
2131                 aptr = Source->buf;
2132                 eiptr = aptr + Source->BufUsed;
2133                 len = Source->BufUsed;
2134         }
2135
2136         if (len == 0)
2137                 return -1;
2138
2139         bptr = Target->buf + Target->BufUsed;
2140         eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in...  */
2141
2142         while (aptr < eiptr){
2143                 if(bptr >= eptr) {
2144                         IncreaseBuf(Target, 1, -1);
2145                         eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in...  */
2146                         bptr = Target->buf + Target->BufUsed;
2147                 }
2148                 switch (*aptr) {
2149                 case '<':
2150                         memcpy(bptr, HKEY("&lt;"));
2151                         bptr += 4;
2152                         Target->BufUsed += 4;
2153                         break;
2154                 case '>':
2155                         memcpy(bptr, HKEY("&gt;"));
2156                         bptr += 4;
2157                         Target->BufUsed += 4;
2158                         break;
2159                 case '&':
2160                         memcpy(bptr, HKEY("&amp;"));
2161                         bptr += 5;
2162                         Target->BufUsed += 5;
2163                         break;
2164                 case LB:
2165                         *bptr = '<';
2166                         bptr ++;
2167                         Target->BufUsed ++;
2168                         break;
2169                 case RB:
2170                         *bptr = '>';
2171                         bptr ++;
2172                         Target->BufUsed ++;
2173                         break;
2174                 case '\n':
2175                         switch (nolinebreaks) {
2176                         case 1:
2177                                 *bptr='\0';     /* nothing */
2178                                 break;
2179                         case 2:
2180                                 memcpy(bptr, HKEY("&lt;br/&gt;"));
2181                                 bptr += 11;
2182                                 Target->BufUsed += 11;
2183                                 break;
2184                         default:
2185                                 memcpy(bptr, HKEY("\\n"));
2186                                 bptr += 2;
2187                                 Target->BufUsed += 2;
2188                         }
2189                         break;
2190                 case '\r':
2191                         switch (nolinebreaks) {
2192                         case 1:
2193                         case 2:
2194                                 *bptr='\0';     /* nothing */
2195                                 break;
2196                         default:
2197                                 memcpy(bptr, HKEY("\\r"));
2198                                 bptr += 2;
2199                                 Target->BufUsed += 2;
2200                                 break;
2201                         }
2202                         break;
2203                 case '"':
2204                 case QU:
2205                         *bptr = '\\';
2206                         bptr ++;
2207                         *bptr = '"';
2208                         bptr ++;
2209                         Target->BufUsed += 2;
2210                         break;
2211                 case '\\':
2212                         if ((*(aptr + 1) == 'u') &&
2213                             isxdigit(*(aptr + 2)) &&
2214                             isxdigit(*(aptr + 3)) &&
2215                             isxdigit(*(aptr + 4)) &&
2216                             isxdigit(*(aptr + 5)))
2217                         { /* oh, a unicode escaper. let it pass through. */
2218                                 memcpy(bptr, aptr, 6);
2219                                 aptr += 5;
2220                                 bptr +=6;
2221                                 Target->BufUsed += 6;
2222                         }
2223                         else
2224                         {
2225                                 *bptr = '\\';
2226                                 bptr ++;
2227                                 *bptr = '\\';
2228                                 bptr ++;
2229                                 Target->BufUsed += 2;
2230                         }
2231                         break;
2232                 case '\b':
2233                         *bptr = '\\';
2234                         bptr ++;
2235                         *bptr = 'b';
2236                         bptr ++;
2237                         Target->BufUsed += 2;
2238                         break;
2239                 case '\f':
2240                         *bptr = '\\';
2241                         bptr ++;
2242                         *bptr = 'f';
2243                         bptr ++;
2244                         Target->BufUsed += 2;
2245                         break;
2246                 case '\t':
2247                         *bptr = '\\';
2248                         bptr ++;
2249                         *bptr = 't';
2250                         bptr ++;
2251                         Target->BufUsed += 2;
2252                         break;
2253                 case  32:
2254                         if (nbsp == 1) {
2255                                 memcpy(bptr, HKEY("&nbsp;"));
2256                                 bptr += 6;
2257                                 Target->BufUsed += 6;
2258                                 break;
2259                         }
2260                 default:
2261                         IsUtf8Sequence =  Ctdl_GetUtf8SequenceLength(aptr, eiptr);
2262                         while (IsUtf8Sequence > 0){
2263                                 *bptr = *aptr;
2264                                 Target->BufUsed ++;
2265                                 if (--IsUtf8Sequence)
2266                                         aptr++;
2267                                 bptr++;
2268                         }
2269                 }
2270                 aptr ++;
2271         }
2272         *bptr = '\0';
2273         if ((bptr = eptr - 1 ) && !IsEmptyStr(aptr) )
2274                 return -1;
2275         return Target->BufUsed;
2276 }
2277
2278 /**
2279  * @ingroup StrBuf_DeEnCoder
2280  * @brief unhide special chars hidden to the HTML escaper
2281  * @param target buffer to put the unescaped string in
2282  * @param source buffer to unescape
2283  */
2284 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source)
2285 {
2286         int a, b, len;
2287         char hex[3];
2288
2289         if (target != NULL)
2290                 FlushStrBuf(target);
2291
2292         if (source == NULL ||target == NULL)
2293         {
2294                 return;
2295         }
2296
2297         len = source->BufUsed;
2298         for (a = 0; a < len; ++a) {
2299                 if (target->BufUsed >= target->BufSize)
2300                         IncreaseBuf(target, 1, -1);
2301
2302                 if (source->buf[a] == '=') {
2303                         hex[0] = source->buf[a + 1];
2304                         hex[1] = source->buf[a + 2];
2305                         hex[2] = 0;
2306                         b = 0;
2307                         sscanf(hex, "%02x", &b);
2308                         target->buf[target->BufUsed] = b;
2309                         target->buf[++target->BufUsed] = 0;
2310                         a += 2;
2311                 }
2312                 else {
2313                         target->buf[target->BufUsed] = source->buf[a];
2314                         target->buf[++target->BufUsed] = 0;
2315                 }
2316         }
2317 }
2318
2319
2320 /**
2321  * @ingroup StrBuf_DeEnCoder
2322  * @brief hide special chars from the HTML escapers and friends
2323  * @param target buffer to put the escaped string in
2324  * @param source buffer to escape
2325  */
2326 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source)
2327 {
2328         int i, len;
2329
2330         if (target != NULL)
2331                 FlushStrBuf(target);
2332
2333         if (source == NULL ||target == NULL)
2334         {
2335                 return;
2336         }
2337
2338         len = source->BufUsed;
2339         for (i=0; i<len; ++i) {
2340                 if (target->BufUsed + 4 >= target->BufSize)
2341                         IncreaseBuf(target, 1, -1);
2342                 if ( (isalnum(source->buf[i])) ||
2343                      (source->buf[i]=='-') ||
2344                      (source->buf[i]=='_') ) {
2345                         target->buf[target->BufUsed++] = source->buf[i];
2346                 }
2347                 else {
2348                         sprintf(&target->buf[target->BufUsed],
2349                                 "=%02X",
2350                                 (0xFF &source->buf[i]));
2351                         target->BufUsed += 3;
2352                 }
2353         }
2354         target->buf[target->BufUsed + 1] = '\0';
2355 }
2356
2357
2358 /*******************************************************************************
2359  *                      Quoted Printable de/encoding                           *
2360  *******************************************************************************/
2361
2362 /**
2363  * @ingroup StrBuf_DeEnCoder
2364  * @brief decode a buffer from base 64 encoding; destroys original
2365  * @param Buf Buffor to transform
2366  */
2367 int StrBufDecodeBase64(StrBuf *Buf)
2368 {
2369         char *xferbuf;
2370         size_t siz;
2371         if (Buf == NULL) return -1;
2372
2373         xferbuf = (char*) malloc(Buf->BufSize);
2374         *xferbuf = '\0';
2375         siz = CtdlDecodeBase64(xferbuf,
2376                                Buf->buf,
2377                                Buf->BufUsed);
2378         free(Buf->buf);
2379         Buf->buf = xferbuf;
2380         Buf->BufUsed = siz;
2381         return siz;
2382 }
2383
2384 /**
2385  * @ingroup StrBuf_DeEnCoder
2386  * @brief decode a buffer from base 64 encoding; destroys original
2387  * @param Buf Buffor to transform
2388  */
2389 int StrBufDecodeHex(StrBuf *Buf)
2390 {
2391         unsigned int ch;
2392         char *pch, *pche, *pchi;
2393
2394         if (Buf == NULL) return -1;
2395
2396         pch = pchi = Buf->buf;
2397         pche = pch + Buf->BufUsed;
2398
2399         while (pchi < pche){
2400                 ch = decode_hex(pchi);
2401                 *pch = ch;
2402                 pch ++;
2403                 pchi += 2;
2404         }
2405
2406         *pch = '\0';
2407         Buf->BufUsed = pch - Buf->buf;
2408         return Buf->BufUsed;
2409 }
2410
2411 /**
2412  * @ingroup StrBuf_DeEnCoder
2413  * @brief replace all chars >0x20 && < 0x7F with Mute
2414  * @param Mute char to put over invalid chars
2415  * @param Buf Buffor to transform
2416  */
2417 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute)
2418 {
2419         unsigned char *pch;
2420
2421         if (Buf == NULL) return -1;
2422         pch = (unsigned char *)Buf->buf;
2423         while (pch < (unsigned char *)Buf->buf + Buf->BufUsed) {
2424                 if ((*pch < 0x20) || (*pch > 0x7F))
2425                         *pch = Mute;
2426                 pch ++;
2427         }
2428         return Buf->BufUsed;
2429 }
2430
2431
2432 /**
2433  * @ingroup StrBuf_DeEnCoder
2434  * @brief remove escaped strings from i.e. the url string (like %20 for blanks)
2435  * @param Buf Buffer to translate
2436  * @param StripBlanks Reduce several blanks to one?
2437  */
2438 long StrBufUnescape(StrBuf *Buf, int StripBlanks)
2439 {
2440         int a, b;
2441         char hex[3];
2442         long len;
2443
2444         if (Buf == NULL)
2445                 return -1;
2446
2447         while ((Buf->BufUsed > 0) && (isspace(Buf->buf[Buf->BufUsed - 1]))){
2448                 Buf->buf[Buf->BufUsed - 1] = '\0';
2449                 Buf->BufUsed --;
2450         }
2451
2452         a = 0;
2453         while (a < Buf->BufUsed) {
2454                 if (Buf->buf[a] == '+')
2455                         Buf->buf[a] = ' ';
2456                 else if (Buf->buf[a] == '%') {
2457                         /* don't let % chars through, rather truncate the input. */
2458                         if (a + 2 > Buf->BufUsed) {
2459                                 Buf->buf[a] = '\0';
2460                                 Buf->BufUsed = a;
2461                         }
2462                         else {
2463                                 hex[0] = Buf->buf[a + 1];
2464                                 hex[1] = Buf->buf[a + 2];
2465                                 hex[2] = 0;
2466                                 b = 0;
2467                                 sscanf(hex, "%02x", &b);
2468                                 Buf->buf[a] = (char) b;
2469                                 len = Buf->BufUsed - a - 2;
2470                                 if (len > 0)
2471                                         memmove(&Buf->buf[a + 1], &Buf->buf[a + 3], len);
2472
2473                                 Buf->BufUsed -=2;
2474                         }
2475                 }
2476                 a++;
2477         }
2478         return a;
2479 }
2480
2481
2482 /**
2483  * @ingroup StrBuf_DeEnCoder
2484  * @brief       RFC2047-encode a header field if necessary.
2485  *              If no non-ASCII characters are found, the string
2486  *              will be copied verbatim without encoding.
2487  *
2488  * @param       target          Target buffer.
2489  * @param       source          Source string to be encoded.
2490  * @returns     encoded length; -1 if non success.
2491  */
2492 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source)
2493 {
2494         const char headerStr[] = "=?UTF-8?Q?";
2495         int need_to_encode = 0;
2496         int i = 0;
2497         unsigned char ch;
2498
2499         if ((source == NULL) ||
2500             (target == NULL))
2501             return -1;
2502
2503         while ((i < source->BufUsed) &&
2504                (!IsEmptyStr (&source->buf[i])) &&
2505                (need_to_encode == 0)) {
2506                 if (((unsigned char) source->buf[i] < 32) ||
2507                     ((unsigned char) source->buf[i] > 126)) {
2508                         need_to_encode = 1;
2509                 }
2510                 i++;
2511         }
2512
2513         if (!need_to_encode) {
2514                 if (*target == NULL) {
2515                         *target = NewStrBufPlain(source->buf, source->BufUsed);
2516                 }
2517                 else {
2518                         FlushStrBuf(*target);
2519                         StrBufAppendBuf(*target, source, 0);
2520                 }
2521                 return (*target)->BufUsed;
2522         }
2523         if (*target == NULL)
2524                 *target = NewStrBufPlain(NULL, sizeof(headerStr) + source->BufUsed * 2);
2525         else if (sizeof(headerStr) + source->BufUsed >= (*target)->BufSize)
2526                 IncreaseBuf(*target, sizeof(headerStr) + source->BufUsed, 0);
2527         memcpy ((*target)->buf, headerStr, sizeof(headerStr) - 1);
2528         (*target)->BufUsed = sizeof(headerStr) - 1;
2529         for (i=0; (i < source->BufUsed); ++i) {
2530                 if ((*target)->BufUsed + 4 >= (*target)->BufSize)
2531                         IncreaseBuf(*target, 1, 0);
2532                 ch = (unsigned char) source->buf[i];
2533                 if ((ch  <  32) ||
2534                     (ch  > 126) ||
2535                     (ch ==  61) ||
2536                     (ch == '=') ||
2537                     (ch == '?') ||
2538                     (ch == '_') ||
2539                     (ch == '[') ||
2540                     (ch == ']')   )
2541                 {
2542                         sprintf(&(*target)->buf[(*target)->BufUsed], "=%02X", ch);
2543                         (*target)->BufUsed += 3;
2544                 }
2545                 else {
2546                         if (ch == ' ')
2547                                 (*target)->buf[(*target)->BufUsed] = '_';
2548                         else
2549                                 (*target)->buf[(*target)->BufUsed] = ch;
2550                         (*target)->BufUsed++;
2551                 }
2552         }
2553
2554         if ((*target)->BufUsed + 4 >= (*target)->BufSize)
2555                 IncreaseBuf(*target, 1, 0);
2556
2557         (*target)->buf[(*target)->BufUsed++] = '?';
2558         (*target)->buf[(*target)->BufUsed++] = '=';
2559         (*target)->buf[(*target)->BufUsed] = '\0';
2560         return (*target)->BufUsed;;
2561 }
2562
2563
2564
2565 static void AddRecipient(StrBuf *Target,
2566                          StrBuf *UserName,
2567                          StrBuf *EmailAddress,
2568                          StrBuf *EncBuf)
2569 {
2570         int QuoteMe = 0;
2571
2572         if (StrLength(Target) > 0) StrBufAppendBufPlain(Target, HKEY(", "), 0);
2573         if (strchr(ChrPtr(UserName), ',') != NULL) QuoteMe = 1;
2574
2575         if (QuoteMe)  StrBufAppendBufPlain(Target, HKEY("\""), 0);
2576         StrBufRFC2047encode(&EncBuf, UserName);
2577         StrBufAppendBuf(Target, EncBuf, 0);
2578         if (QuoteMe)  StrBufAppendBufPlain(Target, HKEY("\" "), 0);
2579         else          StrBufAppendBufPlain(Target, HKEY(" "), 0);
2580
2581         if (StrLength(EmailAddress) > 0){
2582                 StrBufAppendBufPlain(Target, HKEY("<"), 0);
2583                 StrBufAppendBuf(Target, EmailAddress, 0); /* TODO: what about IDN???? */
2584                 StrBufAppendBufPlain(Target, HKEY(">"), 0);
2585         }
2586 }
2587
2588
2589 /**
2590  * \brief QP encode parts of an email TO/CC/BCC vector, and strip/filter invalid parts
2591  * \param Recp Source list of email recipients
2592  * \param UserName Temporary buffer for internal use; Please provide valid buffer.
2593  * \param EmailAddress Temporary buffer for internal use; Please provide valid buffer.
2594  * \param EncBuf Temporary buffer for internal use; Please provide valid buffer.
2595  * \returns encoded & sanitized buffer with the contents of Recp; Caller owns this memory.
2596  */
2597 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
2598                                            StrBuf *UserName,
2599                                            StrBuf *EmailAddress,
2600                                            StrBuf *EncBuf)
2601 {
2602         StrBuf *Target;
2603         int need_to_encode;
2604
2605         const char *pch, *pche;
2606         const char *UserStart, *UserEnd, *EmailStart, *EmailEnd, *At;
2607
2608         if ((Recp == NULL) || (StrLength(Recp) == 0))
2609                 return NULL;
2610
2611         need_to_encode = 0;
2612         pch = ChrPtr(Recp);
2613         pche = pch + StrLength(Recp);
2614
2615         if (!CheckEncode(pch, -1, pche))
2616                 return NewStrBufDup(Recp);
2617
2618         Target = NewStrBufPlain(NULL, StrLength(Recp));
2619
2620         while ((pch != NULL) && (pch < pche))
2621         {
2622                 int ColonOk = 0;
2623
2624                 while (isspace(*pch)) pch++;
2625                 UserStart = UserEnd = EmailStart = EmailEnd = NULL;
2626
2627                 if ((*pch == '"') || (*pch == '\'')) {
2628                         UserStart = pch + 1;
2629
2630                         UserEnd = strchr(UserStart, *pch);
2631                         if (UserEnd == NULL)
2632                                 break; ///TODO: Userfeedback??
2633                         EmailStart = UserEnd + 1;
2634                         while (isspace(*EmailStart))
2635                                 EmailStart++;
2636                         if (UserEnd == UserStart) {
2637                                 UserStart = UserEnd = NULL;
2638                         }
2639
2640                         if (*EmailStart == '<') {
2641                                 EmailStart++;
2642                                 EmailEnd = strchr(EmailStart, '>');
2643                                 if (EmailEnd == NULL)
2644                                         EmailEnd = strchr(EmailStart, ',');
2645
2646                         }
2647                         else {
2648                                 EmailEnd = strchr(EmailStart, ',');
2649                         }
2650                         if (EmailEnd == NULL)
2651                                 EmailEnd = pche;
2652                         pch = EmailEnd + 1;
2653                         ColonOk = 1;
2654                 }
2655                 else {
2656                         int gt = 0;
2657                         UserStart = pch;
2658                         EmailEnd = strchr(UserStart, ',');
2659                         if (EmailEnd == NULL) {
2660                                 EmailEnd = strchr(pch, '>');
2661                                 pch = NULL;
2662                                 if (EmailEnd != NULL) {
2663                                         gt = 1;
2664                                 }
2665                                 else {
2666                                         EmailEnd = pche;
2667                                 }
2668                         }
2669                         else {
2670
2671                                 pch = EmailEnd + 1;
2672                                 while ((EmailEnd > UserStart) && !gt &&
2673                                        ((*EmailEnd == ',') ||
2674                                         (*EmailEnd == '>') ||
2675                                         (isspace(*EmailEnd))))
2676                                 {
2677                                         if (*EmailEnd == '>')
2678                                                 gt = 1;
2679                                         else
2680                                                 EmailEnd--;
2681                                 }
2682                                 if (EmailEnd == UserStart)
2683                                         break;
2684                         }
2685                         if (gt) {
2686                                 EmailStart = strchr(UserStart, '<');
2687                                 if ((EmailStart == NULL) || (EmailStart > EmailEnd))
2688                                         break;
2689                                 UserEnd = EmailStart;
2690
2691                                 while ((UserEnd > UserStart) &&
2692                                        isspace (*(UserEnd - 1)))
2693                                         UserEnd --;
2694                                 EmailStart ++;
2695                                 if (UserStart >= UserEnd)
2696                                         UserStart = UserEnd = NULL;
2697                                 At = strchr(EmailStart, '@');
2698                         }
2699                         else { /* this is a local recipient... no domain, just a realname */
2700                                 EmailStart = UserStart;
2701                                 At = strchr(EmailStart, '@');
2702                                 if (At == NULL) {
2703                                         UserEnd = EmailEnd;
2704                                         EmailEnd = NULL;
2705                                 }
2706                                 else {
2707                                         EmailStart = UserStart;
2708                                         UserStart = NULL;
2709                                 }
2710                         }
2711                 }
2712
2713                 if ((UserStart != NULL) && (UserEnd != NULL))
2714                         StrBufPlain(UserName, UserStart, UserEnd - UserStart);
2715                 else if ((UserStart != NULL) && (UserEnd == NULL))
2716                         StrBufPlain(UserName, UserStart, UserEnd - UserStart);
2717                 else
2718                         FlushStrBuf(UserName);
2719
2720                 if ((EmailStart != NULL) && (EmailEnd != NULL))
2721                         StrBufPlain(EmailAddress, EmailStart, EmailEnd - EmailStart);
2722                 else if ((EmailStart != NULL) && (EmailEnd == NULL))
2723                         StrBufPlain(EmailAddress, EmailStart, EmailEnd - pche);
2724                 else
2725                         FlushStrBuf(EmailAddress);
2726
2727                 AddRecipient(Target, UserName, EmailAddress, EncBuf);
2728
2729                 if (pch == NULL)
2730                         break;
2731
2732                 if ((pch != NULL) && (*pch == ','))
2733                         pch ++;
2734                 if (pch != NULL) while (isspace(*pch))
2735                         pch ++;
2736         }
2737         return Target;
2738 }
2739
2740
2741 /**
2742  * @ingroup StrBuf
2743  * @brief replaces all occurances of 'search' by 'replace'
2744  * @param buf Buffer to modify
2745  * @param search character to search
2746  * @param replace character to replace search by
2747  */
2748 void StrBufReplaceChars(StrBuf *buf, char search, char replace)
2749 {
2750         long i;
2751         if (buf == NULL)
2752                 return;
2753         for (i=0; i<buf->BufUsed; i++)
2754                 if (buf->buf[i] == search)
2755                         buf->buf[i] = replace;
2756
2757 }
2758
2759 /**
2760  * @ingroup StrBuf
2761  * @brief removes all \r s from the string, or replaces them with \n if its not a combination of both.
2762  * @param buf Buffer to modify
2763  */
2764 void StrBufToUnixLF(StrBuf *buf)
2765 {
2766         char *pche, *pchS, *pchT;
2767         if (buf == NULL)
2768                 return;
2769
2770         pche = buf->buf + buf->BufUsed;
2771         pchS = pchT = buf->buf;
2772         while (pchS < pche)
2773         {
2774                 if (*pchS == '\r')
2775                 {
2776                         pchS ++;
2777                         if (*pchS != '\n') {
2778                                 *pchT = '\n';
2779                                 pchT++;
2780                         }
2781                 }
2782                 *pchT = *pchS;
2783                 pchT++; pchS++;
2784         }
2785         *pchT = '\0';
2786         buf->BufUsed = pchT - buf->buf;
2787 }
2788
2789
2790 /*******************************************************************************
2791  *                 Iconv Wrapper; RFC822 de/encoding                           *
2792  *******************************************************************************/
2793
2794 /**
2795  * @ingroup StrBuf_DeEnCoder
2796  * @brief Wrapper around iconv_open()
2797  * Our version adds aliases for non-standard Microsoft charsets
2798  * such as 'MS950', aliasing them to names like 'CP950'
2799  *
2800  * @param tocode        Target encoding
2801  * @param fromcode      Source encoding
2802  * @param pic           anonimized pointer to iconv struct
2803  */
2804 void  ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic)
2805 {
2806 #ifdef HAVE_ICONV
2807         iconv_t ic = (iconv_t)(-1) ;
2808         ic = iconv_open(tocode, fromcode);
2809         if (ic == (iconv_t)(-1) ) {
2810                 char alias_fromcode[64];
2811                 if ( (strlen(fromcode) == 5) && (!strncasecmp(fromcode, "MS", 2)) ) {
2812                         safestrncpy(alias_fromcode, fromcode, sizeof alias_fromcode);
2813                         alias_fromcode[0] = 'C';
2814                         alias_fromcode[1] = 'P';
2815                         ic = iconv_open(tocode, alias_fromcode);
2816                 }
2817         }
2818         *(iconv_t *)pic = ic;
2819 #endif
2820 }
2821
2822
2823 /**
2824  * @ingroup StrBuf_DeEnCoder
2825  * @brief find one chunk of a RFC822 encoded string
2826  * @param Buffer where to search
2827  * @param bptr where to start searching
2828  * @returns found position, NULL if none.
2829  */
2830 static inline const char *FindNextEnd (const StrBuf *Buf, const char *bptr)
2831 {
2832         const char * end;
2833         /* Find the next ?Q? */
2834         if (Buf->BufUsed - (bptr - Buf->buf)  < 6)
2835                 return NULL;
2836
2837         end = strchr(bptr + 2, '?');
2838
2839         if (end == NULL)
2840                 return NULL;
2841
2842         if ((Buf->BufUsed - (end - Buf->buf) > 3) &&
2843             ((*(end + 1) == 'B') || (*(end + 1) == 'Q')) &&
2844             (*(end + 2) == '?')) {
2845                 /* skip on to the end of the cluster, the next ?= */
2846                 end = strstr(end + 3, "?=");
2847         }
2848         else
2849                 /* sort of half valid encoding, try to find an end. */
2850                 end = strstr(bptr, "?=");
2851         return end;
2852 }
2853
2854 /**
2855  * @ingroup StrBuf
2856  * @brief swaps the contents of two StrBufs
2857  * this is to be used to have cheap switched between a work-buffer and a target buffer
2858  * @param A First one
2859  * @param B second one
2860  */
2861 static inline void SwapBuffers(StrBuf *A, StrBuf *B)
2862 {
2863         StrBuf C;
2864
2865         memcpy(&C, A, sizeof(*A));
2866         memcpy(A, B, sizeof(*B));
2867         memcpy(B, &C, sizeof(C));
2868
2869 }
2870
2871
2872 /**
2873  * @ingroup StrBuf_DeEnCoder
2874  * @brief convert one buffer according to the preselected iconv pointer PIC
2875  * @param ConvertBuf buffer we need to translate
2876  * @param TmpBuf To share a workbuffer over several iterations. prepare to have it filled with useless stuff afterwards.
2877  * @param pic Pointer to the iconv-session Object
2878  */
2879 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic)
2880 {
2881 #ifdef HAVE_ICONV
2882         long trycount = 0;
2883         size_t siz;
2884         iconv_t ic;
2885         char *ibuf;                     /**< Buffer of characters to be converted */
2886         char *obuf;                     /**< Buffer for converted characters */
2887         size_t ibuflen;                 /**< Length of input buffer */
2888         size_t obuflen;                 /**< Length of output buffer */
2889
2890
2891         /* since we're converting to utf-8, one glyph may take up to 6 bytes */
2892         if (ConvertBuf->BufUsed * 6 >= TmpBuf->BufSize)
2893                 IncreaseBuf(TmpBuf, 0, ConvertBuf->BufUsed * 6);
2894 TRYAGAIN:
2895         ic = *(iconv_t*)pic;
2896         ibuf = ConvertBuf->buf;
2897         ibuflen = ConvertBuf->BufUsed;
2898         obuf = TmpBuf->buf;
2899         obuflen = TmpBuf->BufSize;
2900
2901         siz = iconv(ic, &ibuf, &ibuflen, &obuf, &obuflen);
2902
2903         if (siz < 0) {
2904                 if (errno == E2BIG) {
2905                         trycount ++;
2906                         IncreaseBuf(TmpBuf, 0, 0);
2907                         if (trycount < 5)
2908                                 goto TRYAGAIN;
2909
2910                 }
2911                 else if (errno == EILSEQ){
2912                         /* hm, invalid utf8 sequence... what to do now? */
2913                         /* An invalid multibyte sequence has been encountered in the input */
2914                 }
2915                 else if (errno == EINVAL) {
2916                         /* An incomplete multibyte sequence has been encountered in the input. */
2917                 }
2918
2919                 FlushStrBuf(TmpBuf);
2920         }
2921         else {
2922                 TmpBuf->BufUsed = TmpBuf->BufSize - obuflen;
2923                 TmpBuf->buf[TmpBuf->BufUsed] = '\0';
2924
2925                 /* little card game: wheres the red lady? */
2926                 SwapBuffers(ConvertBuf, TmpBuf);
2927                 FlushStrBuf(TmpBuf);
2928         }
2929 #endif
2930 }
2931
2932
2933 /**
2934  * @ingroup StrBuf_DeEnCoder
2935  * @brief catches one RFC822 encoded segment, and decodes it.
2936  * @param Target buffer to fill with result
2937  * @param DecodeMe buffer with stuff to process
2938  * @param SegmentStart points to our current segment in DecodeMe
2939  * @param SegmentEnd Points to the end of our current segment in DecodeMe
2940  * @param ConvertBuf Workbuffer shared between several iterations. Random content; needs to be valid
2941  * @param ConvertBuf2 Workbuffer shared between several iterations. Random content; needs to be valid
2942  * @param FoundCharset Characterset to default decoding to; if we find another we will overwrite it.
2943  */
2944 inline static void DecodeSegment(StrBuf *Target,
2945                                  const StrBuf *DecodeMe,
2946                                  const char *SegmentStart,
2947                                  const char *SegmentEnd,
2948                                  StrBuf *ConvertBuf,
2949                                  StrBuf *ConvertBuf2,
2950                                  StrBuf *FoundCharset)
2951 {
2952         StrBuf StaticBuf;
2953         char charset[128];
2954         char encoding[16];
2955 #ifdef HAVE_ICONV
2956         iconv_t ic = (iconv_t)(-1);
2957 #else
2958         void *ic = NULL;
2959 #endif
2960         /* Now we handle foreign character sets properly encoded
2961          * in RFC2047 format.
2962          */
2963         StaticBuf.buf = (char*) SegmentStart; /*< it will just be read there... */
2964         StaticBuf.BufUsed = SegmentEnd - SegmentStart;
2965         StaticBuf.BufSize = DecodeMe->BufSize - (SegmentStart - DecodeMe->buf);
2966         extract_token(charset, SegmentStart, 1, '?', sizeof charset);
2967         if (FoundCharset != NULL) {
2968                 FlushStrBuf(FoundCharset);
2969                 StrBufAppendBufPlain(FoundCharset, charset, -1, 0);
2970         }
2971         extract_token(encoding, SegmentStart, 2, '?', sizeof encoding);
2972         StrBufExtract_token(ConvertBuf, &StaticBuf, 3, '?');
2973
2974         *encoding = toupper(*encoding);
2975         if (*encoding == 'B') { /**< base64 */
2976                 if (ConvertBuf2->BufSize < ConvertBuf->BufUsed)
2977                         IncreaseBuf(ConvertBuf2, 0, ConvertBuf->BufUsed);
2978                 ConvertBuf2->BufUsed = CtdlDecodeBase64(ConvertBuf2->buf,
2979                                                         ConvertBuf->buf,
2980                                                         ConvertBuf->BufUsed);
2981         }
2982         else if (*encoding == 'Q') {    /**< quoted-printable */
2983                 long pos;
2984
2985                 pos = 0;
2986                 while (pos < ConvertBuf->BufUsed)
2987                 {
2988                         if (ConvertBuf->buf[pos] == '_')
2989                                 ConvertBuf->buf[pos] = ' ';
2990                         pos++;
2991                 }
2992
2993                 if (ConvertBuf2->BufSize < ConvertBuf->BufUsed)
2994                         IncreaseBuf(ConvertBuf2, 0, ConvertBuf->BufUsed);
2995
2996                 ConvertBuf2->BufUsed = CtdlDecodeQuotedPrintable(
2997                         ConvertBuf2->buf,
2998                         ConvertBuf->buf,
2999                         ConvertBuf->BufUsed);
3000         }
3001         else {
3002                 StrBufAppendBuf(ConvertBuf2, ConvertBuf, 0);
3003         }
3004 #ifdef HAVE_ICONV
3005         ctdl_iconv_open("UTF-8", charset, &ic);
3006         if (ic != (iconv_t)(-1) ) {
3007 #endif
3008                 StrBufConvert(ConvertBuf2, ConvertBuf, &ic);
3009                 StrBufAppendBuf(Target, ConvertBuf2, 0);
3010 #ifdef HAVE_ICONV
3011                 iconv_close(ic);
3012         }
3013         else {
3014                 StrBufAppendBufPlain(Target, HKEY("(unreadable)"), 0);
3015         }
3016 #endif
3017 }
3018
3019 /**
3020  * @ingroup StrBuf_DeEnCoder
3021  * @brief Handle subjects with RFC2047 encoding such as:
3022  * =?koi8-r?B?78bP0s3Mxc7JxSDXz9rE1dvO2c3JINvB0sHNySDP?=
3023  * @param Target where to put the decoded string to
3024  * @param DecodeMe buffer with encoded string
3025  * @param DefaultCharset if we don't find one, which should we use?
3026  * @param FoundCharset overrides DefaultCharset if non-empty; If we find a charset inside of the string,
3027  *        put it here for later use where no string might be known.
3028  */
3029 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset)
3030 {
3031         StrBuf *DecodedInvalidBuf = NULL;
3032         StrBuf *ConvertBuf, *ConvertBuf2;
3033         const StrBuf *DecodeMee = DecodeMe;
3034         const char *start, *end, *next, *nextend, *ptr = NULL;
3035 #ifdef HAVE_ICONV
3036         iconv_t ic = (iconv_t)(-1) ;
3037 #endif
3038         const char *eptr;
3039         int passes = 0;
3040         int i, len;
3041         int illegal_non_rfc2047_encoding = 0;
3042
3043         /* Sometimes, badly formed messages contain strings which were simply
3044          *  written out directly in some foreign character set instead of
3045          *  using RFC2047 encoding.  This is illegal but we will attempt to
3046          *  handle it anyway by converting from a user-specified default
3047          *  charset to UTF-8 if we see any nonprintable characters.
3048          */
3049
3050         len = StrLength(DecodeMe);
3051         for (i=0; i<DecodeMe->BufUsed; ++i) {
3052                 if ((DecodeMe->buf[i] < 32) || (DecodeMe->buf[i] > 126)) {
3053                         illegal_non_rfc2047_encoding = 1;
3054                         break;
3055                 }
3056         }
3057
3058         ConvertBuf = NewStrBufPlain(NULL, StrLength(DecodeMe));
3059         if ((illegal_non_rfc2047_encoding) &&
3060             (strcasecmp(ChrPtr(DefaultCharset), "UTF-8")) &&
3061             (strcasecmp(ChrPtr(DefaultCharset), "us-ascii")) )
3062         {
3063 #ifdef HAVE_ICONV
3064                 ctdl_iconv_open("UTF-8", ChrPtr(DefaultCharset), &ic);
3065                 if (ic != (iconv_t)(-1) ) {
3066                         DecodedInvalidBuf = NewStrBufDup(DecodeMe);
3067                         StrBufConvert(DecodedInvalidBuf, ConvertBuf, &ic);///TODO: don't void const?
3068                         DecodeMee = DecodedInvalidBuf;
3069                         iconv_close(ic);
3070                 }
3071 #endif
3072         }
3073
3074         /* pre evaluate the first pair */
3075         nextend = end = NULL;
3076         len = StrLength(DecodeMee);
3077         start = strstr(DecodeMee->buf, "=?");
3078         eptr = DecodeMee->buf + DecodeMee->BufUsed;
3079         if (start != NULL)
3080                 end = FindNextEnd (DecodeMee, start);
3081         else {
3082                 StrBufAppendBuf(Target, DecodeMee, 0);
3083                 FreeStrBuf(&ConvertBuf);
3084                 FreeStrBuf(&DecodedInvalidBuf);
3085                 return;
3086         }
3087
3088         ConvertBuf2 = NewStrBufPlain(NULL, StrLength(DecodeMee));
3089
3090         if (start != DecodeMee->buf) {
3091                 long nFront;
3092
3093                 nFront = start - DecodeMee->buf;
3094                 StrBufAppendBufPlain(Target, DecodeMee->buf, nFront, 0);
3095                 len -= nFront;
3096         }
3097         /*
3098          * Since spammers will go to all sorts of absurd lengths to get their
3099          * messages through, there are LOTS of corrupt headers out there.
3100          * So, prevent a really badly formed RFC2047 header from throwing
3101          * this function into an infinite loop.
3102          */
3103         while ((start != NULL) &&
3104                (end != NULL) &&
3105                (start < eptr) &&
3106                (end < eptr) &&
3107                (passes < 20))
3108         {
3109                 passes++;
3110                 DecodeSegment(Target,
3111                               DecodeMee,
3112                               start,
3113                               end,
3114                               ConvertBuf,
3115                               ConvertBuf2,
3116                               FoundCharset);
3117
3118                 next = strstr(end, "=?");
3119                 nextend = NULL;
3120                 if ((next != NULL) &&
3121                     (next < eptr))
3122                         nextend = FindNextEnd(DecodeMee, next);
3123                 if (nextend == NULL)
3124                         next = NULL;
3125
3126                 /* did we find two partitions */
3127                 if ((next != NULL) &&
3128                     ((next - end) > 2))
3129                 {
3130                         ptr = end + 2;
3131                         while ((ptr < next) &&
3132                                (isspace(*ptr) ||
3133                                 (*ptr == '\r') ||
3134                                 (*ptr == '\n') ||
3135                                 (*ptr == '\t')))
3136                                 ptr ++;
3137                         /*
3138                          * did we find a gab just filled with blanks?
3139                          * if not, copy its stuff over.
3140                          */
3141                         if (ptr != next)
3142                         {
3143                                 StrBufAppendBufPlain(Target,
3144                                                      end + 2,
3145                                                      next - end - 2,
3146                                                      0);
3147                         }
3148                 }
3149                 /* our next-pair is our new first pair now. */
3150                 ptr = end + 2;
3151                 start = next;
3152                 end = nextend;
3153         }
3154         end = ptr;
3155         nextend = DecodeMee->buf + DecodeMee->BufUsed;
3156         if ((end != NULL) && (end < nextend)) {
3157                 ptr = end;
3158                 while ( (ptr < nextend) &&
3159                         (isspace(*ptr) ||
3160                          (*ptr == '\r') ||
3161                          (*ptr == '\n') ||
3162                          (*ptr == '\t')))
3163                         ptr ++;
3164                 if (ptr < nextend)
3165                         StrBufAppendBufPlain(Target, end, nextend - end, 0);
3166         }
3167         FreeStrBuf(&ConvertBuf);
3168         FreeStrBuf(&ConvertBuf2);
3169         FreeStrBuf(&DecodedInvalidBuf);
3170 }
3171
3172 /*******************************************************************************
3173  *                   Manipulating UTF-8 Strings                                *
3174  *******************************************************************************/
3175
3176 /**
3177  * @ingroup StrBuf
3178  * @brief evaluate the length of an utf8 special character sequence
3179  * @param Char the character to examine
3180  * @returns width of utf8 chars in bytes; if the sequence is broken 0 is returned; 1 if its simply ASCII.
3181  */
3182 static inline int Ctdl_GetUtf8SequenceLength(const char *CharS, const char *CharE)
3183 {
3184         int n = 0;
3185         unsigned char test = (1<<7);
3186
3187         if ((*CharS & 0xC0) == 0)
3188                 return 1;
3189
3190         while ((n < 8) &&
3191                ((test & ((unsigned char)*CharS)) != 0))
3192         {
3193                 test = test >> 1;
3194                 n ++;
3195         }
3196         if ((n > 6) || ((CharE - CharS) < n))
3197                 n = 0;
3198         return n;
3199 }
3200
3201 /**
3202  * @ingroup StrBuf
3203  * @brief detect whether this char starts an utf-8 encoded char
3204  * @param Char character to inspect
3205  * @returns yes or no
3206  */
3207 static inline int Ctdl_IsUtf8SequenceStart(const char Char)
3208 {
3209 /** 11??.???? indicates an UTF8 Sequence. */
3210         return ((Char & 0xC0) != 0);
3211 }
3212
3213 /**
3214  * @ingroup StrBuf
3215  * @brief measure the number of glyphs in an UTF8 string...
3216  * @param Buf string to measure
3217  * @returns the number of glyphs in Buf
3218  */
3219 long StrBuf_Utf8StrLen(StrBuf *Buf)
3220 {
3221         int n = 0;
3222         int m = 0;
3223         char *aptr, *eptr;
3224
3225         if ((Buf == NULL) || (Buf->BufUsed == 0))
3226                 return 0;
3227         aptr = Buf->buf;
3228         eptr = Buf->buf + Buf->BufUsed;
3229         while ((aptr < eptr) && (*aptr != '\0')) {
3230                 if (Ctdl_IsUtf8SequenceStart(*aptr)){
3231                         m = Ctdl_GetUtf8SequenceLength(aptr, eptr);
3232                         while ((aptr < eptr) && (*aptr++ != '\0')&& (m-- > 0) );
3233                         n ++;
3234                 }
3235                 else {
3236                         n++;
3237                         aptr++;
3238                 }
3239         }
3240         return n;
3241 }
3242
3243 /**
3244  * @ingroup StrBuf
3245  * @brief cuts a string after maxlen glyphs
3246  * @param Buf string to cut to maxlen glyphs
3247  * @param maxlen how long may the string become?
3248  * @returns current length of the string
3249  */
3250 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen)
3251 {
3252         char *aptr, *eptr;
3253         int n = 0, m = 0;
3254
3255         aptr = Buf->buf;
3256         eptr = Buf->buf + Buf->BufUsed;
3257         while ((aptr < eptr) && (*aptr != '\0')) {
3258                 if (Ctdl_IsUtf8SequenceStart(*aptr)){
3259                         m = Ctdl_GetUtf8SequenceLength(aptr, eptr);
3260                         while ((*aptr++ != '\0') && (m-- > 0));
3261                         n ++;
3262                 }
3263                 else {
3264                         n++;
3265                         aptr++;
3266                 }
3267                 if (n > maxlen) {
3268                         *aptr = '\0';
3269                         Buf->BufUsed = aptr - Buf->buf;
3270                         return Buf->BufUsed;
3271                 }
3272         }
3273         return Buf->BufUsed;
3274
3275 }
3276
3277
3278
3279
3280
3281 /*******************************************************************************
3282  *                               wrapping ZLib                                 *
3283  *******************************************************************************/
3284
3285 #ifdef HAVE_ZLIB
3286 #define DEF_MEM_LEVEL 8 /*< memlevel??? */
3287 #define OS_CODE 0x03    /*< unix */
3288
3289 /**
3290  * @ingroup StrBuf_DeEnCoder
3291  * @brief uses the same calling syntax as compress2(), but it
3292  *   creates a stream compatible with HTTP "Content-encoding: gzip"
3293  * @param dest compressed buffer
3294  * @param destLen length of the compresed data
3295  * @param source source to encode
3296  * @param sourceLen length of source to encode
3297  * @param level compression level
3298  */
3299 int ZEXPORT compress_gzip(Bytef * dest,
3300                           size_t * destLen,
3301                           const Bytef * source,
3302                           uLong sourceLen,
3303                           int level)
3304 {
3305         const int gz_magic[2] = { 0x1f, 0x8b }; /* gzip magic header */
3306
3307         /* write gzip header */
3308         snprintf((char *) dest, *destLen,
3309                  "%c%c%c%c%c%c%c%c%c%c",
3310                  gz_magic[0], gz_magic[1], Z_DEFLATED,
3311                  0 /*flags */ , 0, 0, 0, 0 /*time */ , 0 /* xflags */ ,
3312                  OS_CODE);
3313
3314         /* normal deflate */
3315         z_stream stream;
3316         int err;
3317         stream.next_in = (Bytef *) source;
3318         stream.avail_in = (uInt) sourceLen;
3319         stream.next_out = dest + 10L;   // after header
3320         stream.avail_out = (uInt) * destLen;
3321         if ((uLong) stream.avail_out != *destLen)
3322                 return Z_BUF_ERROR;
3323
3324         stream.zalloc = (alloc_func) 0;
3325         stream.zfree = (free_func) 0;
3326         stream.opaque = (voidpf) 0;
3327
3328         err = deflateInit2(&stream, level, Z_DEFLATED, -MAX_WBITS,
3329                            DEF_MEM_LEVEL, Z_DEFAULT_STRATEGY);
3330         if (err != Z_OK)
3331                 return err;
3332
3333         err = deflate(&stream, Z_FINISH);
3334         if (err != Z_STREAM_END) {
3335                 deflateEnd(&stream);
3336                 return err == Z_OK ? Z_BUF_ERROR : err;
3337         }
3338         *destLen = stream.total_out + 10L;
3339
3340         /* write CRC and Length */
3341         uLong crc = crc32(0L, source, sourceLen);
3342         int n;
3343         for (n = 0; n < 4; ++n, ++*destLen) {
3344                 dest[*destLen] = (int) (crc & 0xff);
3345                 crc >>= 8;
3346         }
3347         uLong len = stream.total_in;
3348         for (n = 0; n < 4; ++n, ++*destLen) {
3349                 dest[*destLen] = (int) (len & 0xff);
3350                 len >>= 8;
3351         }
3352         err = deflateEnd(&stream);
3353         return err;
3354 }
3355 #endif
3356
3357
3358 /**
3359  * @ingroup StrBuf_DeEnCoder
3360  * @brief compress the buffer with gzip
3361  * Attention! If you feed this a Const String, you must maintain the uncompressed buffer yourself!
3362  * @param Buf buffer whose content is to be gzipped
3363  */
3364 int CompressBuffer(StrBuf *Buf)
3365 {
3366 #ifdef HAVE_ZLIB
3367         char *compressed_data = NULL;
3368         size_t compressed_len, bufsize;
3369         int i = 0;
3370
3371         bufsize = compressed_len = Buf->BufUsed +  (Buf->BufUsed / 100) + 100;
3372         compressed_data = malloc(compressed_len);
3373
3374         if (compressed_data == NULL)
3375                 return -1;
3376         /* Flush some space after the used payload so valgrind shuts up... */
3377         while ((i < 10) && (Buf->BufUsed + i < Buf->BufSize))
3378                 Buf->buf[Buf->BufUsed + i++] = '\0';
3379         if (compress_gzip((Bytef *) compressed_data,
3380                           &compressed_len,
3381                           (Bytef *) Buf->buf,
3382                           (uLongf) Buf->BufUsed, Z_BEST_SPEED) == Z_OK) {
3383                 if (!Buf->ConstBuf)
3384                         free(Buf->buf);
3385                 Buf->buf = compressed_data;
3386                 Buf->BufUsed = compressed_len;
3387                 Buf->BufSize = bufsize;
3388                 /* Flush some space after the used payload so valgrind shuts up... */
3389                 i = 0;
3390                 while ((i < 10) && (Buf->BufUsed + i < Buf->BufSize))
3391                         Buf->buf[Buf->BufUsed + i++] = '\0';
3392                 return 1;
3393         } else {
3394                 free(compressed_data);
3395         }
3396 #endif  /* HAVE_ZLIB */
3397         return 0;
3398 }
3399
3400
3401
3402 /*******************************************************************************
3403  *           File I/O; Prefer buffered read since its faster!                  *
3404  *******************************************************************************/
3405
3406 /**
3407  * @ingroup StrBuf_IO
3408  * @brief Read a line from socket
3409  * flushes and closes the FD on error
3410  * @param buf the buffer to get the input to
3411  * @param fd pointer to the filedescriptor to read
3412  * @param append Append to an existing string or replace?
3413  * @param Error strerror() on error
3414  * @returns numbers of chars read
3415  */
3416 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error)
3417 {
3418         int len, rlen, slen;
3419
3420         if (!append)
3421                 FlushStrBuf(buf);
3422
3423         slen = len = buf->BufUsed;
3424         while (1) {
3425                 rlen = read(*fd, &buf->buf[len], 1);
3426                 if (rlen < 1) {
3427                         *Error = strerror(errno);
3428
3429                         close(*fd);
3430                         *fd = -1;
3431
3432                         return -1;
3433                 }
3434                 if (buf->buf[len] == '\n')
3435                         break;
3436                 if (buf->buf[len] != '\r')
3437                         len ++;
3438                 if (len + 2 >= buf->BufSize) {
3439                         buf->BufUsed = len;
3440                         buf->buf[len+1] = '\0';
3441                         IncreaseBuf(buf, 1, -1);
3442                 }
3443         }
3444         buf->BufUsed = len;
3445         buf->buf[len] = '\0';
3446         return len - slen;
3447 }
3448
3449 /**
3450  * @ingroup StrBuf_BufferedIO
3451  * @brief Read a line from socket
3452  * flushes and closes the FD on error
3453  * @param Line the line to read from the fd / I/O Buffer
3454  * @param buf the buffer to get the input to
3455  * @param fd pointer to the filedescriptor to read
3456  * @param timeout number of successless selects until we bail out
3457  * @param selectresolution how long to wait on each select
3458  * @param Error strerror() on error
3459  * @returns numbers of chars read
3460  */
3461 int StrBufTCP_read_buffered_line(StrBuf *Line,
3462                                  StrBuf *buf,
3463                                  int *fd,
3464                                  int timeout,
3465                                  int selectresolution,
3466                                  const char **Error)
3467 {
3468         int len, rlen;
3469         int nSuccessLess = 0;
3470         fd_set rfds;
3471         char *pch = NULL;
3472         int fdflags;
3473         int IsNonBlock;
3474         struct timeval tv;
3475
3476         if (buf->BufUsed > 0) {
3477                 pch = strchr(buf->buf, '\n');
3478                 if (pch != NULL) {
3479                         rlen = 0;
3480                         len = pch - buf->buf;
3481                         if (len > 0 && (*(pch - 1) == '\r') )
3482                                 rlen ++;
3483                         StrBufSub(Line, buf, 0, len - rlen);
3484                         StrBufCutLeft(buf, len + 1);
3485                         return len - rlen;
3486                 }
3487         }
3488
3489         if (buf->BufSize - buf->BufUsed < 10)
3490                 IncreaseBuf(buf, 1, -1);
3491
3492         fdflags = fcntl(*fd, F_GETFL);
3493         IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
3494
3495         while ((nSuccessLess < timeout) && (pch == NULL)) {
3496                 if (IsNonBlock){
3497                         tv.tv_sec = selectresolution;
3498                         tv.tv_usec = 0;
3499
3500                         FD_ZERO(&rfds);
3501                         FD_SET(*fd, &rfds);
3502                         if (select(*fd + 1, NULL, &rfds, NULL, &tv) == -1) {
3503                                 *Error = strerror(errno);
3504                                 close (*fd);
3505                                 *fd = -1;
3506                                 return -1;
3507                         }
3508                 }
3509                 if (IsNonBlock && !  FD_ISSET(*fd, &rfds)) {
3510                         nSuccessLess ++;
3511                         continue;
3512                 }
3513                 rlen = read(*fd,
3514                             &buf->buf[buf->BufUsed],
3515                             buf->BufSize - buf->BufUsed - 1);
3516                 if (rlen < 1) {
3517                         *Error = strerror(errno);
3518                         close(*fd);
3519                         *fd = -1;
3520                         return -1;
3521                 }
3522                 else if (rlen > 0) {
3523                         nSuccessLess = 0;
3524                         buf->BufUsed += rlen;
3525                         buf->buf[buf->BufUsed] = '\0';
3526                         if (buf->BufUsed + 10 > buf->BufSize) {
3527                                 IncreaseBuf(buf, 1, -1);
3528                         }
3529                         pch = strchr(buf->buf, '\n');
3530                         continue;
3531                 }
3532
3533         }
3534         if (pch != NULL) {
3535                 rlen = 0;
3536                 len = pch - buf->buf;
3537                 if (len > 0 && (*(pch - 1) == '\r') )
3538                         rlen ++;
3539                 StrBufSub(Line, buf, 0, len - rlen);
3540                 StrBufCutLeft(buf, len + 1);
3541                 return len - rlen;
3542         }
3543         return -1;
3544
3545 }
3546
3547 static const char *ErrRBLF_PreConditionFailed="StrBufTCP_read_buffered_line_fast: Wrong arguments or invalid Filedescriptor";
3548 static const char *ErrRBLF_SelectFailed="StrBufTCP_read_buffered_line_fast: Select failed without reason";
3549 static const char *ErrRBLF_NotEnoughSentFromServer="StrBufTCP_read_buffered_line_fast: No complete line was sent from peer";
3550 /**
3551  * @ingroup StrBuf_BufferedIO
3552  * @brief Read a line from socket
3553  * flushes and closes the FD on error
3554  * @param Line where to append our Line read from the fd / I/O Buffer;
3555  * @param IOBuf the buffer to get the input to; lifetime pair to FD
3556  * @param Pos pointer to the current read position, should be NULL initialized on opening the FD it belongs to.!
3557  * @param fd pointer to the filedescriptor to read
3558  * @param timeout number of successless selects until we bail out
3559  * @param selectresolution how long to wait on each select
3560  * @param Error strerror() on error
3561  * @returns numbers of chars read or -1 in case of error. "\n" will become 0
3562  */
3563 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
3564                                       StrBuf *IOBuf,
3565                                       const char **Pos,
3566                                       int *fd,
3567                                       int timeout,
3568                                       int selectresolution,
3569                                       const char **Error)
3570 {
3571         const char *pche = NULL;
3572         const char *pos = NULL;
3573         const char *pLF;
3574         int len, rlen, retlen;
3575         int nSuccessLess = 0;
3576         fd_set rfds;
3577         const char *pch = NULL;
3578         int fdflags;
3579         int IsNonBlock;
3580         struct timeval tv;
3581
3582         retlen = 0;
3583         if ((Line == NULL) ||
3584             (Pos == NULL) ||
3585             (IOBuf == NULL) ||
3586             (*fd == -1))
3587         {
3588                 if (Pos != NULL)
3589                         *Pos = NULL;
3590                 *Error = ErrRBLF_PreConditionFailed;
3591                 return -1;
3592         }
3593
3594         pos = *Pos;
3595         if ((IOBuf->BufUsed > 0) &&
3596             (pos != NULL) &&
3597             (pos < IOBuf->buf + IOBuf->BufUsed))
3598         {
3599                 char *pcht;
3600
3601                 pche = IOBuf->buf + IOBuf->BufUsed;
3602                 pch = pos;
3603                 pcht = Line->buf;
3604
3605                 while ((pch < pche) && (*pch != '\n'))
3606                 {
3607                         if (Line->BufUsed + 10 > Line->BufSize)
3608                         {
3609                                 long apos;
3610                                 apos = pcht - Line->buf;
3611                                 *pcht = '\0';
3612                                 IncreaseBuf(Line, 1, -1);
3613                                 pcht = Line->buf + apos;
3614                         }
3615                         *pcht++ = *pch++;
3616                         Line->BufUsed++;
3617                         retlen++;
3618                 }
3619
3620                 len = pch - pos;
3621                 if (len > 0 && (*(pch - 1) == '\r') )
3622                 {
3623                         retlen--;
3624                         len --;
3625                         pcht --;
3626                         Line->BufUsed --;
3627                 }
3628                 *pcht = '\0';
3629
3630                 if ((pch >= pche) || (*pch == '\0'))
3631                 {
3632                         FlushStrBuf(IOBuf);
3633                         *Pos = NULL;
3634                         pch = NULL;
3635                         pos = 0;
3636                 }
3637
3638                 if ((pch != NULL) &&
3639                     (pch <= pche))
3640                 {
3641                         if (pch + 1 >= pche) {
3642                                 *Pos = NULL;
3643                                 FlushStrBuf(IOBuf);
3644                         }
3645                         else
3646                                 *Pos = pch + 1;
3647
3648                         return retlen;
3649                 }
3650                 else
3651                         FlushStrBuf(IOBuf);
3652         }
3653
3654         /* If we come here, Pos is Unset since we read everything into Line, and now go for more. */
3655
3656         if (IOBuf->BufSize - IOBuf->BufUsed < 10)
3657                 IncreaseBuf(IOBuf, 1, -1);
3658
3659         fdflags = fcntl(*fd, F_GETFL);
3660         IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
3661
3662         pLF = NULL;
3663         while ((nSuccessLess < timeout) &&
3664                (pLF == NULL) &&
3665                (*fd != -1)) {
3666                 if (IsNonBlock)
3667                 {
3668                         tv.tv_sec = 1;
3669                         tv.tv_usec = 0;
3670
3671                         FD_ZERO(&rfds);
3672                         FD_SET(*fd, &rfds);
3673                         if (select((*fd) + 1, &rfds, NULL, NULL, &tv) == -1) {
3674                                 *Error = strerror(errno);
3675                                 close (*fd);
3676                                 *fd = -1;
3677                                 if (*Error == NULL)
3678                                         *Error = ErrRBLF_SelectFailed;
3679                                 return -1;
3680                         }
3681                         if (! FD_ISSET(*fd, &rfds) != 0) {
3682                                 nSuccessLess ++;
3683                                 continue;
3684                         }
3685                 }
3686                 rlen = read(*fd,
3687                             &IOBuf->buf[IOBuf->BufUsed],
3688                             IOBuf->BufSize - IOBuf->BufUsed - 1);
3689                 if (rlen < 1) {
3690                         *Error = strerror(errno);
3691                         close(*fd);
3692                         *fd = -1;
3693                         return -1;
3694                 }
3695                 else if (rlen > 0) {
3696                         nSuccessLess = 0;
3697                         pLF = IOBuf->buf + IOBuf->BufUsed;
3698                         IOBuf->BufUsed += rlen;
3699                         IOBuf->buf[IOBuf->BufUsed] = '\0';
3700
3701                         pche = IOBuf->buf + IOBuf->BufUsed;
3702
3703                         while ((pLF < pche) && (*pLF != '\n'))
3704                                 pLF ++;
3705                         if ((pLF >= pche) || (*pLF == '\0'))
3706                                 pLF = NULL;
3707
3708                         if (IOBuf->BufUsed + 10 > IOBuf->BufSize)
3709                         {
3710                                 long apos = 0;
3711
3712                                 if (pLF != NULL) apos = pLF - IOBuf->buf;
3713                                 IncreaseBuf(IOBuf, 1, -1);
3714                                 if (pLF != NULL) pLF = IOBuf->buf + apos;
3715                         }
3716
3717                         continue;
3718                 }
3719         }
3720         *Pos = NULL;
3721         if (pLF != NULL) {
3722                 pos = IOBuf->buf;
3723                 len = pLF - pos;
3724                 if (len > 0 && (*(pLF - 1) == '\r') )
3725                         len --;
3726                 StrBufAppendBufPlain(Line, ChrPtr(IOBuf), len, 0);
3727                 if (pLF + 1 >= IOBuf->buf + IOBuf->BufUsed)
3728                 {
3729                         FlushStrBuf(IOBuf);
3730                 }
3731                 else
3732                         *Pos = pLF + 1;
3733                 return retlen + len;
3734         }
3735         *Error = ErrRBLF_NotEnoughSentFromServer;
3736         return -1;
3737
3738 }
3739
3740 static const char *ErrRBLF_BLOBPreConditionFailed="StrBufReadBLOB: Wrong arguments or invalid Filedescriptor";
3741 /**
3742  * @ingroup StrBuf_IO
3743  * @brief Input binary data from socket
3744  * flushes and closes the FD on error
3745  * @param Buf the buffer to get the input to
3746  * @param fd pointer to the filedescriptor to read
3747  * @param append Append to an existing string or replace?
3748  * @param nBytes the maximal number of bytes to read
3749  * @param Error strerror() on error
3750  * @returns numbers of chars read
3751  */
3752 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error)
3753 {
3754         int fdflags;
3755         int len, rlen, slen;
3756         int nSuccessLess;
3757         int nRead = 0;
3758         char *ptr;
3759         int IsNonBlock;
3760         struct timeval tv;
3761         fd_set rfds;
3762
3763         if ((Buf == NULL) || (*fd == -1))
3764         {
3765                 *Error = ErrRBLF_BLOBPreConditionFailed;
3766                 return -1;
3767         }
3768         if (!append)
3769                 FlushStrBuf(Buf);
3770         if (Buf->BufUsed + nBytes >= Buf->BufSize)
3771                 IncreaseBuf(Buf, 1, Buf->BufUsed + nBytes);
3772
3773         ptr = Buf->buf + Buf->BufUsed;
3774
3775         slen = len = Buf->BufUsed;
3776
3777         fdflags = fcntl(*fd, F_GETFL);
3778         IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
3779         nSuccessLess = 0;
3780         while ((nRead < nBytes) &&
3781                (*fd != -1))
3782         {
3783                 if (IsNonBlock)
3784                 {
3785                         tv.tv_sec = 1;
3786                         tv.tv_usec = 0;
3787
3788                         FD_ZERO(&rfds);
3789                         FD_SET(*fd, &rfds);
3790                         if (select(*fd + 1, &rfds, NULL, NULL, &tv) == -1) {
3791                                 *Error = strerror(errno);
3792                                 close (*fd);
3793                                 *fd = -1;
3794                                 if (*Error == NULL)
3795                                         *Error = ErrRBLF_SelectFailed;
3796                                 return -1;
3797                         }
3798                         if (! FD_ISSET(*fd, &rfds) != 0) {
3799                                 nSuccessLess ++;
3800                                 continue;
3801                         }
3802                 }
3803
3804                 if ((rlen = read(*fd,
3805                                  ptr,
3806                                  nBytes - nRead)) == -1) {
3807                         close(*fd);
3808                         *fd = -1;
3809                         *Error = strerror(errno);
3810                         return rlen;
3811                 }
3812                 nRead += rlen;
3813                 ptr += rlen;
3814                 Buf->BufUsed += rlen;
3815         }
3816         Buf->buf[Buf->BufUsed] = '\0';
3817         return nRead;
3818 }
3819
3820 const char *ErrRBB_BLOBFPreConditionFailed = "StrBufReadBLOBBuffered: to many selects; aborting.";
3821 const char *ErrRBB_too_many_selects        = "StrBufReadBLOBBuffered: to many selects; aborting.";
3822 /**
3823  * @ingroup StrBuf_BufferedIO
3824  * @brief Input binary data from socket
3825  * flushes and closes the FD on error
3826  * @param Blob put binary thing here
3827  * @param IOBuf the buffer to get the input to
3828  * @param Pos offset inside of IOBuf
3829  * @param fd pointer to the filedescriptor to read
3830  * @param append Append to an existing string or replace?
3831  * @param nBytes the maximal number of bytes to read
3832  * @param check whether we should search for '000\n' terminators in case of timeouts
3833  * @param Error strerror() on error
3834  * @returns numbers of chars read
3835  */
3836 int StrBufReadBLOBBuffered(StrBuf *Blob,
3837                            StrBuf *IOBuf,
3838                            const char **Pos,
3839                            int *fd,
3840                            int append,
3841                            long nBytes,
3842                            int check,
3843                            const char **Error)
3844 {
3845         const char *pche;
3846         const char *pos;
3847         int fdflags;
3848         int len = 0;
3849         int rlen, slen;
3850         int nRead = 0;
3851         int nAlreadyRead = 0;
3852         int IsNonBlock;
3853         char *ptr;
3854         fd_set rfds;
3855         const char *pch;
3856         struct timeval tv;
3857         int nSuccessLess = 0;
3858         int MaxTries;
3859
3860         if ((Blob == NULL) || (*fd == -1) || (IOBuf == NULL) || (Pos == NULL))
3861         {
3862                 if (*Pos != NULL)
3863                         *Pos = NULL;
3864                 *Error = ErrRBB_BLOBFPreConditionFailed;
3865                 return -1;
3866         }
3867
3868         if (!append)
3869                 FlushStrBuf(Blob);
3870         if (Blob->BufUsed + nBytes >= Blob->BufSize)
3871                 IncreaseBuf(Blob, append, Blob->BufUsed + nBytes);
3872
3873         pos = *Pos;
3874
3875         if (pos != NULL)
3876                 len = pos - IOBuf->buf;
3877         rlen = IOBuf->BufUsed - len;
3878
3879
3880         if ((IOBuf->BufUsed > 0) &&
3881             (pos != NULL) &&
3882             (pos < IOBuf->buf + IOBuf->BufUsed))
3883         {
3884                 pche = IOBuf->buf + IOBuf->BufUsed;
3885                 pch = pos;
3886
3887                 if (rlen < nBytes) {
3888                         memcpy(Blob->buf + Blob->BufUsed, pos, rlen);
3889                         Blob->BufUsed += rlen;
3890                         Blob->buf[Blob->BufUsed] = '\0';
3891                         nAlreadyRead = nRead = rlen;
3892                         *Pos = NULL;
3893                 }
3894                 if (rlen >= nBytes) {
3895                         memcpy(Blob->buf + Blob->BufUsed, pos, nBytes);
3896                         Blob->BufUsed += nBytes;
3897                         Blob->buf[Blob->BufUsed] = '\0';
3898                         if (rlen == nBytes) {
3899                                 *Pos = NULL;
3900                                 FlushStrBuf(IOBuf);
3901                         }
3902                         else
3903                                 *Pos += nBytes;
3904                         return nBytes;
3905                 }
3906         }
3907
3908         FlushStrBuf(IOBuf);
3909         *Pos = NULL;
3910         if (IOBuf->BufSize < nBytes - nRead)
3911                 IncreaseBuf(IOBuf, 0, nBytes - nRead);
3912         ptr = IOBuf->buf;
3913
3914         slen = len = Blob->BufUsed;
3915
3916         fdflags = fcntl(*fd, F_GETFL);
3917         IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
3918         if (IsNonBlock)
3919                 MaxTries =   1000;
3920         else
3921                 MaxTries = 100000;
3922
3923         nBytes -= nRead;
3924         nRead = 0;
3925         while ((nSuccessLess < MaxTries) &&
3926                (nRead < nBytes) &&
3927                (*fd != -1)) {
3928                 if (IsNonBlock)
3929                 {
3930                         tv.tv_sec = 1;
3931                         tv.tv_usec = 0;
3932
3933                         FD_ZERO(&rfds);
3934                         FD_SET(*fd, &rfds);
3935                         if (select(*fd + 1, &rfds, NULL, NULL, &tv) == -1) {
3936                                 *Error = strerror(errno);
3937                                 close (*fd);
3938                                 *fd = -1;
3939                                 if (*Error == NULL)
3940                                         *Error = ErrRBLF_SelectFailed;
3941                                 return -1;
3942                         }
3943                         if (! FD_ISSET(*fd, &rfds) != 0) {
3944                                 nSuccessLess ++;
3945                                 continue;
3946                         }
3947                 }
3948                 rlen = read(*fd,
3949                             ptr,
3950                             IOBuf->BufSize - (ptr - IOBuf->buf));
3951                 if (rlen == -1) {
3952                         close(*fd);
3953                         *fd = -1;
3954                         *Error = strerror(errno);
3955                         return rlen;
3956                 }
3957                 else if (rlen == 0){
3958                         if ((check == NNN_TERM) &&
3959                             (nRead > 5) &&
3960                             (strncmp(IOBuf->buf + IOBuf->BufUsed - 5, "\n000\n", 5) == 0))
3961                         {
3962                                 StrBufPlain(Blob, HKEY("\n000\n"));
3963                                 StrBufCutRight(Blob, 5);
3964                                 return Blob->BufUsed;
3965                         }
3966                         else if (!IsNonBlock)
3967                                 nSuccessLess ++;
3968                         else if (nSuccessLess > MaxTries) {
3969                                 FlushStrBuf(IOBuf);
3970                                 *Error = ErrRBB_too_many_selects;
3971                                 return -1;
3972                         }
3973                 }
3974                 else if (rlen > 0) {
3975                         nSuccessLess = 0;
3976                         nRead += rlen;
3977                         ptr += rlen;
3978                         IOBuf->BufUsed += rlen;
3979                 }
3980         }
3981         if (nSuccessLess >= MaxTries) {
3982                 FlushStrBuf(IOBuf);
3983                 *Error = ErrRBB_too_many_selects;
3984                 return -1;
3985         }
3986
3987         if (nRead > nBytes) {
3988                 *Pos = IOBuf->buf + nBytes;
3989         }
3990         Blob->buf[Blob->BufUsed] = '\0';
3991         StrBufAppendBufPlain(Blob, IOBuf->buf, nBytes, 0);
3992         if (*Pos == NULL) {
3993                 FlushStrBuf(IOBuf);
3994         }
3995         return nRead + nAlreadyRead;
3996 }
3997
3998 /**
3999  * @ingroup StrBuf_IO
4000  * @brief extract a "next line" from Buf; Ptr to persist across several iterations
4001  * @param LineBuf your line will be copied here.
4002  * @param Buf BLOB with lines of text...
4003  * @param Ptr moved arround to keep the next-line across several iterations
4004  *        has to be &NULL on start; will be &NotNULL on end of buffer
4005  * @returns size of copied buffer
4006  */
4007 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr)
4008 {
4009         const char *aptr, *ptr, *eptr;
4010         char *optr, *xptr;
4011
4012         if ((Buf == NULL) || (*Ptr == StrBufNOTNULL)) {
4013                 *Ptr = StrBufNOTNULL;
4014                 return 0;
4015         }
4016
4017         FlushStrBuf(LineBuf);
4018         if (*Ptr==NULL)
4019                 ptr = aptr = Buf->buf;
4020         else
4021                 ptr = aptr = *Ptr;
4022
4023         optr = LineBuf->buf;
4024         eptr = Buf->buf + Buf->BufUsed;
4025         xptr = LineBuf->buf + LineBuf->BufSize - 1;
4026
4027         while ((ptr <= eptr) &&
4028                (*ptr != '\n') &&
4029                (*ptr != '\r') )
4030         {
4031                 *optr = *ptr;
4032                 optr++; ptr++;
4033                 if (optr == xptr) {
4034                         LineBuf->BufUsed = optr - LineBuf->buf;
4035                         IncreaseBuf(LineBuf,  1, LineBuf->BufUsed + 1);
4036                         optr = LineBuf->buf + LineBuf->BufUsed;
4037                         xptr = LineBuf->buf + LineBuf->BufSize - 1;
4038                 }
4039         }
4040
4041         if ((ptr >= eptr) && (optr > LineBuf->buf))
4042                 optr --;
4043         LineBuf->BufUsed = optr - LineBuf->buf;
4044         *optr = '\0';
4045         if ((ptr <= eptr) && (*ptr == '\r'))
4046                 ptr ++;
4047         if ((ptr <= eptr) && (*ptr == '\n'))
4048                 ptr ++;
4049
4050         if (ptr < eptr) {
4051                 *Ptr = ptr;
4052         }
4053         else {
4054                 *Ptr = StrBufNOTNULL;
4055         }
4056
4057         return Buf->BufUsed - (ptr - Buf->buf);
4058 }
4059
4060
4061 /**
4062  * @ingroup StrBuf_IO
4063  * @brief removes double slashes from pathnames
4064  * @param Dir directory string to filter
4065  * @param RemoveTrailingSlash allows / disallows trailing slashes
4066  */
4067 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash)
4068 {
4069         char *a, *b;
4070
4071         a = b = Dir->buf;
4072
4073         while (!IsEmptyStr(a)) {
4074                 if (*a == '/') {
4075                         while (*a == '/')
4076                                 a++;
4077                         *b = '/';
4078                         b++;
4079                 }
4080                 else {
4081                         *b = *a;
4082                         b++; a++;
4083                 }
4084         }
4085         if ((RemoveTrailingSlash) && (*(b - 1) != '/')){
4086                 *b = '/';
4087                 b++;
4088         }
4089         *b = '\0';
4090         Dir->BufUsed = b - Dir->buf;
4091 }
4092
4093