libcitadel/lib/stringbuf.c

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