libcitadel/lib/stringbuf.c

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