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