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 - 3; /* 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 - 3;
2024                         bptr = Target->buf + Target->BufUsed;
2025                 }
2026                 if (*aptr == '"') {
2027                         *bptr = '\\';
2028                         bptr ++;
2029                         *bptr = '"';
2030                         bptr ++;
2031                         Target->BufUsed += 2;
2032                 } else if (*aptr == '\\') {
2033                         *bptr = '\\';
2034                         bptr ++;
2035                         *bptr = '\\';
2036                         bptr ++;
2037                         Target->BufUsed += 2;
2038                 }
2039                 else{
2040                         *bptr = *aptr;
2041                         bptr++;
2042                         Target->BufUsed ++;
2043                 }
2044                 aptr ++;
2045         }
2046         *bptr = '\0';
2047         if ((bptr == eptr - 1 ) && !IsEmptyStr(aptr) )
2048                 return -1;
2049         return Target->BufUsed;
2050 }
2051
2052 /**
2053  * @ingroup StrBuf_DeEnCoder
2054  * @brief Append a string, escaping characters which have meaning in HTML + json.
2055  *
2056  * @param Target        target buffer
2057  * @param Source        source buffer; set to NULL if you just have a C-String
2058  * @param PlainIn       Plain-C string to append; set to NULL if unused
2059  * @param nbsp          If nonzero, spaces are converted to non-breaking spaces.
2060  * @param nolinebreaks  if set to 1, linebreaks are removed from the string.
2061  *                      if set to 2, linebreaks are replaced by &ltbr/&gt
2062  */
2063 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks)
2064 {
2065         const char *aptr, *eiptr;
2066         char *bptr, *eptr;
2067         long len;
2068         int IsUtf8Sequence = 0;
2069
2070         if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2071                 return -1;
2072
2073         if (PlainIn != NULL) {
2074                 aptr = PlainIn;
2075                 len = strlen(PlainIn);
2076                 eiptr = aptr + len;
2077         }
2078         else {
2079                 aptr = Source->buf;
2080                 eiptr = aptr + Source->BufUsed;
2081                 len = Source->BufUsed;
2082         }
2083
2084         if (len == 0)
2085                 return -1;
2086
2087         bptr = Target->buf + Target->BufUsed;
2088         eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in...  */
2089
2090         while (aptr < eiptr){
2091                 if(bptr >= eptr) {
2092                         IncreaseBuf(Target, 1, -1);
2093                         eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in...  */
2094                         bptr = Target->buf + Target->BufUsed;
2095                 }
2096                 switch (*aptr) {
2097                 case '<':
2098                         memcpy(bptr, HKEY("&lt;"));
2099                         bptr += 4;
2100                         Target->BufUsed += 4;
2101                         break;
2102                 case '>':
2103                         memcpy(bptr, HKEY("&gt;"));
2104                         bptr += 4;
2105                         Target->BufUsed += 4;
2106                         break;
2107                 case '&':
2108                         memcpy(bptr, HKEY("&amp;"));
2109                         bptr += 5;
2110                         Target->BufUsed += 5;
2111                         break;
2112                 case LB:
2113                         *bptr = '<';
2114                         bptr ++;
2115                         Target->BufUsed ++;
2116                         break;
2117                 case RB:
2118                         *bptr = '>';
2119                         bptr ++;
2120                         Target->BufUsed ++;
2121                         break;
2122                 case  32:
2123 //) && (nbsp == 1)) {
2124                         memcpy(bptr, HKEY("&nbsp;"));
2125                         bptr += 6;
2126                         Target->BufUsed += 6;
2127                         break;
2128                 case '\n':
2129                         switch (nolinebreaks) {
2130                         case 1:
2131                                 *bptr='\0';     /* nothing */
2132                                 break;
2133                         case 2:
2134                                 memcpy(bptr, HKEY("&lt;br/&gt;"));
2135                                 bptr += 11;
2136                                 Target->BufUsed += 11;
2137                                 break;
2138                         default:
2139                                 memcpy(bptr, HKEY("\\n"));
2140                                 bptr += 2;
2141                                 Target->BufUsed += 2;
2142                         }
2143                         break;
2144                 case '\r':
2145                         switch (nolinebreaks) {
2146                         case 1:
2147                         case 2:
2148                                 *bptr='\0';     /* nothing */
2149                                 break;
2150                         default:
2151                                 memcpy(bptr, HKEY("\\r"));
2152                                 bptr += 2;
2153                                 Target->BufUsed += 2;
2154                                 break;
2155                         }
2156                         break;
2157                 case '"':
2158                 case QU:
2159                         *bptr = '\\';
2160                         bptr ++;
2161                         *bptr = '"';
2162                         bptr ++;
2163                         Target->BufUsed += 2;
2164                         break;
2165                 case '\\':
2166                         if ((*(aptr + 1) == 'u') &&
2167                             isxdigit(*(aptr + 2)) &&
2168                             isxdigit(*(aptr + 3)) &&
2169                             isxdigit(*(aptr + 4)) &&
2170                             isxdigit(*(aptr + 5)))
2171                         { /* oh, a unicode escaper. let it pass through. */
2172                                 memcpy(bptr, aptr, 6);
2173                                 aptr += 5;
2174                                 bptr +=6;
2175                                 Target->BufUsed += 6;
2176                         }
2177                         else
2178                         {
2179                                 *bptr = '\\';
2180                                 bptr ++;
2181                                 *bptr = '\\';
2182                                 bptr ++;
2183                                 Target->BufUsed += 2;
2184                         }
2185                         break;
2186                 case '\b':
2187                         *bptr = '\\';
2188                         bptr ++;
2189                         *bptr = 'b';
2190                         bptr ++;
2191                         Target->BufUsed += 2;
2192                         break;
2193                 case '\f':
2194                         *bptr = '\\';
2195                         bptr ++;
2196                         *bptr = 'f';
2197                         bptr ++;
2198                         Target->BufUsed += 2;
2199                         break;
2200                 case '\t':
2201                         *bptr = '\\';
2202                         bptr ++;
2203                         *bptr = 't';
2204                         bptr ++;
2205                         Target->BufUsed += 2;
2206                         break;
2207                 default:
2208                         IsUtf8Sequence =  Ctdl_GetUtf8SequenceLength(aptr, eiptr);
2209                         while (IsUtf8Sequence > 0){
2210                                 *bptr = *aptr;
2211                                 Target->BufUsed ++;
2212                                 if (--IsUtf8Sequence)
2213                                         aptr++;
2214                                 bptr++;
2215                         }
2216                 }
2217                 aptr ++;
2218         }
2219         *bptr = '\0';
2220         if ((bptr = eptr - 1 ) && !IsEmptyStr(aptr) )
2221                 return -1;
2222         return Target->BufUsed;
2223 }
2224
2225 /**
2226  * @ingroup StrBuf_DeEnCoder
2227  * @brief unhide special chars hidden to the HTML escaper
2228  * @param target buffer to put the unescaped string in
2229  * @param source buffer to unescape
2230  */
2231 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source)
2232 {
2233         int a, b, len;
2234         char hex[3];
2235
2236         if (target != NULL)
2237                 FlushStrBuf(target);
2238
2239         if (source == NULL ||target == NULL)
2240         {
2241                 return;
2242         }
2243
2244         len = source->BufUsed;
2245         for (a = 0; a < len; ++a) {
2246                 if (target->BufUsed >= target->BufSize)
2247                         IncreaseBuf(target, 1, -1);
2248
2249                 if (source->buf[a] == '=') {
2250                         hex[0] = source->buf[a + 1];
2251                         hex[1] = source->buf[a + 2];
2252                         hex[2] = 0;
2253                         b = 0;
2254                         sscanf(hex, "%02x", &b);
2255                         target->buf[target->BufUsed] = b;
2256                         target->buf[++target->BufUsed] = 0;
2257                         a += 2;
2258                 }
2259                 else {
2260                         target->buf[target->BufUsed] = source->buf[a];
2261                         target->buf[++target->BufUsed] = 0;
2262                 }
2263         }
2264 }
2265
2266
2267 /**
2268  * @ingroup StrBuf_DeEnCoder
2269  * @brief hide special chars from the HTML escapers and friends
2270  * @param target buffer to put the escaped string in
2271  * @param source buffer to escape
2272  */
2273 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source)
2274 {
2275         int i, len;
2276
2277         if (target != NULL)
2278                 FlushStrBuf(target);
2279
2280         if (source == NULL ||target == NULL)
2281         {
2282                 return;
2283         }
2284
2285         len = source->BufUsed;
2286         for (i=0; i<len; ++i) {
2287                 if (target->BufUsed + 4 >= target->BufSize)
2288                         IncreaseBuf(target, 1, -1);
2289                 if ( (isalnum(source->buf[i])) ||
2290                      (source->buf[i]=='-') ||
2291                      (source->buf[i]=='_') ) {
2292                         target->buf[target->BufUsed++] = source->buf[i];
2293                 }
2294                 else {
2295                         sprintf(&target->buf[target->BufUsed],
2296                                 "=%02X",
2297                                 (0xFF &source->buf[i]));
2298                         target->BufUsed += 3;
2299                 }
2300         }
2301         target->buf[target->BufUsed + 1] = '\0';
2302 }
2303
2304
2305 /*******************************************************************************
2306  *                      Quoted Printable de/encoding                           *
2307  *******************************************************************************/
2308
2309 /**
2310  * @ingroup StrBuf_DeEnCoder
2311  * @brief decode a buffer from base 64 encoding; destroys original
2312  * @param Buf Buffor to transform
2313  */
2314 int StrBufDecodeBase64(StrBuf *Buf)
2315 {
2316         char *xferbuf;
2317         size_t siz;
2318         if (Buf == NULL) return -1;
2319
2320         xferbuf = (char*) malloc(Buf->BufSize);
2321         *xferbuf = '\0';
2322         siz = CtdlDecodeBase64(xferbuf,
2323                                Buf->buf,
2324                                Buf->BufUsed);
2325         free(Buf->buf);
2326         Buf->buf = xferbuf;
2327         Buf->BufUsed = siz;
2328         return siz;
2329 }
2330
2331 /**
2332  * @ingroup StrBuf_DeEnCoder
2333  * @brief decode a buffer from base 64 encoding; destroys original
2334  * @param Buf Buffor to transform
2335  */
2336 int StrBufDecodeHex(StrBuf *Buf)
2337 {
2338         unsigned int ch;
2339         char *pch, *pche, *pchi;
2340
2341         if (Buf == NULL) return -1;
2342
2343         pch = pchi = Buf->buf;
2344         pche = pch + Buf->BufUsed;
2345
2346         while (pchi < pche){
2347                 ch = decode_hex(pchi);
2348                 *pch = ch;
2349                 pch ++;
2350                 pchi += 2;
2351         }
2352
2353         *pch = '\0';
2354         Buf->BufUsed = pch - Buf->buf;
2355         return Buf->BufUsed;
2356 }
2357
2358 /**
2359  * @ingroup StrBuf_DeEnCoder
2360  * @brief replace all chars >0x20 && < 0x7F with Mute
2361  * @param Mute char to put over invalid chars
2362  * @param Buf Buffor to transform
2363  */
2364 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute)
2365 {
2366         unsigned char *pch;
2367
2368         if (Buf == NULL) return -1;
2369         pch = (unsigned char *)Buf->buf;
2370         while (pch < (unsigned char *)Buf->buf + Buf->BufUsed) {
2371                 if ((*pch < 0x20) || (*pch > 0x7F))
2372                         *pch = Mute;
2373                 pch ++;
2374         }
2375         return Buf->BufUsed;
2376 }
2377
2378
2379 /**
2380  * @ingroup StrBuf_DeEnCoder
2381  * @brief remove escaped strings from i.e. the url string (like %20 for blanks)
2382  * @param Buf Buffer to translate
2383  * @param StripBlanks Reduce several blanks to one?
2384  */
2385 long StrBufUnescape(StrBuf *Buf, int StripBlanks)
2386 {
2387         int a, b;
2388         char hex[3];
2389         long len;
2390
2391         if (Buf == NULL)
2392                 return -1;
2393
2394         while ((Buf->BufUsed > 0) && (isspace(Buf->buf[Buf->BufUsed - 1]))){
2395                 Buf->buf[Buf->BufUsed - 1] = '\0';
2396                 Buf->BufUsed --;
2397         }
2398
2399         a = 0;
2400         while (a < Buf->BufUsed) {
2401                 if (Buf->buf[a] == '+')
2402                         Buf->buf[a] = ' ';
2403                 else if (Buf->buf[a] == '%') {
2404                         /* don't let % chars through, rather truncate the input. */
2405                         if (a + 2 > Buf->BufUsed) {
2406                                 Buf->buf[a] = '\0';
2407                                 Buf->BufUsed = a;
2408                         }
2409                         else {
2410                                 hex[0] = Buf->buf[a + 1];
2411                                 hex[1] = Buf->buf[a + 2];
2412                                 hex[2] = 0;
2413                                 b = 0;
2414                                 sscanf(hex, "%02x", &b);
2415                                 Buf->buf[a] = (char) b;
2416                                 len = Buf->BufUsed - a - 2;
2417                                 if (len > 0)
2418                                         memmove(&Buf->buf[a + 1], &Buf->buf[a + 3], len);
2419
2420                                 Buf->BufUsed -=2;
2421                         }
2422                 }
2423                 a++;
2424         }
2425         return a;
2426 }
2427
2428
2429 /**
2430  * @ingroup StrBuf_DeEnCoder
2431  * @brief       RFC2047-encode a header field if necessary.
2432  *              If no non-ASCII characters are found, the string
2433  *              will be copied verbatim without encoding.
2434  *
2435  * @param       target          Target buffer.
2436  * @param       source          Source string to be encoded.
2437  * @returns     encoded length; -1 if non success.
2438  */
2439 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source)
2440 {
2441         const char headerStr[] = "=?UTF-8?Q?";
2442         int need_to_encode = 0;
2443         int i = 0;
2444         unsigned char ch;
2445
2446         if ((source == NULL) ||
2447             (target == NULL))
2448             return -1;
2449
2450         while ((i < source->BufUsed) &&
2451                (!IsEmptyStr (&source->buf[i])) &&
2452                (need_to_encode == 0)) {
2453                 if (((unsigned char) source->buf[i] < 32) ||
2454                     ((unsigned char) source->buf[i] > 126)) {
2455                         need_to_encode = 1;
2456                 }
2457                 i++;
2458         }
2459
2460         if (!need_to_encode) {
2461                 if (*target == NULL) {
2462                         *target = NewStrBufPlain(source->buf, source->BufUsed);
2463                 }
2464                 else {
2465                         FlushStrBuf(*target);
2466                         StrBufAppendBuf(*target, source, 0);
2467                 }
2468                 return (*target)->BufUsed;
2469         }
2470         if (*target == NULL)
2471                 *target = NewStrBufPlain(NULL, sizeof(headerStr) + source->BufUsed * 2);
2472         else if (sizeof(headerStr) + source->BufUsed >= (*target)->BufSize)
2473                 IncreaseBuf(*target, sizeof(headerStr) + source->BufUsed, 0);
2474         memcpy ((*target)->buf, headerStr, sizeof(headerStr) - 1);
2475         (*target)->BufUsed = sizeof(headerStr) - 1;
2476         for (i=0; (i < source->BufUsed); ++i) {
2477                 if ((*target)->BufUsed + 4 >= (*target)->BufSize)
2478                         IncreaseBuf(*target, 1, 0);
2479                 ch = (unsigned char) source->buf[i];
2480                 if ((ch  <  32) ||
2481                     (ch  > 126) ||
2482                     (ch ==  61) ||
2483                     (ch == '=') ||
2484                     (ch == '[') ||
2485                     (ch == ']')   )
2486                 {
2487                         sprintf(&(*target)->buf[(*target)->BufUsed], "=%02X", ch);
2488                         (*target)->BufUsed += 3;
2489                 }
2490                 else {
2491                         (*target)->buf[(*target)->BufUsed] = ch;
2492                         (*target)->BufUsed++;
2493                 }
2494         }
2495
2496         if ((*target)->BufUsed + 4 >= (*target)->BufSize)
2497                 IncreaseBuf(*target, 1, 0);
2498
2499         (*target)->buf[(*target)->BufUsed++] = '?';
2500         (*target)->buf[(*target)->BufUsed++] = '=';
2501         (*target)->buf[(*target)->BufUsed] = '\0';
2502         return (*target)->BufUsed;;
2503 }
2504
2505
2506
2507 static void AddRecipient(StrBuf *Target,
2508                          StrBuf *UserName,
2509                          StrBuf *EmailAddress,
2510                          StrBuf *EncBuf)
2511 {
2512         int QuoteMe = 0;
2513
2514         if (StrLength(Target) > 0) StrBufAppendBufPlain(Target, HKEY(", "), 0);
2515         if (strchr(ChrPtr(UserName), ',') != NULL) QuoteMe = 1;
2516
2517         if (QuoteMe)  StrBufAppendBufPlain(Target, HKEY("\""), 0);
2518         StrBufRFC2047encode(&EncBuf, UserName);
2519         StrBufAppendBuf(Target, EncBuf, 0);
2520         if (QuoteMe)  StrBufAppendBufPlain(Target, HKEY("\" "), 0);
2521         else          StrBufAppendBufPlain(Target, HKEY(" "), 0);
2522
2523         if (StrLength(EmailAddress) > 0){
2524                 StrBufAppendBufPlain(Target, HKEY("<"), 0);
2525                 StrBufAppendBuf(Target, EmailAddress, 0); /* TODO: what about IDN???? */
2526                 StrBufAppendBufPlain(Target, HKEY(">"), 0);
2527         }
2528 }
2529
2530
2531 /**
2532  * \brief QP encode parts of an email TO/CC/BCC vector, and strip/filter invalid parts
2533  * \param Recp Source list of email recipients
2534  * \param UserName Temporary buffer for internal use; Please provide valid buffer.
2535  * \param EmailAddress Temporary buffer for internal use; Please provide valid buffer.
2536  * \param EncBuf Temporary buffer for internal use; Please provide valid buffer.
2537  * \returns encoded & sanitized buffer with the contents of Recp; Caller owns this memory.
2538  */
2539 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
2540                                            StrBuf *UserName,
2541                                            StrBuf *EmailAddress,
2542                                            StrBuf *EncBuf)
2543 {
2544         StrBuf *Target;
2545         int need_to_encode;
2546
2547         const char *pch, *pche;
2548         const char *UserStart, *UserEnd, *EmailStart, *EmailEnd, *At;
2549
2550         if ((Recp == NULL) || (StrLength(Recp) == 0))
2551                 return NULL;
2552
2553         need_to_encode = 0;
2554         pch = ChrPtr(Recp);
2555         pche = pch + StrLength(Recp);
2556
2557         if (!CheckEncode(pch, -1, pche))
2558                 return NewStrBufDup(Recp);
2559
2560         Target = NewStrBufPlain(NULL, StrLength(Recp));
2561
2562         while ((pch != NULL) && (pch < pche))
2563         {
2564                 int ColonOk = 0;
2565
2566                 while (isspace(*pch)) pch++;
2567                 UserStart = UserEnd = EmailStart = EmailEnd = NULL;
2568
2569                 if ((*pch == '"') || (*pch == '\'')) {
2570                         UserStart = pch + 1;
2571
2572                         UserEnd = strchr(UserStart, *pch);
2573                         if (UserEnd == NULL)
2574                                 break; ///TODO: Userfeedback??
2575                         EmailStart = UserEnd + 1;
2576                         while (isspace(*EmailStart))
2577                                 EmailStart++;
2578                         if (UserEnd == UserStart) {
2579                                 UserStart = UserEnd = NULL;
2580                         }
2581
2582                         if (*EmailStart == '<') {
2583                                 EmailStart++;
2584                                 EmailEnd = strchr(EmailStart, '>');
2585                                 if (EmailEnd == NULL)
2586                                         EmailEnd = strchr(EmailStart, ',');
2587
2588                         }
2589                         else {
2590                                 EmailEnd = strchr(EmailStart, ',');
2591                         }
2592                         if (EmailEnd == NULL)
2593                                 EmailEnd = pche;
2594                         pch = EmailEnd + 1;
2595                         ColonOk = 1;
2596                 }
2597                 else {
2598                         int gt = 0;
2599                         UserStart = pch;
2600                         EmailEnd = strchr(UserStart, ',');
2601                         if (EmailEnd == NULL) {
2602                                 EmailEnd = strchr(pch, '>');
2603                                 pch = NULL;
2604                                 if (EmailEnd != NULL) {
2605                                         gt = 1;
2606                                 }
2607                                 else {
2608                                         EmailEnd = pche;
2609                                 }
2610                         }
2611                         else {
2612
2613                                 pch = EmailEnd + 1;
2614                                 while ((EmailEnd > UserStart) && !gt &&
2615                                        ((*EmailEnd == ',') ||
2616                                         (*EmailEnd == '>') ||
2617                                         (isspace(*EmailEnd))))
2618                                 {
2619                                         if (*EmailEnd == '>')
2620                                                 gt = 1;
2621                                         else
2622                                                 EmailEnd--;
2623                                 }
2624                                 if (EmailEnd == UserStart)
2625                                         break;
2626                         }
2627                         if (gt) {
2628                                 EmailStart = strchr(UserStart, '<');
2629                                 if ((EmailStart == NULL) || (EmailStart > EmailEnd))
2630                                         break;
2631                                 UserEnd = EmailStart;
2632
2633                                 while ((UserEnd > UserStart) &&
2634                                        isspace (*(UserEnd - 1)))
2635                                         UserEnd --;
2636                                 EmailStart ++;
2637                                 if (UserStart >= UserEnd)
2638                                         UserStart = UserEnd = NULL;
2639                                 At = strchr(EmailStart, '@');
2640                         }
2641                         else { /* this is a local recipient... no domain, just a realname */
2642                                 EmailStart = UserStart;
2643                                 At = strchr(EmailStart, '@');
2644                                 if (At == NULL) {
2645                                         UserEnd = EmailEnd;
2646                                         EmailEnd = NULL;
2647                                 }
2648                                 else {
2649                                         EmailStart = UserStart;
2650                                         UserStart = NULL;
2651                                 }
2652                         }
2653                 }
2654
2655                 if ((UserStart != NULL) && (UserEnd != NULL))
2656                         StrBufPlain(UserName, UserStart, UserEnd - UserStart);
2657                 else if ((UserStart != NULL) && (UserEnd == NULL))
2658                         StrBufPlain(UserName, UserStart, UserEnd - UserStart);
2659                 else
2660                         FlushStrBuf(UserName);
2661
2662                 if ((EmailStart != NULL) && (EmailEnd != NULL))
2663                         StrBufPlain(EmailAddress, EmailStart, EmailEnd - EmailStart);
2664                 else if ((EmailStart != NULL) && (EmailEnd == NULL))
2665                         StrBufPlain(EmailAddress, EmailStart, EmailEnd - pche);
2666                 else
2667                         FlushStrBuf(EmailAddress);
2668
2669                 AddRecipient(Target, UserName, EmailAddress, EncBuf);
2670
2671                 if (pch == NULL)
2672                         break;
2673
2674                 if ((pch != NULL) && (*pch == ','))
2675                         pch ++;
2676                 if (pch != NULL) while (isspace(*pch))
2677                         pch ++;
2678         }
2679         return Target;
2680 }
2681
2682
2683 /**
2684  * @ingroup StrBuf
2685  * @brief replaces all occurances of 'search' by 'replace'
2686  * @param buf Buffer to modify
2687  * @param search character to search
2688  * @param replace character to replace search by
2689  */
2690 void StrBufReplaceChars(StrBuf *buf, char search, char replace)
2691 {
2692         long i;
2693         if (buf == NULL)
2694                 return;
2695         for (i=0; i<buf->BufUsed; i++)
2696                 if (buf->buf[i] == search)
2697                         buf->buf[i] = replace;
2698
2699 }
2700
2701 /**
2702  * @ingroup StrBuf
2703  * @brief removes all \r s from the string, or replaces them with \n if its not a combination of both.
2704  * @param buf Buffer to modify
2705  */
2706 void StrBufToUnixLF(StrBuf *buf)
2707 {
2708         char *pche, *pchS, *pchT;
2709         if (buf == NULL)
2710                 return;
2711
2712         pche = buf->buf + buf->BufUsed;
2713         pchS = pchT = buf->buf;
2714         while (pchS < pche)
2715         {
2716                 if (*pchS == '\r')
2717                 {
2718                         pchS ++;
2719                         if (*pchS != '\n') {
2720                                 *pchT = '\n';
2721                                 pchT++;
2722                         }
2723                 }
2724                 *pchT = *pchS;
2725                 pchT++; pchS++;
2726         }
2727         *pchT = '\0';
2728         buf->BufUsed = pchT - buf->buf;
2729 }
2730
2731
2732 /*******************************************************************************
2733  *                 Iconv Wrapper; RFC822 de/encoding                           *
2734  *******************************************************************************/
2735
2736 /**
2737  * @ingroup StrBuf_DeEnCoder
2738  * @brief Wrapper around iconv_open()
2739  * Our version adds aliases for non-standard Microsoft charsets
2740  * such as 'MS950', aliasing them to names like 'CP950'
2741  *
2742  * @param tocode        Target encoding
2743  * @param fromcode      Source encoding
2744  * @param pic           anonimized pointer to iconv struct
2745  */
2746 void  ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic)
2747 {
2748 #ifdef HAVE_ICONV
2749         iconv_t ic = (iconv_t)(-1) ;
2750         ic = iconv_open(tocode, fromcode);
2751         if (ic == (iconv_t)(-1) ) {
2752                 char alias_fromcode[64];
2753                 if ( (strlen(fromcode) == 5) && (!strncasecmp(fromcode, "MS", 2)) ) {
2754                         safestrncpy(alias_fromcode, fromcode, sizeof alias_fromcode);
2755                         alias_fromcode[0] = 'C';
2756                         alias_fromcode[1] = 'P';
2757                         ic = iconv_open(tocode, alias_fromcode);
2758                 }
2759         }
2760         *(iconv_t *)pic = ic;
2761 #endif
2762 }
2763
2764
2765 /**
2766  * @ingroup StrBuf_DeEnCoder
2767  * @brief find one chunk of a RFC822 encoded string
2768  * @param Buffer where to search
2769  * @param bptr where to start searching
2770  * @returns found position, NULL if none.
2771  */
2772 static inline const char *FindNextEnd (const StrBuf *Buf, const char *bptr)
2773 {
2774         const char * end;
2775         /* Find the next ?Q? */
2776         if (Buf->BufUsed - (bptr - Buf->buf)  < 6)
2777                 return NULL;
2778
2779         end = strchr(bptr + 2, '?');
2780
2781         if (end == NULL)
2782                 return NULL;
2783
2784         if ((Buf->BufUsed - (end - Buf->buf) > 3) &&
2785             ((*(end + 1) == 'B') || (*(end + 1) == 'Q')) &&
2786             (*(end + 2) == '?')) {
2787                 /* skip on to the end of the cluster, the next ?= */
2788                 end = strstr(end + 3, "?=");
2789         }
2790         else
2791                 /* sort of half valid encoding, try to find an end. */
2792                 end = strstr(bptr, "?=");
2793         return end;
2794 }
2795
2796 /**
2797  * @ingroup StrBuf
2798  * @brief swaps the contents of two StrBufs
2799  * this is to be used to have cheap switched between a work-buffer and a target buffer
2800  * @param A First one
2801  * @param B second one
2802  */
2803 static inline void SwapBuffers(StrBuf *A, StrBuf *B)
2804 {
2805         StrBuf C;
2806
2807         memcpy(&C, A, sizeof(*A));
2808         memcpy(A, B, sizeof(*B));
2809         memcpy(B, &C, sizeof(C));
2810
2811 }
2812
2813
2814 /**
2815  * @ingroup StrBuf_DeEnCoder
2816  * @brief convert one buffer according to the preselected iconv pointer PIC
2817  * @param ConvertBuf buffer we need to translate
2818  * @param TmpBuf To share a workbuffer over several iterations. prepare to have it filled with useless stuff afterwards.
2819  * @param pic Pointer to the iconv-session Object
2820  */
2821 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic)
2822 {
2823 #ifdef HAVE_ICONV
2824         long trycount = 0;
2825         size_t siz;
2826         iconv_t ic;
2827         char *ibuf;                     /**< Buffer of characters to be converted */
2828         char *obuf;                     /**< Buffer for converted characters */
2829         size_t ibuflen;                 /**< Length of input buffer */
2830         size_t obuflen;                 /**< Length of output buffer */
2831
2832
2833         /* since we're converting to utf-8, one glyph may take up to 6 bytes */
2834         if (ConvertBuf->BufUsed * 6 >= TmpBuf->BufSize)
2835                 IncreaseBuf(TmpBuf, 0, ConvertBuf->BufUsed * 6);
2836 TRYAGAIN:
2837         ic = *(iconv_t*)pic;
2838         ibuf = ConvertBuf->buf;
2839         ibuflen = ConvertBuf->BufUsed;
2840         obuf = TmpBuf->buf;
2841         obuflen = TmpBuf->BufSize;
2842
2843         siz = iconv(ic, &ibuf, &ibuflen, &obuf, &obuflen);
2844
2845         if (siz < 0) {
2846                 if (errno == E2BIG) {
2847                         trycount ++;
2848                         IncreaseBuf(TmpBuf, 0, 0);
2849                         if (trycount < 5)
2850                                 goto TRYAGAIN;
2851
2852                 }
2853                 else if (errno == EILSEQ){
2854                         /* hm, invalid utf8 sequence... what to do now? */
2855                         /* An invalid multibyte sequence has been encountered in the input */
2856                 }
2857                 else if (errno == EINVAL) {
2858                         /* An incomplete multibyte sequence has been encountered in the input. */
2859                 }
2860
2861                 FlushStrBuf(TmpBuf);
2862         }
2863         else {
2864                 TmpBuf->BufUsed = TmpBuf->BufSize - obuflen;
2865                 TmpBuf->buf[TmpBuf->BufUsed] = '\0';
2866
2867                 /* little card game: wheres the red lady? */
2868                 SwapBuffers(ConvertBuf, TmpBuf);
2869                 FlushStrBuf(TmpBuf);
2870         }
2871 #endif
2872 }
2873
2874
2875 /**
2876  * @ingroup StrBuf_DeEnCoder
2877  * @brief catches one RFC822 encoded segment, and decodes it.
2878  * @param Target buffer to fill with result
2879  * @param DecodeMe buffer with stuff to process
2880  * @param SegmentStart points to our current segment in DecodeMe
2881  * @param SegmentEnd Points to the end of our current segment in DecodeMe
2882  * @param ConvertBuf Workbuffer shared between several iterations. Random content; needs to be valid
2883  * @param ConvertBuf2 Workbuffer shared between several iterations. Random content; needs to be valid
2884  * @param FoundCharset Characterset to default decoding to; if we find another we will overwrite it.
2885  */
2886 inline static void DecodeSegment(StrBuf *Target,
2887                                  const StrBuf *DecodeMe,
2888                                  const char *SegmentStart,
2889                                  const char *SegmentEnd,
2890                                  StrBuf *ConvertBuf,
2891                                  StrBuf *ConvertBuf2,
2892                                  StrBuf *FoundCharset)
2893 {
2894         StrBuf StaticBuf;
2895         char charset[128];
2896         char encoding[16];
2897 #ifdef HAVE_ICONV
2898         iconv_t ic = (iconv_t)(-1);
2899 #else
2900         void *ic = NULL;
2901 #endif
2902         /* Now we handle foreign character sets properly encoded
2903          * in RFC2047 format.
2904          */
2905         StaticBuf.buf = (char*) SegmentStart; /*< it will just be read there... */
2906         StaticBuf.BufUsed = SegmentEnd - SegmentStart;
2907         StaticBuf.BufSize = DecodeMe->BufSize - (SegmentStart - DecodeMe->buf);
2908         extract_token(charset, SegmentStart, 1, '?', sizeof charset);
2909         if (FoundCharset != NULL) {
2910                 FlushStrBuf(FoundCharset);
2911                 StrBufAppendBufPlain(FoundCharset, charset, -1, 0);
2912         }
2913         extract_token(encoding, SegmentStart, 2, '?', sizeof encoding);
2914         StrBufExtract_token(ConvertBuf, &StaticBuf, 3, '?');
2915
2916         *encoding = toupper(*encoding);
2917         if (*encoding == 'B') { /**< base64 */
2918                 if (ConvertBuf2->BufSize < ConvertBuf->BufUsed)
2919                         IncreaseBuf(ConvertBuf2, 0, ConvertBuf->BufUsed);
2920                 ConvertBuf2->BufUsed = CtdlDecodeBase64(ConvertBuf2->buf,
2921                                                         ConvertBuf->buf,
2922                                                         ConvertBuf->BufUsed);
2923         }
2924         else if (*encoding == 'Q') {    /**< quoted-printable */
2925                 long pos;
2926
2927                 pos = 0;
2928                 while (pos < ConvertBuf->BufUsed)
2929                 {
2930                         if (ConvertBuf->buf[pos] == '_')
2931                                 ConvertBuf->buf[pos] = ' ';
2932                         pos++;
2933                 }
2934
2935                 if (ConvertBuf2->BufSize < ConvertBuf->BufUsed)
2936                         IncreaseBuf(ConvertBuf2, 0, ConvertBuf->BufUsed);
2937
2938                 ConvertBuf2->BufUsed = CtdlDecodeQuotedPrintable(
2939                         ConvertBuf2->buf,
2940                         ConvertBuf->buf,
2941                         ConvertBuf->BufUsed);
2942         }
2943         else {
2944                 StrBufAppendBuf(ConvertBuf2, ConvertBuf, 0);
2945         }
2946 #ifdef HAVE_ICONV
2947         ctdl_iconv_open("UTF-8", charset, &ic);
2948         if (ic != (iconv_t)(-1) ) {
2949 #endif
2950                 StrBufConvert(ConvertBuf2, ConvertBuf, &ic);
2951                 StrBufAppendBuf(Target, ConvertBuf2, 0);
2952 #ifdef HAVE_ICONV
2953                 iconv_close(ic);
2954         }
2955         else {
2956                 StrBufAppendBufPlain(Target, HKEY("(unreadable)"), 0);
2957         }
2958 #endif
2959 }
2960
2961 /**
2962  * @ingroup StrBuf_DeEnCoder
2963  * @brief Handle subjects with RFC2047 encoding such as:
2964  * =?koi8-r?B?78bP0s3Mxc7JxSDXz9rE1dvO2c3JINvB0sHNySDP?=
2965  * @param Target where to put the decoded string to
2966  * @param DecodeMe buffer with encoded string
2967  * @param DefaultCharset if we don't find one, which should we use?
2968  * @param FoundCharset overrides DefaultCharset if non-empty; If we find a charset inside of the string,
2969  *        put it here for later use where no string might be known.
2970  */
2971 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset)
2972 {
2973         StrBuf *DecodedInvalidBuf = NULL;
2974         StrBuf *ConvertBuf, *ConvertBuf2;
2975         const StrBuf *DecodeMee = DecodeMe;
2976         const char *start, *end, *next, *nextend, *ptr = NULL;
2977 #ifdef HAVE_ICONV
2978         iconv_t ic = (iconv_t)(-1) ;
2979 #endif
2980         const char *eptr;
2981         int passes = 0;
2982         int i, len;
2983         int illegal_non_rfc2047_encoding = 0;
2984
2985         /* Sometimes, badly formed messages contain strings which were simply
2986          *  written out directly in some foreign character set instead of
2987          *  using RFC2047 encoding.  This is illegal but we will attempt to
2988          *  handle it anyway by converting from a user-specified default
2989          *  charset to UTF-8 if we see any nonprintable characters.
2990          */
2991
2992         len = StrLength(DecodeMe);
2993         for (i=0; i<DecodeMe->BufUsed; ++i) {
2994                 if ((DecodeMe->buf[i] < 32) || (DecodeMe->buf[i] > 126)) {
2995                         illegal_non_rfc2047_encoding = 1;
2996                         break;
2997                 }
2998         }
2999
3000         ConvertBuf = NewStrBufPlain(NULL, StrLength(DecodeMe));
3001         if ((illegal_non_rfc2047_encoding) &&
3002             (strcasecmp(ChrPtr(DefaultCharset), "UTF-8")) &&
3003             (strcasecmp(ChrPtr(DefaultCharset), "us-ascii")) )
3004         {
3005 #ifdef HAVE_ICONV
3006                 ctdl_iconv_open("UTF-8", ChrPtr(DefaultCharset), &ic);
3007                 if (ic != (iconv_t)(-1) ) {
3008                         DecodedInvalidBuf = NewStrBufDup(DecodeMe);
3009                         StrBufConvert(DecodedInvalidBuf, ConvertBuf, &ic);///TODO: don't void const?
3010                         DecodeMee = DecodedInvalidBuf;
3011                         iconv_close(ic);
3012                 }
3013 #endif
3014         }
3015
3016         /* pre evaluate the first pair */
3017         nextend = end = NULL;
3018         len = StrLength(DecodeMee);
3019         start = strstr(DecodeMee->buf, "=?");
3020         eptr = DecodeMee->buf + DecodeMee->BufUsed;
3021         if (start != NULL)
3022                 end = FindNextEnd (DecodeMee, start);
3023         else {
3024                 StrBufAppendBuf(Target, DecodeMee, 0);
3025                 FreeStrBuf(&ConvertBuf);
3026                 FreeStrBuf(&DecodedInvalidBuf);
3027                 return;
3028         }
3029
3030         ConvertBuf2 = NewStrBufPlain(NULL, StrLength(DecodeMee));
3031
3032         if (start != DecodeMee->buf) {
3033                 long nFront;
3034
3035                 nFront = start - DecodeMee->buf;
3036                 StrBufAppendBufPlain(Target, DecodeMee->buf, nFront, 0);
3037                 len -= nFront;
3038         }
3039         /*
3040          * Since spammers will go to all sorts of absurd lengths to get their
3041          * messages through, there are LOTS of corrupt headers out there.
3042          * So, prevent a really badly formed RFC2047 header from throwing
3043          * this function into an infinite loop.
3044          */
3045         while ((start != NULL) &&
3046                (end != NULL) &&
3047                (start < eptr) &&
3048                (end < eptr) &&
3049                (passes < 20))
3050         {
3051                 passes++;
3052                 DecodeSegment(Target,
3053                               DecodeMee,
3054                               start,
3055                               end,
3056                               ConvertBuf,
3057                               ConvertBuf2,
3058                               FoundCharset);
3059
3060                 next = strstr(end, "=?");
3061                 nextend = NULL;
3062                 if ((next != NULL) &&
3063                     (next < eptr))
3064                         nextend = FindNextEnd(DecodeMee, next);
3065                 if (nextend == NULL)
3066                         next = NULL;
3067
3068                 /* did we find two partitions */
3069                 if ((next != NULL) &&
3070                     ((next - end) > 2))
3071                 {
3072                         ptr = end + 2;
3073                         while ((ptr < next) &&
3074                                (isspace(*ptr) ||
3075                                 (*ptr == '\r') ||
3076                                 (*ptr == '\n') ||
3077                                 (*ptr == '\t')))
3078                                 ptr ++;
3079                         /*
3080                          * did we find a gab just filled with blanks?
3081                          * if not, copy its stuff over.
3082                          */
3083                         if (ptr != next)
3084                         {
3085                                 StrBufAppendBufPlain(Target,
3086                                                      end + 2,
3087                                                      next - end - 2,
3088                                                      0);
3089                         }
3090                 }
3091                 /* our next-pair is our new first pair now. */
3092                 ptr = end + 2;
3093                 start = next;
3094                 end = nextend;
3095         }
3096         end = ptr;
3097         nextend = DecodeMee->buf + DecodeMee->BufUsed;
3098         if ((end != NULL) && (end < nextend)) {
3099                 ptr = end;
3100                 while ( (ptr < nextend) &&
3101                         (isspace(*ptr) ||
3102                          (*ptr == '\r') ||
3103                          (*ptr == '\n') ||
3104                          (*ptr == '\t')))
3105                         ptr ++;
3106                 if (ptr < nextend)
3107                         StrBufAppendBufPlain(Target, end, nextend - end, 0);
3108         }
3109         FreeStrBuf(&ConvertBuf);
3110         FreeStrBuf(&ConvertBuf2);
3111         FreeStrBuf(&DecodedInvalidBuf);
3112 }
3113
3114 /*******************************************************************************
3115  *                   Manipulating UTF-8 Strings                                *
3116  *******************************************************************************/
3117
3118 /**
3119  * @ingroup StrBuf
3120  * @brief evaluate the length of an utf8 special character sequence
3121  * @param Char the character to examine
3122  * @returns width of utf8 chars in bytes; if the sequence is broken 0 is returned; 1 if its simply ASCII.
3123  */
3124 static inline int Ctdl_GetUtf8SequenceLength(const char *CharS, const char *CharE)
3125 {
3126         int n = 1;
3127         char test = (1<<7);
3128
3129         if ((*CharS & 0xC0) == 0)
3130                 return 1;
3131
3132         while ((n < 8) && ((test & *CharS) != 0)) {
3133                 test = test << 1;
3134                 n ++;
3135         }
3136         if ((n > 6) || ((CharE - CharS) < n))
3137                 n = 0;
3138         return n;
3139 }
3140
3141 /**
3142  * @ingroup StrBuf
3143  * @brief detect whether this char starts an utf-8 encoded char
3144  * @param Char character to inspect
3145  * @returns yes or no
3146  */
3147 static inline int Ctdl_IsUtf8SequenceStart(const char Char)
3148 {
3149 /** 11??.???? indicates an UTF8 Sequence. */
3150         return ((Char & 0xC0) != 0);
3151 }
3152
3153 /**
3154  * @ingroup StrBuf
3155  * @brief measure the number of glyphs in an UTF8 string...
3156  * @param Buf string to measure
3157  * @returns the number of glyphs in Buf
3158  */
3159 long StrBuf_Utf8StrLen(StrBuf *Buf)
3160 {
3161         int n = 0;
3162         int m = 0;
3163         char *aptr, *eptr;
3164
3165         if ((Buf == NULL) || (Buf->BufUsed == 0))
3166                 return 0;
3167         aptr = Buf->buf;
3168         eptr = Buf->buf + Buf->BufUsed;
3169         while ((aptr < eptr) && (*aptr != '\0')) {
3170                 if (Ctdl_IsUtf8SequenceStart(*aptr)){
3171                         m = Ctdl_GetUtf8SequenceLength(aptr, eptr);
3172                         while ((aptr < eptr) && (*aptr++ != '\0')&& (m-- > 0) );
3173                         n ++;
3174                 }
3175                 else {
3176                         n++;
3177                         aptr++;
3178                 }
3179         }
3180         return n;
3181 }
3182
3183 /**
3184  * @ingroup StrBuf
3185  * @brief cuts a string after maxlen glyphs
3186  * @param Buf string to cut to maxlen glyphs
3187  * @param maxlen how long may the string become?
3188  * @returns current length of the string
3189  */
3190 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen)
3191 {
3192         char *aptr, *eptr;
3193         int n = 0, m = 0;
3194
3195         aptr = Buf->buf;
3196         eptr = Buf->buf + Buf->BufUsed;
3197         while ((aptr < eptr) && (*aptr != '\0')) {
3198                 if (Ctdl_IsUtf8SequenceStart(*aptr)){
3199                         m = Ctdl_GetUtf8SequenceLength(aptr, eptr);
3200                         while ((*aptr++ != '\0') && (m-- > 0));
3201                         n ++;
3202                 }
3203                 else {
3204                         n++;
3205                         aptr++;
3206                 }
3207                 if (n > maxlen) {
3208                         *aptr = '\0';
3209                         Buf->BufUsed = aptr - Buf->buf;
3210                         return Buf->BufUsed;
3211                 }
3212         }
3213         return Buf->BufUsed;
3214
3215 }
3216
3217
3218
3219
3220
3221 /*******************************************************************************
3222  *                               wrapping ZLib                                 *
3223  *******************************************************************************/
3224
3225 #ifdef HAVE_ZLIB
3226 #define DEF_MEM_LEVEL 8 /*< memlevel??? */
3227 #define OS_CODE 0x03    /*< unix */
3228
3229 /**
3230  * @ingroup StrBuf_DeEnCoder
3231  * @brief uses the same calling syntax as compress2(), but it
3232  *   creates a stream compatible with HTTP "Content-encoding: gzip"
3233  * @param dest compressed buffer
3234  * @param destLen length of the compresed data
3235  * @param source source to encode
3236  * @param sourceLen length of source to encode
3237  * @param level compression level
3238  */
3239 int ZEXPORT compress_gzip(Bytef * dest,
3240                           size_t * destLen,
3241                           const Bytef * source,
3242                           uLong sourceLen,
3243                           int level)
3244 {
3245         const int gz_magic[2] = { 0x1f, 0x8b }; /* gzip magic header */
3246
3247         /* write gzip header */
3248         snprintf((char *) dest, *destLen,
3249                  "%c%c%c%c%c%c%c%c%c%c",
3250                  gz_magic[0], gz_magic[1], Z_DEFLATED,
3251                  0 /*flags */ , 0, 0, 0, 0 /*time */ , 0 /* xflags */ ,
3252                  OS_CODE);
3253
3254         /* normal deflate */
3255         z_stream stream;
3256         int err;
3257         stream.next_in = (Bytef *) source;
3258         stream.avail_in = (uInt) sourceLen;
3259         stream.next_out = dest + 10L;   // after header
3260         stream.avail_out = (uInt) * destLen;
3261         if ((uLong) stream.avail_out != *destLen)
3262                 return Z_BUF_ERROR;
3263
3264         stream.zalloc = (alloc_func) 0;
3265         stream.zfree = (free_func) 0;
3266         stream.opaque = (voidpf) 0;
3267
3268         err = deflateInit2(&stream, level, Z_DEFLATED, -MAX_WBITS,
3269                            DEF_MEM_LEVEL, Z_DEFAULT_STRATEGY);
3270         if (err != Z_OK)
3271                 return err;
3272
3273         err = deflate(&stream, Z_FINISH);
3274         if (err != Z_STREAM_END) {
3275                 deflateEnd(&stream);
3276                 return err == Z_OK ? Z_BUF_ERROR : err;
3277         }
3278         *destLen = stream.total_out + 10L;
3279
3280         /* write CRC and Length */
3281         uLong crc = crc32(0L, source, sourceLen);
3282         int n;
3283         for (n = 0; n < 4; ++n, ++*destLen) {
3284                 dest[*destLen] = (int) (crc & 0xff);
3285                 crc >>= 8;
3286         }
3287         uLong len = stream.total_in;
3288         for (n = 0; n < 4; ++n, ++*destLen) {
3289                 dest[*destLen] = (int) (len & 0xff);
3290                 len >>= 8;
3291         }
3292         err = deflateEnd(&stream);
3293         return err;
3294 }
3295 #endif
3296
3297
3298 /**
3299  * @ingroup StrBuf_DeEnCoder
3300  * @brief compress the buffer with gzip
3301  * Attention! If you feed this a Const String, you must maintain the uncompressed buffer yourself!
3302  * @param Buf buffer whose content is to be gzipped
3303  */
3304 int CompressBuffer(StrBuf *Buf)
3305 {
3306 #ifdef HAVE_ZLIB
3307         char *compressed_data = NULL;
3308         size_t compressed_len, bufsize;
3309         int i = 0;
3310
3311         bufsize = compressed_len = Buf->BufUsed +  (Buf->BufUsed / 100) + 100;
3312         compressed_data = malloc(compressed_len);
3313
3314         if (compressed_data == NULL)
3315                 return -1;
3316         /* Flush some space after the used payload so valgrind shuts up... */
3317         while ((i < 10) && (Buf->BufUsed + i < Buf->BufSize))
3318                 Buf->buf[Buf->BufUsed + i++] = '\0';
3319         if (compress_gzip((Bytef *) compressed_data,
3320                           &compressed_len,
3321                           (Bytef *) Buf->buf,
3322                           (uLongf) Buf->BufUsed, Z_BEST_SPEED) == Z_OK) {
3323                 if (!Buf->ConstBuf)
3324                         free(Buf->buf);
3325                 Buf->buf = compressed_data;
3326                 Buf->BufUsed = compressed_len;
3327                 Buf->BufSize = bufsize;
3328                 /* Flush some space after the used payload so valgrind shuts up... */
3329                 i = 0;
3330                 while ((i < 10) && (Buf->BufUsed + i < Buf->BufSize))
3331                         Buf->buf[Buf->BufUsed + i++] = '\0';
3332                 return 1;
3333         } else {
3334                 free(compressed_data);
3335         }
3336 #endif  /* HAVE_ZLIB */
3337         return 0;
3338 }
3339
3340
3341
3342 /*******************************************************************************
3343  *           File I/O; Prefer buffered read since its faster!                  *
3344  *******************************************************************************/
3345
3346 /**
3347  * @ingroup StrBuf_IO
3348  * @brief Read a line from socket
3349  * flushes and closes the FD on error
3350  * @param buf the buffer to get the input to
3351  * @param fd pointer to the filedescriptor to read
3352  * @param append Append to an existing string or replace?
3353  * @param Error strerror() on error
3354  * @returns numbers of chars read
3355  */
3356 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error)
3357 {
3358         int len, rlen, slen;
3359
3360         if (!append)
3361                 FlushStrBuf(buf);
3362
3363         slen = len = buf->BufUsed;
3364         while (1) {
3365                 rlen = read(*fd, &buf->buf[len], 1);
3366                 if (rlen < 1) {
3367                         *Error = strerror(errno);
3368
3369                         close(*fd);
3370                         *fd = -1;
3371
3372                         return -1;
3373                 }
3374                 if (buf->buf[len] == '\n')
3375                         break;
3376                 if (buf->buf[len] != '\r')
3377                         len ++;
3378                 if (len + 2 >= buf->BufSize) {
3379                         buf->BufUsed = len;
3380                         buf->buf[len+1] = '\0';
3381                         IncreaseBuf(buf, 1, -1);
3382                 }
3383         }
3384         buf->BufUsed = len;
3385         buf->buf[len] = '\0';
3386         return len - slen;
3387 }
3388
3389 /**
3390  * @ingroup StrBuf_BufferedIO
3391  * @brief Read a line from socket
3392  * flushes and closes the FD on error
3393  * @param Line the line to read from the fd / I/O Buffer
3394  * @param buf the buffer to get the input to
3395  * @param fd pointer to the filedescriptor to read
3396  * @param timeout number of successless selects until we bail out
3397  * @param selectresolution how long to wait on each select
3398  * @param Error strerror() on error
3399  * @returns numbers of chars read
3400  */
3401 int StrBufTCP_read_buffered_line(StrBuf *Line,
3402                                  StrBuf *buf,
3403                                  int *fd,
3404                                  int timeout,
3405                                  int selectresolution,
3406                                  const char **Error)
3407 {
3408         int len, rlen;
3409         int nSuccessLess = 0;
3410         fd_set rfds;
3411         char *pch = NULL;
3412         int fdflags;
3413         int IsNonBlock;
3414         struct timeval tv;
3415
3416         if (buf->BufUsed > 0) {
3417                 pch = strchr(buf->buf, '\n');
3418                 if (pch != NULL) {
3419                         rlen = 0;
3420                         len = pch - buf->buf;
3421                         if (len > 0 && (*(pch - 1) == '\r') )
3422                                 rlen ++;
3423                         StrBufSub(Line, buf, 0, len - rlen);
3424                         StrBufCutLeft(buf, len + 1);
3425                         return len - rlen;
3426                 }
3427         }
3428
3429         if (buf->BufSize - buf->BufUsed < 10)
3430                 IncreaseBuf(buf, 1, -1);
3431
3432         fdflags = fcntl(*fd, F_GETFL);
3433         IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
3434
3435         while ((nSuccessLess < timeout) && (pch == NULL)) {
3436                 if (IsNonBlock){
3437                         tv.tv_sec = selectresolution;
3438                         tv.tv_usec = 0;
3439
3440                         FD_ZERO(&rfds);
3441                         FD_SET(*fd, &rfds);
3442                         if (select(*fd + 1, NULL, &rfds, NULL, &tv) == -1) {
3443                                 *Error = strerror(errno);
3444                                 close (*fd);
3445                                 *fd = -1;
3446                                 return -1;
3447                         }
3448                 }
3449                 if (IsNonBlock && !  FD_ISSET(*fd, &rfds)) {
3450                         nSuccessLess ++;
3451                         continue;
3452                 }
3453                 rlen = read(*fd,
3454                             &buf->buf[buf->BufUsed],
3455                             buf->BufSize - buf->BufUsed - 1);
3456                 if (rlen < 1) {
3457                         *Error = strerror(errno);
3458                         close(*fd);
3459                         *fd = -1;
3460                         return -1;
3461                 }
3462                 else if (rlen > 0) {
3463                         nSuccessLess = 0;
3464                         buf->BufUsed += rlen;
3465                         buf->buf[buf->BufUsed] = '\0';
3466                         if (buf->BufUsed + 10 > buf->BufSize) {
3467                                 IncreaseBuf(buf, 1, -1);
3468                         }
3469                         pch = strchr(buf->buf, '\n');
3470                         continue;
3471                 }
3472
3473         }
3474         if (pch != NULL) {
3475                 rlen = 0;
3476                 len = pch - buf->buf;
3477                 if (len > 0 && (*(pch - 1) == '\r') )
3478                         rlen ++;
3479                 StrBufSub(Line, buf, 0, len - rlen);
3480                 StrBufCutLeft(buf, len + 1);
3481                 return len - rlen;
3482         }
3483         return -1;
3484
3485 }
3486
3487 static const char *ErrRBLF_PreConditionFailed="StrBufTCP_read_buffered_line_fast: Wrong arguments or invalid Filedescriptor";
3488 static const char *ErrRBLF_SelectFailed="StrBufTCP_read_buffered_line_fast: Select failed without reason";
3489 static const char *ErrRBLF_NotEnoughSentFromServer="StrBufTCP_read_buffered_line_fast: No complete line was sent from peer";
3490 /**
3491  * @ingroup StrBuf_BufferedIO
3492  * @brief Read a line from socket
3493  * flushes and closes the FD on error
3494  * @param Line where to append our Line read from the fd / I/O Buffer;
3495  * @param IOBuf the buffer to get the input to; lifetime pair to FD
3496  * @param Pos pointer to the current read position, should be NULL initialized on opening the FD it belongs to.!
3497  * @param fd pointer to the filedescriptor to read
3498  * @param timeout number of successless selects until we bail out
3499  * @param selectresolution how long to wait on each select
3500  * @param Error strerror() on error
3501  * @returns numbers of chars read or -1 in case of error. "\n" will become 0
3502  */
3503 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
3504                                       StrBuf *IOBuf,
3505                                       const char **Pos,
3506                                       int *fd,
3507                                       int timeout,
3508                                       int selectresolution,
3509                                       const char **Error)
3510 {
3511         const char *pche = NULL;
3512         const char *pos = NULL;
3513         const char *pLF;
3514         int len, rlen, retlen;
3515         int nSuccessLess = 0;
3516         fd_set rfds;
3517         const char *pch = NULL;
3518         int fdflags;
3519         int IsNonBlock;
3520         struct timeval tv;
3521
3522         retlen = 0;
3523         if ((Line == NULL) ||
3524             (Pos == NULL) ||
3525             (IOBuf == NULL) ||
3526             (*fd == -1))
3527         {
3528                 if (Pos != NULL)
3529                         *Pos = NULL;
3530                 *Error = ErrRBLF_PreConditionFailed;
3531                 return -1;
3532         }
3533
3534         pos = *Pos;
3535         if ((IOBuf->BufUsed > 0) &&
3536             (pos != NULL) &&
3537             (pos < IOBuf->buf + IOBuf->BufUsed))
3538         {
3539                 char *pcht;
3540
3541                 pche = IOBuf->buf + IOBuf->BufUsed;
3542                 pch = pos;
3543                 pcht = Line->buf;
3544
3545                 while ((pch < pche) && (*pch != '\n'))
3546                 {
3547                         if (Line->BufUsed + 10 > Line->BufSize)
3548                         {
3549                                 long apos;
3550                                 apos = pcht - Line->buf;
3551                                 *pcht = '\0';
3552                                 IncreaseBuf(Line, 1, -1);
3553                                 pcht = Line->buf + apos;
3554                         }
3555                         *pcht++ = *pch++;
3556                         Line->BufUsed++;
3557                         retlen++;
3558                 }
3559
3560                 len = pch - pos;
3561                 if (len > 0 && (*(pch - 1) == '\r') )
3562                 {
3563                         retlen--;
3564                         len --;
3565                         pcht --;
3566                         Line->BufUsed --;
3567                 }
3568                 *pcht = '\0';
3569
3570                 if ((pch >= pche) || (*pch == '\0'))
3571                 {
3572                         FlushStrBuf(IOBuf);
3573                         *Pos = NULL;
3574                         pch = NULL;
3575                         pos = 0;
3576                 }
3577
3578                 if ((pch != NULL) &&
3579                     (pch <= pche))
3580                 {
3581                         if (pch + 1 >= pche) {
3582                                 *Pos = NULL;
3583                                 FlushStrBuf(IOBuf);
3584                         }
3585                         else
3586                                 *Pos = pch + 1;
3587
3588                         return retlen;
3589                 }
3590                 else
3591                         FlushStrBuf(IOBuf);
3592         }
3593
3594         /* If we come here, Pos is Unset since we read everything into Line, and now go for more. */
3595
3596         if (IOBuf->BufSize - IOBuf->BufUsed < 10)
3597                 IncreaseBuf(IOBuf, 1, -1);
3598
3599         fdflags = fcntl(*fd, F_GETFL);
3600         IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
3601
3602         pLF = NULL;
3603         while ((nSuccessLess < timeout) &&
3604                (pLF == NULL) &&
3605                (*fd != -1)) {
3606                 if (IsNonBlock)
3607                 {
3608                         tv.tv_sec = 1;
3609                         tv.tv_usec = 0;
3610
3611                         FD_ZERO(&rfds);
3612                         FD_SET(*fd, &rfds);
3613                         if (select((*fd) + 1, &rfds, NULL, NULL, &tv) == -1) {
3614                                 *Error = strerror(errno);
3615                                 close (*fd);
3616                                 *fd = -1;
3617                                 if (*Error == NULL)
3618                                         *Error = ErrRBLF_SelectFailed;
3619                                 return -1;
3620                         }
3621                         if (! FD_ISSET(*fd, &rfds) != 0) {
3622                                 nSuccessLess ++;
3623                                 continue;
3624                         }
3625                 }
3626                 rlen = read(*fd,
3627                             &IOBuf->buf[IOBuf->BufUsed],
3628                             IOBuf->BufSize - IOBuf->BufUsed - 1);
3629                 if (rlen < 1) {
3630                         *Error = strerror(errno);
3631                         close(*fd);
3632                         *fd = -1;
3633                         return -1;
3634                 }
3635                 else if (rlen > 0) {
3636                         nSuccessLess = 0;
3637                         pLF = IOBuf->buf + IOBuf->BufUsed;
3638                         IOBuf->BufUsed += rlen;
3639                         IOBuf->buf[IOBuf->BufUsed] = '\0';
3640
3641                         pche = IOBuf->buf + IOBuf->BufUsed;
3642
3643                         while ((pLF < pche) && (*pLF != '\n'))
3644                                 pLF ++;
3645                         if ((pLF >= pche) || (*pLF == '\0'))
3646                                 pLF = NULL;
3647
3648                         if (IOBuf->BufUsed + 10 > IOBuf->BufSize)
3649                         {
3650                                 long apos = 0;
3651
3652                                 if (pLF != NULL) apos = pLF - IOBuf->buf;
3653                                 IncreaseBuf(IOBuf, 1, -1);
3654                                 if (pLF != NULL) pLF = IOBuf->buf + apos;
3655                         }
3656
3657                         continue;
3658                 }
3659         }
3660         *Pos = NULL;
3661         if (pLF != NULL) {
3662                 pos = IOBuf->buf;
3663                 len = pLF - pos;
3664                 if (len > 0 && (*(pLF - 1) == '\r') )
3665                         len --;
3666                 StrBufAppendBufPlain(Line, ChrPtr(IOBuf), len, 0);
3667                 if (pLF + 1 >= IOBuf->buf + IOBuf->BufUsed)
3668                 {
3669                         FlushStrBuf(IOBuf);
3670                 }
3671                 else
3672                         *Pos = pLF + 1;
3673                 return retlen + len;
3674         }
3675         *Error = ErrRBLF_NotEnoughSentFromServer;
3676         return -1;
3677
3678 }
3679
3680 static const char *ErrRBLF_BLOBPreConditionFailed="StrBufReadBLOB: Wrong arguments or invalid Filedescriptor";
3681 /**
3682  * @ingroup StrBuf_IO
3683  * @brief Input binary data from socket
3684  * flushes and closes the FD on error
3685  * @param Buf the buffer to get the input to
3686  * @param fd pointer to the filedescriptor to read
3687  * @param append Append to an existing string or replace?
3688  * @param nBytes the maximal number of bytes to read
3689  * @param Error strerror() on error
3690  * @returns numbers of chars read
3691  */
3692 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error)
3693 {
3694         int fdflags;
3695         int len, rlen, slen;
3696         int nSuccessLess;
3697         int nRead = 0;
3698         char *ptr;
3699         int IsNonBlock;
3700         struct timeval tv;
3701         fd_set rfds;
3702
3703         if ((Buf == NULL) || (*fd == -1))
3704         {
3705                 *Error = ErrRBLF_BLOBPreConditionFailed;
3706                 return -1;
3707         }
3708         if (!append)
3709                 FlushStrBuf(Buf);
3710         if (Buf->BufUsed + nBytes >= Buf->BufSize)
3711                 IncreaseBuf(Buf, 1, Buf->BufUsed + nBytes);
3712
3713         ptr = Buf->buf + Buf->BufUsed;
3714
3715         slen = len = Buf->BufUsed;
3716
3717         fdflags = fcntl(*fd, F_GETFL);
3718         IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
3719         nSuccessLess = 0;
3720         while ((nRead < nBytes) &&
3721                (*fd != -1))
3722         {
3723                 if (IsNonBlock)
3724                 {
3725                         tv.tv_sec = 1;
3726                         tv.tv_usec = 0;
3727
3728                         FD_ZERO(&rfds);
3729                         FD_SET(*fd, &rfds);
3730                         if (select(*fd + 1, &rfds, NULL, NULL, &tv) == -1) {
3731                                 *Error = strerror(errno);
3732                                 close (*fd);
3733                                 *fd = -1;
3734                                 if (*Error == NULL)
3735                                         *Error = ErrRBLF_SelectFailed;
3736                                 return -1;
3737                         }
3738                         if (! FD_ISSET(*fd, &rfds) != 0) {
3739                                 nSuccessLess ++;
3740                                 continue;
3741                         }
3742                 }
3743
3744                 if ((rlen = read(*fd,
3745                                  ptr,
3746                                  nBytes - nRead)) == -1) {
3747                         close(*fd);
3748                         *fd = -1;
3749                         *Error = strerror(errno);
3750                         return rlen;
3751                 }
3752                 nRead += rlen;
3753                 ptr += rlen;
3754                 Buf->BufUsed += rlen;
3755         }
3756         Buf->buf[Buf->BufUsed] = '\0';
3757         return nRead;
3758 }
3759
3760 const char *ErrRBB_BLOBFPreConditionFailed = "StrBufReadBLOBBuffered: to many selects; aborting.";
3761 const char *ErrRBB_too_many_selects        = "StrBufReadBLOBBuffered: to many selects; aborting.";
3762 /**
3763  * @ingroup StrBuf_BufferedIO
3764  * @brief Input binary data from socket
3765  * flushes and closes the FD on error
3766  * @param Blob put binary thing here
3767  * @param IOBuf the buffer to get the input to
3768  * @param Pos offset inside of IOBuf
3769  * @param fd pointer to the filedescriptor to read
3770  * @param append Append to an existing string or replace?
3771  * @param nBytes the maximal number of bytes to read
3772  * @param check whether we should search for '000\n' terminators in case of timeouts
3773  * @param Error strerror() on error
3774  * @returns numbers of chars read
3775  */
3776 int StrBufReadBLOBBuffered(StrBuf *Blob,
3777                            StrBuf *IOBuf,
3778                            const char **Pos,
3779                            int *fd,
3780                            int append,
3781                            long nBytes,
3782                            int check,
3783                            const char **Error)
3784 {
3785         const char *pche;
3786         const char *pos;
3787         int fdflags;
3788         int len = 0;
3789         int rlen, slen;
3790         int nRead = 0;
3791         int nAlreadyRead = 0;
3792         int IsNonBlock;
3793         char *ptr;
3794         fd_set rfds;
3795         const char *pch;
3796         struct timeval tv;
3797         int nSuccessLess = 0;
3798         int MaxTries;
3799
3800         if ((Blob == NULL) || (*fd == -1) || (IOBuf == NULL) || (Pos == NULL))
3801         {
3802                 if (*Pos != NULL)
3803                         *Pos = NULL;
3804                 *Error = ErrRBB_BLOBFPreConditionFailed;
3805                 return -1;
3806         }
3807
3808         if (!append)
3809                 FlushStrBuf(Blob);
3810         if (Blob->BufUsed + nBytes >= Blob->BufSize)
3811                 IncreaseBuf(Blob, append, Blob->BufUsed + nBytes);
3812
3813         pos = *Pos;
3814
3815         if (pos != NULL)
3816                 len = pos - IOBuf->buf;
3817         rlen = IOBuf->BufUsed - len;
3818
3819
3820         if ((IOBuf->BufUsed > 0) &&
3821             (pos != NULL) &&
3822             (pos < IOBuf->buf + IOBuf->BufUsed))
3823         {
3824                 pche = IOBuf->buf + IOBuf->BufUsed;
3825                 pch = pos;
3826
3827                 if (rlen < nBytes) {
3828                         memcpy(Blob->buf + Blob->BufUsed, pos, rlen);
3829                         Blob->BufUsed += rlen;
3830                         Blob->buf[Blob->BufUsed] = '\0';
3831                         nAlreadyRead = nRead = rlen;
3832                         *Pos = NULL;
3833                 }
3834                 if (rlen >= nBytes) {
3835                         memcpy(Blob->buf + Blob->BufUsed, pos, nBytes);
3836                         Blob->BufUsed += nBytes;
3837                         Blob->buf[Blob->BufUsed] = '\0';
3838                         if (rlen == nBytes) {
3839                                 *Pos = NULL;
3840                                 FlushStrBuf(IOBuf);
3841                         }
3842                         else
3843                                 *Pos += nBytes;
3844                         return nBytes;
3845                 }
3846         }
3847
3848         FlushStrBuf(IOBuf);
3849         *Pos = NULL;
3850         if (IOBuf->BufSize < nBytes - nRead)
3851                 IncreaseBuf(IOBuf, 0, nBytes - nRead);
3852         ptr = IOBuf->buf;
3853
3854         slen = len = Blob->BufUsed;
3855
3856         fdflags = fcntl(*fd, F_GETFL);
3857         IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
3858         if (IsNonBlock)
3859                 MaxTries =   1000;
3860         else
3861                 MaxTries = 100000;
3862
3863         nBytes -= nRead;
3864         nRead = 0;
3865         while ((nSuccessLess < MaxTries) &&
3866                (nRead < nBytes) &&
3867                (*fd != -1)) {
3868                 if (IsNonBlock)
3869                 {
3870                         tv.tv_sec = 1;
3871                         tv.tv_usec = 0;
3872
3873                         FD_ZERO(&rfds);
3874                         FD_SET(*fd, &rfds);
3875                         if (select(*fd + 1, &rfds, NULL, NULL, &tv) == -1) {
3876                                 *Error = strerror(errno);
3877                                 close (*fd);
3878                                 *fd = -1;
3879                                 if (*Error == NULL)
3880                                         *Error = ErrRBLF_SelectFailed;
3881                                 return -1;
3882                         }
3883                         if (! FD_ISSET(*fd, &rfds) != 0) {
3884                                 nSuccessLess ++;
3885                                 continue;
3886                         }
3887                 }
3888                 rlen = read(*fd,
3889                             ptr,
3890                             IOBuf->BufSize - (ptr - IOBuf->buf));
3891                 if (rlen == -1) {
3892                         close(*fd);
3893                         *fd = -1;
3894                         *Error = strerror(errno);
3895                         return rlen;
3896                 }
3897                 else if (rlen == 0){
3898                         if ((check == NNN_TERM) &&
3899                             (nRead > 5) &&
3900                             (strncmp(IOBuf->buf + IOBuf->BufUsed - 5, "\n000\n", 5) == 0))
3901                         {
3902                                 StrBufPlain(Blob, HKEY("\n000\n"));
3903                                 StrBufCutRight(Blob, 5);
3904                                 return Blob->BufUsed;
3905                         }
3906                         else if (!IsNonBlock)
3907                                 nSuccessLess ++;
3908                         else if (nSuccessLess > MaxTries) {
3909                                 FlushStrBuf(IOBuf);
3910                                 *Error = ErrRBB_too_many_selects;
3911                                 return -1;
3912                         }
3913                 }
3914                 else if (rlen > 0) {
3915                         nSuccessLess = 0;
3916                         nRead += rlen;
3917                         ptr += rlen;
3918                         IOBuf->BufUsed += rlen;
3919                 }
3920         }
3921         if (nSuccessLess >= MaxTries) {
3922                 FlushStrBuf(IOBuf);
3923                 *Error = ErrRBB_too_many_selects;
3924                 return -1;
3925         }
3926
3927         if (nRead > nBytes) {
3928                 *Pos = IOBuf->buf + nBytes;
3929         }
3930         Blob->buf[Blob->BufUsed] = '\0';
3931         StrBufAppendBufPlain(Blob, IOBuf->buf, nBytes, 0);
3932         if (*Pos == NULL) {
3933                 FlushStrBuf(IOBuf);
3934         }
3935         return nRead + nAlreadyRead;
3936 }
3937
3938 /**
3939  * @ingroup StrBuf_IO
3940  * @brief extract a "next line" from Buf; Ptr to persist across several iterations
3941  * @param LineBuf your line will be copied here.
3942  * @param Buf BLOB with lines of text...
3943  * @param Ptr moved arround to keep the next-line across several iterations
3944  *        has to be &NULL on start; will be &NotNULL on end of buffer
3945  * @returns size of copied buffer
3946  */
3947 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr)
3948 {
3949         const char *aptr, *ptr, *eptr;
3950         char *optr, *xptr;
3951
3952         if ((Buf == NULL) || (*Ptr == StrBufNOTNULL)) {
3953                 *Ptr = StrBufNOTNULL;
3954                 return 0;
3955         }
3956
3957         FlushStrBuf(LineBuf);
3958         if (*Ptr==NULL)
3959                 ptr = aptr = Buf->buf;
3960         else
3961                 ptr = aptr = *Ptr;
3962
3963         optr = LineBuf->buf;
3964         eptr = Buf->buf + Buf->BufUsed;
3965         xptr = LineBuf->buf + LineBuf->BufSize - 1;
3966
3967         while ((ptr <= eptr) &&
3968                (*ptr != '\n') &&
3969                (*ptr != '\r') )
3970         {
3971                 *optr = *ptr;
3972                 optr++; ptr++;
3973                 if (optr == xptr) {
3974                         LineBuf->BufUsed = optr - LineBuf->buf;
3975                         IncreaseBuf(LineBuf,  1, LineBuf->BufUsed + 1);
3976                         optr = LineBuf->buf + LineBuf->BufUsed;
3977                         xptr = LineBuf->buf + LineBuf->BufSize - 1;
3978                 }
3979         }
3980
3981         if ((ptr >= eptr) && (optr > LineBuf->buf))
3982                 optr --;
3983         LineBuf->BufUsed = optr - LineBuf->buf;
3984         *optr = '\0';
3985         if ((ptr <= eptr) && (*ptr == '\r'))
3986                 ptr ++;
3987         if ((ptr <= eptr) && (*ptr == '\n'))
3988                 ptr ++;
3989
3990         if (ptr < eptr) {
3991                 *Ptr = ptr;
3992         }
3993         else {
3994                 *Ptr = StrBufNOTNULL;
3995         }
3996
3997         return Buf->BufUsed - (ptr - Buf->buf);
3998 }
3999
4000
4001 /**
4002  * @ingroup StrBuf_IO
4003  * @brief removes double slashes from pathnames
4004  * @param Dir directory string to filter
4005  * @param RemoveTrailingSlash allows / disallows trailing slashes
4006  */
4007 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash)
4008 {
4009         char *a, *b;
4010
4011         a = b = Dir->buf;
4012
4013         while (!IsEmptyStr(a)) {
4014                 if (*a == '/') {
4015                         while (*a == '/')
4016                                 a++;
4017                         *b = '/';
4018                         b++;
4019                 }
4020                 else {
4021                         *b = *a;
4022                         b++; a++;
4023                 }
4024         }
4025         if ((RemoveTrailingSlash) && (*(b - 1) != '/')){
4026                 *b = '/';
4027                 b++;
4028         }
4029         *b = '\0';
4030         Dir->BufUsed = b - Dir->buf;
4031 }
4032
4033