libcitadel/lib/stringbuf.c

   1 #include "../sysdep.h"
   2 #include <ctype.h>
   3 #include <errno.h>
   4 #include <string.h>
   5 #include <unistd.h>
   6 #include <string.h>
   7 #include <stdio.h>
   8 #include <sys/select.h>
   9 #include <fcntl.h>
  10 #define SHOW_ME_VAPPEND_PRINTF
  11 #include <stdarg.h>
  12 #include "libcitadel.h"
  13
  14 #ifdef HAVE_ICONV
  15 #include <iconv.h>
  16 #endif
  17
  18 #ifdef HAVE_ZLIB
  19 #include <zlib.h>
  20 #endif
  21
  22
  23 #ifdef HAVE_ZLIB
  24 #include <zlib.h>
  25 int ZEXPORT compress_gzip(Bytef * dest, size_t * destLen,
  26                           const Bytef * source, uLong sourceLen, int level);
  27 #endif
  28
  29 /**
  30  * Private Structure for the Stringbuffer
  31  */
  32 struct StrBuf {
  33         char *buf;         /**< the pointer to the dynamic buffer */
  34         long BufSize;      /**< how many spcae do we optain */
  35         long BufUsed;      /**< StNumber of Chars used excluding the trailing \0 */
  36         int ConstBuf;      /**< are we just a wrapper arround a static buffer and musn't we be changed? */
  37 };
  38
  39
  40 /**
  41  * \Brief Cast operator to Plain String
  42  * Note: if the buffer is altered by StrBuf operations, this pointer may become
  43  *  invalid. So don't lean on it after altering the buffer!
  44  *  Since this operation is considered cheap, rather call it often than risking
  45  *  your pointer to become invalid!
  46  * \param Str the string we want to get the c-string representation for
  47  * \returns the Pointer to the Content. Don't mess with it!
  48  */
  49 inline const char *ChrPtr(const StrBuf *Str)
  50 {
  51         if (Str == NULL)
  52                 return "";
  53         return Str->buf;
  54 }
  55
  56 /**
  57  * \brief since we know strlen()'s result, provide it here.
  58  * \param Str the string to return the length to
  59  * \returns contentlength of the buffer
  60  */
  61 inline int StrLength(const StrBuf *Str)
  62 {
  63         return (Str != NULL) ? Str->BufUsed : 0;
  64 }
  65
  66 /**
  67  * \brief local utility function to resize the buffer
  68  * \param Buf the buffer whichs storage we should increase
  69  * \param KeepOriginal should we copy the original buffer or just start over with a new one
  70  * \param DestSize what should fit in after?
  71  */
  72 static int IncreaseBuf(StrBuf *Buf, int KeepOriginal, int DestSize)
  73 {
  74         char *NewBuf;
  75         size_t NewSize = Buf->BufSize * 2;
  76
  77         if (Buf->ConstBuf)
  78                 return -1;
  79
  80         if (DestSize > 0)
  81                 while (NewSize <= DestSize)
  82                         NewSize *= 2;
  83
  84         NewBuf= (char*) malloc(NewSize);
  85         if (KeepOriginal && (Buf->BufUsed > 0))
  86         {
  87                 memcpy(NewBuf, Buf->buf, Buf->BufUsed);
  88         }
  89         else
  90         {
  91                 NewBuf[0] = '\0';
  92                 Buf->BufUsed = 0;
  93         }
  94         free (Buf->buf);
  95         Buf->buf = NewBuf;
  96         Buf->BufSize *= 2;
  97         return Buf->BufSize;
  98 }
  99
 100 /**
 101  * Allocate a new buffer with default buffer size
 102  * \returns the new stringbuffer
 103  */
 104 StrBuf* NewStrBuf(void)
 105 {
 106         StrBuf *NewBuf;
 107
 108         NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
 109         NewBuf->buf = (char*) malloc(SIZ);
 110         NewBuf->buf[0] = '\0';
 111         NewBuf->BufSize = SIZ;
 112         NewBuf->BufUsed = 0;
 113         NewBuf->ConstBuf = 0;
 114         return NewBuf;
 115 }
 116
 117 /**
 118  * \brief Copy Constructor; returns a duplicate of CopyMe
 119  * \params CopyMe Buffer to faxmilate
 120  * \returns the new stringbuffer
 121  */
 122 StrBuf* NewStrBufDup(const StrBuf *CopyMe)
 123 {
 124         StrBuf *NewBuf;
 125
 126         if (CopyMe == NULL)
 127                 return NewStrBuf();
 128
 129         NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
 130         NewBuf->buf = (char*) malloc(CopyMe->BufSize);
 131         memcpy(NewBuf->buf, CopyMe->buf, CopyMe->BufUsed + 1);
 132         NewBuf->BufUsed = CopyMe->BufUsed;
 133         NewBuf->BufSize = CopyMe->BufSize;
 134         NewBuf->ConstBuf = 0;
 135         return NewBuf;
 136 }
 137
 138 /**
 139  * \brief create a new Buffer using an existing c-string
 140  * this function should also be used if you want to pre-suggest
 141  * the buffer size to allocate in conjunction with ptr == NULL
 142  * \param ptr the c-string to copy; may be NULL to create a blank instance
 143  * \param nChars How many chars should we copy; -1 if we should measure the length ourselves
 144  * \returns the new stringbuffer
 145  */
 146 StrBuf* NewStrBufPlain(const char* ptr, int nChars)
 147 {
 148         StrBuf *NewBuf;
 149         size_t Siz = SIZ;
 150         size_t CopySize;
 151
 152         NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
 153         if (nChars < 0)
 154                 CopySize = strlen((ptr != NULL)?ptr:"");
 155         else
 156                 CopySize = nChars;
 157
 158         while (Siz <= CopySize)
 159                 Siz *= 2;
 160
 161         NewBuf->buf = (char*) malloc(Siz);
 162         NewBuf->BufSize = Siz;
 163         if (ptr != NULL) {
 164                 memcpy(NewBuf->buf, ptr, CopySize);
 165                 NewBuf->buf[CopySize] = '\0';
 166                 NewBuf->BufUsed = CopySize;
 167         }
 168         else {
 169                 NewBuf->buf[0] = '\0';
 170                 NewBuf->BufUsed = 0;
 171         }
 172         NewBuf->ConstBuf = 0;
 173         return NewBuf;
 174 }
 175
 176 /**
 177  * \brief Set an existing buffer from a c-string
 178  * \param ptr c-string to put into
 179  * \param nChars set to -1 if we should work 0-terminated
 180  * \returns the new length of the string
 181  */
 182 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars)
 183 {
 184         size_t Siz = Buf->BufSize;
 185         size_t CopySize;
 186
 187         if (nChars < 0)
 188                 CopySize = strlen(ptr);
 189         else
 190                 CopySize = nChars;
 191
 192         while (Siz <= CopySize)
 193                 Siz *= 2;
 194
 195         if (Siz != Buf->BufSize)
 196                 IncreaseBuf(Buf, 0, Siz);
 197         memcpy(Buf->buf, ptr, CopySize);
 198         Buf->buf[CopySize] = '\0';
 199         Buf->BufUsed = CopySize;
 200         Buf->ConstBuf = 0;
 201         return CopySize;
 202 }
 203
 204
 205 /**
 206  * \brief use strbuf as wrapper for a string constant for easy handling
 207  * \param StringConstant a string to wrap
 208  * \param SizeOfConstant should be sizeof(StringConstant)-1
 209  */
 210 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant)
 211 {
 212         StrBuf *NewBuf;
 213
 214         NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
 215         NewBuf->buf = (char*) StringConstant;
 216         NewBuf->BufSize = SizeOfStrConstant;
 217         NewBuf->BufUsed = SizeOfStrConstant;
 218         NewBuf->ConstBuf = 1;
 219         return NewBuf;
 220 }
 221
 222
 223 /**
 224  * \brief flush the content of a Buf; keep its struct
 225  * \param buf Buffer to flush
 226  */
 227 int FlushStrBuf(StrBuf *buf)
 228 {
 229         if (buf == NULL)
 230                 return -1;
 231         if (buf->ConstBuf)
 232                 return -1;
 233         buf->buf[0] ='\0';
 234         buf->BufUsed = 0;
 235         return 0;
 236 }
 237
 238 /**
 239  * \brief Release a Buffer
 240  * Its a double pointer, so it can NULL your pointer
 241  * so fancy SIG11 appear instead of random results
 242  * \param FreeMe Pointer Pointer to the buffer to free
 243  */
 244 void FreeStrBuf (StrBuf **FreeMe)
 245 {
 246         if (*FreeMe == NULL)
 247                 return;
 248         if (!(*FreeMe)->ConstBuf)
 249                 free((*FreeMe)->buf);
 250         free(*FreeMe);
 251         *FreeMe = NULL;
 252 }
 253
 254 /**
 255  * \brief Release the buffer
 256  * If you want put your StrBuf into a Hash, use this as Destructor.
 257  * \param VFreeMe untyped pointer to a StrBuf. be shure to do the right thing [TM]
 258  */
 259 void HFreeStrBuf (void *VFreeMe)
 260 {
 261         StrBuf *FreeMe = (StrBuf*)VFreeMe;
 262         if (FreeMe == NULL)
 263                 return;
 264         if (!FreeMe->ConstBuf)
 265                 free(FreeMe->buf);
 266         free(FreeMe);
 267 }
 268
 269 /**
 270  * \brief Wrapper around atol
 271  */
 272 long StrTol(const StrBuf *Buf)
 273 {
 274         if (Buf == NULL)
 275                 return 0;
 276         if(Buf->BufUsed > 0)
 277                 return atol(Buf->buf);
 278         else
 279                 return 0;
 280 }
 281
 282 /**
 283  * \brief Wrapper around atoi
 284  */
 285 int StrToi(const StrBuf *Buf)
 286 {
 287         if (Buf == NULL)
 288                 return 0;
 289         if (Buf->BufUsed > 0)
 290                 return atoi(Buf->buf);
 291         else
 292                 return 0;
 293 }
 294 /**
 295  * \brief Checks to see if the string is a pure number
 296  */
 297 int StrBufIsNumber(const StrBuf *Buf) {
 298   if (Buf == NULL) {
 299         return 0;
 300   }
 301   char * pEnd;
 302   strtoll(Buf->buf, &pEnd, 10);
 303   if (pEnd == NULL && ((Buf->buf)-pEnd) != 0) {
 304     return 1;
 305   }
 306   return 0;
 307 }
 308 /**
 309  * \brief modifies a Single char of the Buf
 310  * You can point to it via char* or a zero-based integer
 311  * \param ptr char* to zero; use NULL if unused
 312  * \param nThChar zero based pointer into the string; use -1 if unused
 313  * \param PeekValue The Character to place into the position
 314  */
 315 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue)
 316 {
 317         if (Buf == NULL)
 318                 return -1;
 319         if (ptr != NULL)
 320                 nThChar = ptr - Buf->buf;
 321         if ((nThChar < 0) || (nThChar > Buf->BufUsed))
 322                 return -1;
 323         Buf->buf[nThChar] = PeekValue;
 324         return nThChar;
 325 }
 326
 327 /**
 328  * \brief Append a StringBuffer to the buffer
 329  * \param Buf Buffer to modify
 330  * \param AppendBuf Buffer to copy at the end of our buffer
 331  * \param Offset Should we start copying from an offset?
 332  */
 333 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset)
 334 {
 335   if ((AppendBuf == NULL) || (Buf == NULL) || (AppendBuf->buf == NULL))
 336                 return;
 337
 338         if (Buf->BufSize - Offset < AppendBuf->BufUsed + Buf->BufUsed)
 339                 IncreaseBuf(Buf,
 340                             (Buf->BufUsed > 0),
 341                             AppendBuf->BufUsed + Buf->BufUsed);
 342
 343         memcpy(Buf->buf + Buf->BufUsed,
 344                AppendBuf->buf + Offset,
 345                AppendBuf->BufUsed - Offset);
 346         Buf->BufUsed += AppendBuf->BufUsed - Offset;
 347         Buf->buf[Buf->BufUsed] = '\0';
 348 }
 349
 350
 351 /**
 352  * \brief Append a C-String to the buffer
 353  * \param Buf Buffer to modify
 354  * \param AppendBuf Buffer to copy at the end of our buffer
 355  * \param AppendSize number of bytes to copy; set to -1 if we should count it in advance
 356  * \param Offset Should we start copying from an offset?
 357  */
 358 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset)
 359 {
 360         long aps;
 361         long BufSizeRequired;
 362
 363         if ((AppendBuf == NULL) || (Buf == NULL))
 364                 return;
 365
 366         if (AppendSize < 0 )
 367                 aps = strlen(AppendBuf + Offset);
 368         else
 369                 aps = AppendSize - Offset;
 370
 371         BufSizeRequired = Buf->BufUsed + aps + 1;
 372         if (Buf->BufSize <= BufSizeRequired)
 373                 IncreaseBuf(Buf, (Buf->BufUsed > 0), BufSizeRequired);
 374
 375         memcpy(Buf->buf + Buf->BufUsed,
 376                AppendBuf + Offset,
 377                aps);
 378         Buf->BufUsed += aps;
 379         Buf->buf[Buf->BufUsed] = '\0';
 380 }
 381
 382
 383 /**
 384  * \brief Escape a string for feeding out as a URL while appending it to a Buffer
 385  * \param outbuf the output buffer
 386  * \param oblen the size of outbuf to sanitize
 387  * \param strbuf the input buffer
 388  */
 389 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn)
 390 {
 391         const char *pch, *pche;
 392         char *pt, *pte;
 393         int b, c, len;
 394         const char ec[] = " +#&;`'|*?-~<>^()[]{}/$\"\\";
 395         int eclen = sizeof(ec) -1;
 396
 397         if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
 398                 return;
 399         if (PlainIn != NULL) {
 400                 len = strlen(PlainIn);
 401                 pch = PlainIn;
 402                 pche = pch + len;
 403         }
 404         else {
 405                 pch = In->buf;
 406                 pche = pch + In->BufUsed;
 407                 len = In->BufUsed;
 408         }
 409
 410         if (len == 0)
 411                 return;
 412
 413         pt = OutBuf->buf + OutBuf->BufUsed;
 414         pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
 415
 416         while (pch < pche) {
 417                 if (pt >= pte) {
 418                         IncreaseBuf(OutBuf, 1, -1);
 419                         pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
 420                         pt = OutBuf->buf + OutBuf->BufUsed;
 421                 }
 422
 423                 c = 0;
 424                 for (b = 0; b < eclen; ++b) {
 425                         if (*pch == ec[b]) {
 426                                 c = 1;
 427                                 b += eclen;
 428                         }
 429                 }
 430                 if (c == 1) {
 431                         sprintf(pt,"%%%02X", *pch);
 432                         pt += 3;
 433                         OutBuf->BufUsed += 3;
 434                         pch ++;
 435                 }
 436                 else {
 437                         *(pt++) = *(pch++);
 438                         OutBuf->BufUsed++;
 439                 }
 440         }
 441         *pt = '\0';
 442 }
 443
 444 /*
 445  * \brief Append a string, escaping characters which have meaning in HTML.
 446  *
 447  * \param Target        target buffer
 448  * \param Source        source buffer; set to NULL if you just have a C-String
 449  * \param PlainIn       Plain-C string to append; set to NULL if unused
 450  * \param nbsp          If nonzero, spaces are converted to non-breaking spaces.
 451  * \param nolinebreaks  if set to 1, linebreaks are removed from the string.
 452  *                      if set to 2, linebreaks are replaced by &ltbr/&gt
 453  */
 454 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks)
 455 {
 456         const char *aptr, *eiptr;
 457         char *bptr, *eptr;
 458         long len;
 459
 460         if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
 461                 return -1;
 462
 463         if (PlainIn != NULL) {
 464                 aptr = PlainIn;
 465                 len = strlen(PlainIn);
 466                 eiptr = aptr + len;
 467         }
 468         else {
 469                 aptr = Source->buf;
 470                 eiptr = aptr + Source->BufUsed;
 471                 len = Source->BufUsed;
 472         }
 473
 474         if (len == 0)
 475                 return -1;
 476
 477         bptr = Target->buf + Target->BufUsed;
 478         eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in...  */
 479
 480         while (aptr < eiptr){
 481                 if(bptr >= eptr) {
 482                         IncreaseBuf(Target, 1, -1);
 483                         eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in...  */
 484                         bptr = Target->buf + Target->BufUsed;
 485                 }
 486                 if (*aptr == '<') {
 487                         memcpy(bptr, "&lt;", 4);
 488                         bptr += 4;
 489                         Target->BufUsed += 4;
 490                 }
 491                 else if (*aptr == '>') {
 492                         memcpy(bptr, "&gt;", 4);
 493                         bptr += 4;
 494                         Target->BufUsed += 4;
 495                 }
 496                 else if (*aptr == '&') {
 497                         memcpy(bptr, "&amp;", 5);
 498                         bptr += 5;
 499                         Target->BufUsed += 5;
 500                 }
 501                 else if (*aptr == '"') {
 502                         memcpy(bptr, "&quot;", 6);
 503                         bptr += 6;
 504                         Target->BufUsed += 6;
 505                 }
 506                 else if (*aptr == '\'') {
 507                         memcpy(bptr, "&#39;", 5);
 508                         bptr += 5;
 509                         Target->BufUsed += 5;
 510                 }
 511                 else if (*aptr == LB) {
 512                         *bptr = '<';
 513                         bptr ++;
 514                         Target->BufUsed ++;
 515                 }
 516                 else if (*aptr == RB) {
 517                         *bptr = '>';
 518                         bptr ++;
 519                         Target->BufUsed ++;
 520                 }
 521                 else if (*aptr == QU) {
 522                         *bptr ='"';
 523                         bptr ++;
 524                         Target->BufUsed ++;
 525                 }
 526                 else if ((*aptr == 32) && (nbsp == 1)) {
 527                         memcpy(bptr, "&nbsp;", 6);
 528                         bptr += 6;
 529                         Target->BufUsed += 6;
 530                 }
 531                 else if ((*aptr == '\n') && (nolinebreaks == 1)) {
 532                         *bptr='\0';     /* nothing */
 533                 }
 534                 else if ((*aptr == '\n') && (nolinebreaks == 2)) {
 535                         memcpy(bptr, "&lt;br/&gt;", 11);
 536                         bptr += 11;
 537                         Target->BufUsed += 11;
 538                 }
 539
 540
 541                 else if ((*aptr == '\r') && (nolinebreaks != 0)) {
 542                         *bptr='\0';     /* nothing */
 543                 }
 544                 else{
 545                         *bptr = *aptr;
 546                         bptr++;
 547                         Target->BufUsed ++;
 548                 }
 549                 aptr ++;
 550         }
 551         *bptr = '\0';
 552         if ((bptr = eptr - 1 ) && !IsEmptyStr(aptr) )
 553                 return -1;
 554         return Target->BufUsed;
 555 }
 556
 557 /*
 558  * \brief Append a string, escaping characters which have meaning in HTML.
 559  * Converts linebreaks into blanks; escapes single quotes
 560  * \param Target        target buffer
 561  * \param Source        source buffer; set to NULL if you just have a C-String
 562  * \param PlainIn       Plain-C string to append; set to NULL if unused
 563  */
 564 void StrMsgEscAppend(StrBuf *Target, StrBuf *Source, const char *PlainIn)
 565 {
 566         const char *aptr, *eiptr;
 567         char *tptr, *eptr;
 568         long len;
 569
 570         if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
 571                 return ;
 572
 573         if (PlainIn != NULL) {
 574                 aptr = PlainIn;
 575                 len = strlen(PlainIn);
 576                 eiptr = aptr + len;
 577         }
 578         else {
 579                 aptr = Source->buf;
 580                 eiptr = aptr + Source->BufUsed;
 581                 len = Source->BufUsed;
 582         }
 583
 584         if (len == 0)
 585                 return;
 586
 587         eptr = Target->buf + Target->BufSize - 6;
 588         tptr = Target->buf + Target->BufUsed;
 589
 590         while (aptr < eiptr){
 591                 if(tptr >= eptr) {
 592                         IncreaseBuf(Target, 1, -1);
 593                         eptr = Target->buf + Target->BufSize - 6;
 594                         tptr = Target->buf + Target->BufUsed;
 595                 }
 596
 597                 if (*aptr == '\n') {
 598                         *tptr = ' ';
 599                         Target->BufUsed++;
 600                 }
 601                 else if (*aptr == '\r') {
 602                         *tptr = ' ';
 603                         Target->BufUsed++;
 604                 }
 605                 else if (*aptr == '\'') {
 606                         *(tptr++) = '&';
 607                         *(tptr++) = '#';
 608                         *(tptr++) = '3';
 609                         *(tptr++) = '9';
 610                         *tptr = ';';
 611                         Target->BufUsed += 5;
 612                 } else {
 613                         *tptr = *aptr;
 614                         Target->BufUsed++;
 615                 }
 616                 tptr++; aptr++;
 617         }
 618         *tptr = '\0';
 619 }
 620
 621 /*
 622  * \brief Append a string, escaping characters which have meaning in JavaScript strings .
 623  *
 624  * \param Target        target buffer
 625  * \param Source        source buffer; set to NULL if you just have a C-String
 626  * \param PlainIn       Plain-C string to append; set to NULL if unused
 627  */
 628 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn)
 629 {
 630         const char *aptr, *eiptr;
 631         char *bptr, *eptr;
 632         long len;
 633
 634         if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
 635                 return -1;
 636
 637         if (PlainIn != NULL) {
 638                 aptr = PlainIn;
 639                 len = strlen(PlainIn);
 640                 eiptr = aptr + len;
 641         }
 642         else {
 643                 aptr = Source->buf;
 644                 eiptr = aptr + Source->BufUsed;
 645                 len = Source->BufUsed;
 646         }
 647
 648         if (len == 0)
 649                 return -1;
 650
 651         bptr = Target->buf + Target->BufUsed;
 652         eptr = Target->buf + Target->BufSize - 2; /* our biggest unit to put in...  */
 653
 654         while (aptr < eiptr){
 655                 if(bptr >= eptr) {
 656                         IncreaseBuf(Target, 1, -1);
 657                         eptr = Target->buf + Target->BufSize - 2;
 658                         bptr = Target->buf + Target->BufUsed;
 659                 }
 660                 else if (*aptr == '"') {
 661                         memcpy(bptr, "\\\"", 2);
 662                         bptr += 2;
 663                         Target->BufUsed += 2;
 664                 } else if (*aptr == '\\') {
 665                   memcpy(bptr, "\\\\", 2);
 666                   bptr += 2;
 667                   Target->BufUsed += 2;
 668                 }
 669                 else{
 670                         *bptr = *aptr;
 671                         bptr++;
 672                         Target->BufUsed ++;
 673                 }
 674                 aptr ++;
 675         }
 676         *bptr = '\0';
 677         if ((bptr = eptr - 1 ) && !IsEmptyStr(aptr) )
 678                 return -1;
 679         return Target->BufUsed;
 680 }
 681
 682 /**
 683  * \brief extracts a substring from Source into dest
 684  * \param dest buffer to place substring into
 685  * \param Source string to copy substring from
 686  * \param Offset chars to skip from start
 687  * \param nChars number of chars to copy
 688  * \returns the number of chars copied; may be different from nChars due to the size of Source
 689  */
 690 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars)
 691 {
 692         size_t NCharsRemain;
 693         if (Offset > Source->BufUsed)
 694         {
 695                 FlushStrBuf(dest);
 696                 return 0;
 697         }
 698         if (Offset + nChars < Source->BufUsed)
 699         {
 700                 if (nChars > dest->BufSize)
 701                         IncreaseBuf(dest, 0, nChars + 1);
 702                 memcpy(dest->buf, Source->buf + Offset, nChars);
 703                 dest->BufUsed = nChars;
 704                 dest->buf[dest->BufUsed] = '\0';
 705                 return nChars;
 706         }
 707         NCharsRemain = Source->BufUsed - Offset;
 708         if (NCharsRemain > dest->BufSize)
 709                 IncreaseBuf(dest, 0, NCharsRemain + 1);
 710         memcpy(dest->buf, Source->buf + Offset, NCharsRemain);
 711         dest->BufUsed = NCharsRemain;
 712         dest->buf[dest->BufUsed] = '\0';
 713         return NCharsRemain;
 714 }
 715
 716 /**
 717  * \brief sprintf like function appending the formated string to the buffer
 718  * vsnprintf version to wrap into own calls
 719  * \param Buf Buffer to extend by format and params
 720  * \param format printf alike format to add
 721  * \param ap va_list containing the items for format
 722  */
 723 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap)
 724 {
 725         va_list apl;
 726         size_t BufSize = Buf->BufSize;
 727         size_t nWritten = Buf->BufSize + 1;
 728         size_t Offset = Buf->BufUsed;
 729         size_t newused = Offset + nWritten;
 730
 731         while (newused >= BufSize) {
 732                 va_copy(apl, ap);
 733                 nWritten = vsnprintf(Buf->buf + Offset,
 734                                      Buf->BufSize - Offset,
 735                                      format, apl);
 736                 va_end(apl);
 737                 newused = Offset + nWritten;
 738                 if (newused >= Buf->BufSize) {
 739                         IncreaseBuf(Buf, 1, newused);
 740                 }
 741                 else {
 742                         Buf->BufUsed = Offset + nWritten;
 743                         BufSize = Buf->BufSize;
 744                 }
 745
 746         }
 747 }
 748
 749 /**
 750  * \brief sprintf like function appending the formated string to the buffer
 751  * \param Buf Buffer to extend by format and params
 752  * \param format printf alike format to add
 753  * \param ap va_list containing the items for format
 754  */
 755 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...)
 756 {
 757         size_t BufSize = Buf->BufSize;
 758         size_t nWritten = Buf->BufSize + 1;
 759         size_t Offset = Buf->BufUsed;
 760         size_t newused = Offset + nWritten;
 761         va_list arg_ptr;
 762
 763         while (newused >= BufSize) {
 764                 va_start(arg_ptr, format);
 765                 nWritten = vsnprintf(Buf->buf + Buf->BufUsed,
 766                                      Buf->BufSize - Buf->BufUsed,
 767                                      format, arg_ptr);
 768                 va_end(arg_ptr);
 769                 newused = Buf->BufUsed + nWritten;
 770                 if (newused >= Buf->BufSize) {
 771                         IncreaseBuf(Buf, 1, newused);
 772                 }
 773                 else {
 774                         Buf->BufUsed += nWritten;
 775                         BufSize = Buf->BufSize;
 776                 }
 777
 778         }
 779 }
 780
 781 /**
 782  * \brief sprintf like function putting the formated string into the buffer
 783  * \param Buf Buffer to extend by format and params
 784  * \param format printf alike format to add
 785  * \param ap va_list containing the items for format
 786  */
 787 void StrBufPrintf(StrBuf *Buf, const char *format, ...)
 788 {
 789         size_t nWritten = Buf->BufSize + 1;
 790         va_list arg_ptr;
 791
 792         while (nWritten >= Buf->BufSize) {
 793                 va_start(arg_ptr, format);
 794                 nWritten = vsnprintf(Buf->buf, Buf->BufSize, format, arg_ptr);
 795                 va_end(arg_ptr);
 796                 Buf->BufUsed = nWritten ;
 797                 if (nWritten >= Buf->BufSize)
 798                         IncreaseBuf(Buf, 0, 0);
 799         }
 800 }
 801
 802
 803 /**
 804  * \brief Counts the numbmer of tokens in a buffer
 805  * \param Source String to count tokens in
 806  * \param tok    Tokenizer char to count
 807  * \returns numbers of tokenizer chars found
 808  */
 809 inline int StrBufNum_tokens(const StrBuf *source, char tok)
 810 {
 811         if (source == NULL)
 812                 return 0;
 813         return num_tokens(source->buf, tok);
 814 }
 815
 816 /*
 817  * remove_token() - a tokenizer that kills, maims, and destroys
 818  */
 819 /**
 820  * \brief a string tokenizer
 821  * \param Source StringBuffer to read into
 822  * \param parmnum n'th parameter to remove
 823  * \param separator tokenizer param
 824  * \returns -1 if not found, else length of token.
 825  */
 826 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator)
 827 {
 828         int ReducedBy;
 829         char *d, *s;            /* dest, source */
 830         int count = 0;
 831
 832         /* Find desired parameter */
 833         d = Source->buf;
 834         while (count < parmnum) {
 835                 /* End of string, bail! */
 836                 if (!*d) {
 837                         d = NULL;
 838                         break;
 839                 }
 840                 if (*d == separator) {
 841                         count++;
 842                 }
 843                 d++;
 844         }
 845         if (!d) return 0;               /* Parameter not found */
 846
 847         /* Find next parameter */
 848         s = d;
 849         while (*s && *s != separator) {
 850                 s++;
 851         }
 852         if (*s == separator)
 853                 s++;
 854         ReducedBy = d - s;
 855
 856         /* Hack and slash */
 857         if (*s) {
 858                 memmove(d, s, Source->BufUsed - (s - Source->buf) + 1);
 859                 Source->BufUsed -= (ReducedBy + 1);
 860         }
 861         else if (d == Source->buf) {
 862                 *d = 0;
 863                 Source->BufUsed = 0;
 864         }
 865         else {
 866                 *--d = 0;
 867                 Source->BufUsed -= (ReducedBy + 1);
 868         }
 869         /*
 870         while (*s) {
 871                 *d++ = *s++;
 872         }
 873         *d = 0;
 874         */
 875         return ReducedBy;
 876 }
 877
 878
 879 /**
 880  * \brief a string tokenizer
 881  * \param dest Destination StringBuffer
 882  * \param Source StringBuffer to read into
 883  * \param parmnum n'th parameter to extract
 884  * \param separator tokenizer param
 885  * \returns -1 if not found, else length of token.
 886  */
 887 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator)
 888 {
 889         const char *s, *e;              //* source * /
 890         int len = 0;                    //* running total length of extracted string * /
 891         int current_token = 0;          //* token currently being processed * /
 892
 893         if (dest != NULL) {
 894                 dest->buf[0] = '\0';
 895                 dest->BufUsed = 0;
 896         }
 897         else
 898                 return(-1);
 899
 900         if ((Source == NULL) || (Source->BufUsed ==0)) {
 901                 return(-1);
 902         }
 903         s = Source->buf;
 904         e = s + Source->BufUsed;
 905
 906         //cit_backtrace();
 907         //lprintf (CTDL_DEBUG, "test >: n: %d sep: %c source: %s \n willi \n", parmnum, separator, source);
 908
 909         while ((s<e) && !IsEmptyStr(s)) {
 910                 if (*s == separator) {
 911                         ++current_token;
 912                 }
 913                 if (len >= dest->BufSize)
 914                         if (!IncreaseBuf(dest, 1, -1))
 915                                 break;
 916                 if ( (current_token == parmnum) &&
 917                      (*s != separator)) {
 918                         dest->buf[len] = *s;
 919                         ++len;
 920                 }
 921                 else if (current_token > parmnum) {
 922                         break;
 923                 }
 924                 ++s;
 925         }
 926
 927         dest->buf[len] = '\0';
 928         dest->BufUsed = len;
 929
 930         if (current_token < parmnum) {
 931                 //lprintf (CTDL_DEBUG,"test <!: %s\n", dest);
 932                 return(-1);
 933         }
 934         //lprintf (CTDL_DEBUG,"test <: %d; %s\n", len, dest);
 935         return(len);
 936 }
 937
 938
 939 /**
 940  * \brief a string tokenizer to fetch an integer
 941  * \param dest Destination StringBuffer
 942  * \param parmnum n'th parameter to extract
 943  * \param separator tokenizer param
 944  * \returns 0 if not found, else integer representation of the token
 945  */
 946 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator)
 947 {
 948         StrBuf tmp;
 949         char buf[64];
 950
 951         tmp.buf = buf;
 952         buf[0] = '\0';
 953         tmp.BufSize = 64;
 954         tmp.BufUsed = 0;
 955         tmp.ConstBuf = 1;
 956         if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0)
 957                 return(atoi(buf));
 958         else
 959                 return 0;
 960 }
 961
 962 /**
 963  * \brief a string tokenizer to fetch a long integer
 964  * \param dest Destination StringBuffer
 965  * \param parmnum n'th parameter to extract
 966  * \param separator tokenizer param
 967  * \returns 0 if not found, else long integer representation of the token
 968  */
 969 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator)
 970 {
 971         StrBuf tmp;
 972         char buf[64];
 973
 974         tmp.buf = buf;
 975         buf[0] = '\0';
 976         tmp.BufSize = 64;
 977         tmp.BufUsed = 0;
 978         tmp.ConstBuf = 1;
 979         if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0)
 980                 return(atoi(buf));
 981         else
 982                 return 0;
 983 }
 984
 985
 986 /**
 987  * \brief a string tokenizer to fetch an unsigned long
 988  * \param dest Destination StringBuffer
 989  * \param parmnum n'th parameter to extract
 990  * \param separator tokenizer param
 991  * \returns 0 if not found, else unsigned long representation of the token
 992  */
 993 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator)
 994 {
 995         StrBuf tmp;
 996         char buf[64];
 997         char *pnum;
 998
 999         tmp.buf = buf;
1000         buf[0] = '\0';
1001         tmp.BufSize = 64;
1002         tmp.BufUsed = 0;
1003         tmp.ConstBuf = 1;
1004         if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0) {
1005                 pnum = &buf[0];
1006                 if (*pnum == '-')
1007                         pnum ++;
1008                 return (unsigned long) atol(pnum);
1009         }
1010         else
1011                 return 0;
1012 }
1013
1014
1015
1016 /**
1017  * \brief Read a line from socket
1018  * flushes and closes the FD on error
1019  * \param buf the buffer to get the input to
1020  * \param fd pointer to the filedescriptor to read
1021  * \param append Append to an existing string or replace?
1022  * \param Error strerror() on error
1023  * \returns numbers of chars read
1024  */
1025 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error)
1026 {
1027         int len, rlen, slen;
1028
1029         if (!append)
1030                 FlushStrBuf(buf);
1031
1032         slen = len = buf->BufUsed;
1033         while (1) {
1034                 rlen = read(*fd, &buf->buf[len], 1);
1035                 if (rlen < 1) {
1036                         *Error = strerror(errno);
1037
1038                         close(*fd);
1039                         *fd = -1;
1040
1041                         return -1;
1042                 }
1043                 if (buf->buf[len] == '\n')
1044                         break;
1045                 if (buf->buf[len] != '\r')
1046                         len ++;
1047                 if (!(len < buf->BufSize)) {
1048                         buf->BufUsed = len;
1049                         buf->buf[len+1] = '\0';
1050                         IncreaseBuf(buf, 1, -1);
1051                 }
1052         }
1053         buf->BufUsed = len;
1054         buf->buf[len] = '\0';
1055         return len - slen;
1056 }
1057
1058 /**
1059  * \brief Read a line from socket
1060  * flushes and closes the FD on error
1061  * \param buf the buffer to get the input to
1062  * \param fd pointer to the filedescriptor to read
1063  * \param append Append to an existing string or replace?
1064  * \param Error strerror() on error
1065  * \returns numbers of chars read
1066  */
1067 int StrBufTCP_read_buffered_line(StrBuf *Line,
1068                                  StrBuf *buf,
1069                                  int *fd,
1070                                  int timeout,
1071                                  int selectresolution,
1072                                  const char **Error)
1073 {
1074         int len, rlen;
1075         int nSuccessLess = 0;
1076         fd_set rfds;
1077         char *pch = NULL;
1078         int fdflags;
1079         struct timeval tv;
1080
1081         if (buf->BufUsed > 0) {
1082                 pch = strchr(buf->buf, '\n');
1083                 if (pch != NULL) {
1084                         rlen = 0;
1085                         len = pch - buf->buf;
1086                         if (len > 0 && (*(pch - 1) == '\r') )
1087                                 rlen ++;
1088                         StrBufSub(Line, buf, 0, len - rlen);
1089                         StrBufCutLeft(buf, len + 1);
1090                         return len - rlen;
1091                 }
1092         }
1093
1094         if (buf->BufSize - buf->BufUsed < 10)
1095                 IncreaseBuf(buf, 1, -1);
1096
1097         fdflags = fcntl(*fd, F_GETFL);
1098         if ((fdflags & O_NONBLOCK) == O_NONBLOCK)
1099                 return -1;
1100
1101         while ((nSuccessLess < timeout) && (pch == NULL)) {
1102                 tv.tv_sec = selectresolution;
1103                 tv.tv_usec = 0;
1104
1105                 FD_ZERO(&rfds);
1106                 FD_SET(*fd, &rfds);
1107                 if (select(*fd + 1, NULL, &rfds, NULL, &tv) == -1) {
1108                         *Error = strerror(errno);
1109                         close (*fd);
1110                         *fd = -1;
1111                         return -1;
1112                 }
1113                 if (FD_ISSET(*fd, &rfds)) {
1114                         rlen = read(*fd,
1115                                     &buf->buf[buf->BufUsed],
1116                                     buf->BufSize - buf->BufUsed - 1);
1117                         if (rlen < 1) {
1118                                 *Error = strerror(errno);
1119                                 close(*fd);
1120                                 *fd = -1;
1121                                 return -1;
1122                         }
1123                         else if (rlen > 0) {
1124                                 nSuccessLess = 0;
1125                                 buf->BufUsed += rlen;
1126                                 buf->buf[buf->BufUsed] = '\0';
1127                                 if (buf->BufUsed + 10 > buf->BufSize) {
1128                                         IncreaseBuf(buf, 1, -1);
1129                                 }
1130                                 pch = strchr(buf->buf, '\n');
1131                                 continue;
1132                         }
1133                 }
1134                 nSuccessLess ++;
1135         }
1136         if (pch != NULL) {
1137                 rlen = 0;
1138                 len = pch - buf->buf;
1139                 if (len > 0 && (*(pch - 1) == '\r') )
1140                         rlen ++;
1141                 StrBufSub(Line, buf, 0, len - rlen);
1142                 StrBufCutLeft(buf, len + 1);
1143                 return len - rlen;
1144         }
1145         return -1;
1146
1147 }
1148
1149 /**
1150  * \brief Input binary data from socket
1151  * flushes and closes the FD on error
1152  * \param buf the buffer to get the input to
1153  * \param fd pointer to the filedescriptor to read
1154  * \param append Append to an existing string or replace?
1155  * \param nBytes the maximal number of bytes to read
1156  * \param Error strerror() on error
1157  * \returns numbers of chars read
1158  */
1159 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error)
1160 {
1161         fd_set wset;
1162         int fdflags;
1163         int len, rlen, slen;
1164         int nRead = 0;
1165         char *ptr;
1166
1167         if ((Buf == NULL) || (*fd == -1))
1168                 return -1;
1169         if (!append)
1170                 FlushStrBuf(Buf);
1171         if (Buf->BufUsed + nBytes > Buf->BufSize)
1172                 IncreaseBuf(Buf, 1, Buf->BufUsed + nBytes);
1173
1174         ptr = Buf->buf + Buf->BufUsed;
1175
1176         slen = len = Buf->BufUsed;
1177
1178         fdflags = fcntl(*fd, F_GETFL);
1179
1180         while (nRead < nBytes) {
1181                if ((fdflags & O_NONBLOCK) == O_NONBLOCK) {
1182                         FD_ZERO(&wset);
1183                         FD_SET(*fd, &wset);
1184                         if (select(*fd + 1, NULL, &wset, NULL, NULL) == -1) {
1185                                 *Error = strerror(errno);
1186                                 return -1;
1187                         }
1188                 }
1189
1190                 if ((rlen = read(*fd,
1191                                  ptr,
1192                                  nBytes - nRead)) == -1) {
1193                         close(*fd);
1194                         *fd = -1;
1195                         *Error = strerror(errno);
1196                         return rlen;
1197                 }
1198                 nRead += rlen;
1199                 ptr += rlen;
1200                 Buf->BufUsed += rlen;
1201         }
1202         Buf->buf[Buf->BufUsed] = '\0';
1203         return nRead;
1204 }
1205
1206 /**
1207  * \brief Cut nChars from the start of the string
1208  * \param Buf Buffer to modify
1209  * \param nChars how many chars should be skipped?
1210  */
1211 void StrBufCutLeft(StrBuf *Buf, int nChars)
1212 {
1213         if (nChars >= Buf->BufUsed) {
1214                 FlushStrBuf(Buf);
1215                 return;
1216         }
1217         memmove(Buf->buf, Buf->buf + nChars, Buf->BufUsed - nChars);
1218         Buf->BufUsed -= nChars;
1219         Buf->buf[Buf->BufUsed] = '\0';
1220 }
1221
1222 /**
1223  * \brief Cut the trailing n Chars from the string
1224  * \param Buf Buffer to modify
1225  * \param nChars how many chars should be trunkated?
1226  */
1227 void StrBufCutRight(StrBuf *Buf, int nChars)
1228 {
1229         if (nChars >= Buf->BufUsed) {
1230                 FlushStrBuf(Buf);
1231                 return;
1232         }
1233         Buf->BufUsed -= nChars;
1234         Buf->buf[Buf->BufUsed] = '\0';
1235 }
1236
1237 /**
1238  * \brief Cut the string after n Chars
1239  * \param Buf Buffer to modify
1240  * \param AfternChars after how many chars should we trunkate the string?
1241  * \param At if non-null and points inside of our string, cut it there.
1242  */
1243 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At)
1244 {
1245         if (At != NULL){
1246                 AfternChars = At - Buf->buf;
1247         }
1248
1249         if ((AfternChars < 0) || (AfternChars >= Buf->BufUsed))
1250                 return;
1251         Buf->BufUsed = AfternChars;
1252         Buf->buf[Buf->BufUsed] = '\0';
1253 }
1254
1255
1256 /*
1257  * Strip leading and trailing spaces from a string; with premeasured and adjusted length.
1258  * buf - the string to modify
1259  * len - length of the string.
1260  */
1261 void StrBufTrim(StrBuf *Buf)
1262 {
1263         int delta = 0;
1264         if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1265
1266         while ((Buf->BufUsed > delta) && (isspace(Buf->buf[delta]))){
1267                 delta ++;
1268         }
1269         if (delta > 0) StrBufCutLeft(Buf, delta);
1270
1271         if (Buf->BufUsed == 0) return;
1272         while (isspace(Buf->buf[Buf->BufUsed - 1])){
1273                 Buf->BufUsed --;
1274         }
1275         Buf->buf[Buf->BufUsed] = '\0';
1276 }
1277
1278
1279 void StrBufUpCase(StrBuf *Buf)
1280 {
1281         char *pch, *pche;
1282
1283         pch = Buf->buf;
1284         pche = pch + Buf->BufUsed;
1285         while (pch < pche) {
1286                 *pch = toupper(*pch);
1287                 pch ++;
1288         }
1289 }
1290
1291
1292 void StrBufLowerCase(StrBuf *Buf)
1293 {
1294         char *pch, *pche;
1295
1296         pch = Buf->buf;
1297         pche = pch + Buf->BufUsed;
1298         while (pch < pche) {
1299                 *pch = tolower(*pch);
1300                 pch ++;
1301         }
1302 }
1303
1304
1305 /**
1306  * \brief unhide special chars hidden to the HTML escaper
1307  * \param target buffer to put the unescaped string in
1308  * \param source buffer to unescape
1309  */
1310 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source)
1311 {
1312         int a, b, len;
1313         char hex[3];
1314
1315         if (target != NULL)
1316                 FlushStrBuf(target);
1317
1318         if (source == NULL ||target == NULL)
1319         {
1320                 return;
1321         }
1322
1323         len = source->BufUsed;
1324         for (a = 0; a < len; ++a) {
1325                 if (target->BufUsed >= target->BufSize)
1326                         IncreaseBuf(target, 1, -1);
1327
1328                 if (source->buf[a] == '=') {
1329                         hex[0] = source->buf[a + 1];
1330                         hex[1] = source->buf[a + 2];
1331                         hex[2] = 0;
1332                         b = 0;
1333                         sscanf(hex, "%02x", &b);
1334                         target->buf[target->BufUsed] = b;
1335                         target->buf[++target->BufUsed] = 0;
1336                         a += 2;
1337                 }
1338                 else {
1339                         target->buf[target->BufUsed] = source->buf[a];
1340                         target->buf[++target->BufUsed] = 0;
1341                 }
1342         }
1343 }
1344
1345
1346 /**
1347  * \brief hide special chars from the HTML escapers and friends
1348  * \param target buffer to put the escaped string in
1349  * \param source buffer to escape
1350  */
1351 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source)
1352 {
1353         int i, len;
1354
1355         if (target != NULL)
1356                 FlushStrBuf(target);
1357
1358         if (source == NULL ||target == NULL)
1359         {
1360                 return;
1361         }
1362
1363         len = source->BufUsed;
1364         for (i=0; i<len; ++i) {
1365                 if (target->BufUsed + 4 >= target->BufSize)
1366                         IncreaseBuf(target, 1, -1);
1367                 if ( (isalnum(source->buf[i])) ||
1368                      (source->buf[i]=='-') ||
1369                      (source->buf[i]=='_') ) {
1370                         target->buf[target->BufUsed++] = source->buf[i];
1371                 }
1372                 else {
1373                         sprintf(&target->buf[target->BufUsed],
1374                                 "=%02X",
1375                                 (0xFF &source->buf[i]));
1376                         target->BufUsed += 3;
1377                 }
1378         }
1379         target->buf[target->BufUsed + 1] = '\0';
1380 }
1381
1382 /*
1383  * \brief uses the same calling syntax as compress2(), but it
1384  * creates a stream compatible with HTTP "Content-encoding: gzip"
1385  */
1386 #ifdef HAVE_ZLIB
1387 #define DEF_MEM_LEVEL 8 /*< memlevel??? */
1388 #define OS_CODE 0x03    /*< unix */
1389 int ZEXPORT compress_gzip(Bytef * dest,         /*< compressed buffer*/
1390                           size_t * destLen,     /*< length of the compresed data */
1391                           const Bytef * source, /*< source to encode */
1392                           uLong sourceLen,      /*< length of source to encode */
1393                           int level)            /*< compression level */
1394 {
1395         const int gz_magic[2] = { 0x1f, 0x8b }; /* gzip magic header */
1396
1397         /* write gzip header */
1398         snprintf((char *) dest, *destLen,
1399                  "%c%c%c%c%c%c%c%c%c%c",
1400                  gz_magic[0], gz_magic[1], Z_DEFLATED,
1401                  0 /*flags */ , 0, 0, 0, 0 /*time */ , 0 /* xflags */ ,
1402                  OS_CODE);
1403
1404         /* normal deflate */
1405         z_stream stream;
1406         int err;
1407         stream.next_in = (Bytef *) source;
1408         stream.avail_in = (uInt) sourceLen;
1409         stream.next_out = dest + 10L;   // after header
1410         stream.avail_out = (uInt) * destLen;
1411         if ((uLong) stream.avail_out != *destLen)
1412                 return Z_BUF_ERROR;
1413
1414         stream.zalloc = (alloc_func) 0;
1415         stream.zfree = (free_func) 0;
1416         stream.opaque = (voidpf) 0;
1417
1418         err = deflateInit2(&stream, level, Z_DEFLATED, -MAX_WBITS,
1419                            DEF_MEM_LEVEL, Z_DEFAULT_STRATEGY);
1420         if (err != Z_OK)
1421                 return err;
1422
1423         err = deflate(&stream, Z_FINISH);
1424         if (err != Z_STREAM_END) {
1425                 deflateEnd(&stream);
1426                 return err == Z_OK ? Z_BUF_ERROR : err;
1427         }
1428         *destLen = stream.total_out + 10L;
1429
1430         /* write CRC and Length */
1431         uLong crc = crc32(0L, source, sourceLen);
1432         int n;
1433         for (n = 0; n < 4; ++n, ++*destLen) {
1434                 dest[*destLen] = (int) (crc & 0xff);
1435                 crc >>= 8;
1436         }
1437         uLong len = stream.total_in;
1438         for (n = 0; n < 4; ++n, ++*destLen) {
1439                 dest[*destLen] = (int) (len & 0xff);
1440                 len >>= 8;
1441         }
1442         err = deflateEnd(&stream);
1443         return err;
1444 }
1445 #endif
1446
1447
1448 /**
1449  * Attention! If you feed this a Const String, you must maintain the uncompressed buffer yourself!
1450  */
1451 int CompressBuffer(StrBuf *Buf)
1452 {
1453 #ifdef HAVE_ZLIB
1454         char *compressed_data = NULL;
1455         size_t compressed_len, bufsize;
1456         int i = 0;
1457
1458         bufsize = compressed_len = ((Buf->BufUsed * 101) / 100) + 100;
1459         compressed_data = malloc(compressed_len);
1460
1461         /* Flush some space after the used payload so valgrind shuts up... */
1462         while ((i < 10) && (Buf->BufUsed + i < Buf->BufSize))
1463                 Buf->buf[Buf->BufUsed + i++] = '\0';
1464         if (compress_gzip((Bytef *) compressed_data,
1465                           &compressed_len,
1466                           (Bytef *) Buf->buf,
1467                           (uLongf) Buf->BufUsed, Z_BEST_SPEED) == Z_OK) {
1468                 if (!Buf->ConstBuf)
1469                         free(Buf->buf);
1470                 Buf->buf = compressed_data;
1471                 Buf->BufUsed = compressed_len;
1472                 Buf->BufSize = bufsize;
1473                 /* Flush some space after the used payload so valgrind shuts up... */
1474                 i = 0;
1475                 while ((i < 10) && (Buf->BufUsed + i < Buf->BufSize))
1476                         Buf->buf[Buf->BufUsed + i++] = '\0';
1477                 return 1;
1478         } else {
1479                 free(compressed_data);
1480         }
1481 #endif  /* HAVE_ZLIB */
1482         return 0;
1483 }
1484
1485 /**
1486  * \brief decode a buffer from base 64 encoding; destroys original
1487  * \param Buf Buffor to transform
1488  */
1489 int StrBufDecodeBase64(StrBuf *Buf)
1490 {
1491         char *xferbuf;
1492         size_t siz;
1493         if (Buf == NULL) return -1;
1494
1495         xferbuf = (char*) malloc(Buf->BufSize);
1496         siz = CtdlDecodeBase64(xferbuf,
1497                                Buf->buf,
1498                                Buf->BufUsed);
1499         free(Buf->buf);
1500         Buf->buf = xferbuf;
1501         Buf->BufUsed = siz;
1502         return siz;
1503 }
1504
1505 /**
1506  * \brief replace all chars >0x20 && < 0x7F with Mute
1507  * \param Mute char to put over invalid chars
1508  * \param Buf Buffor to transform
1509  */
1510 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute)
1511 {
1512         char *pch;
1513
1514         if (Buf == NULL) return -1;
1515         pch = Buf->buf;
1516         while (pch < Buf->buf + Buf->BufUsed) {
1517                 if ((*pch < 0x20) || (*pch > 0x7F))
1518                         *pch = Mute;
1519                 pch ++;
1520         }
1521         return Buf->BufUsed;
1522 }
1523
1524
1525 /**
1526  * \brief  remove escaped strings from i.e. the url string (like %20 for blanks)
1527  * \param Buf Buffer to translate
1528  * \param StripBlanks Reduce several blanks to one?
1529  */
1530 long StrBufUnescape(StrBuf *Buf, int StripBlanks)
1531 {
1532         int a, b;
1533         char hex[3];
1534         long len;
1535
1536         while ((Buf->BufUsed > 0) && (isspace(Buf->buf[Buf->BufUsed - 1]))){
1537                 Buf->buf[Buf->BufUsed - 1] = '\0';
1538                 Buf->BufUsed --;
1539         }
1540
1541         a = 0;
1542         while (a < Buf->BufUsed) {
1543                 if (Buf->buf[a] == '+')
1544                         Buf->buf[a] = ' ';
1545                 else if (Buf->buf[a] == '%') {
1546                         /* don't let % chars through, rather truncate the input. */
1547                         if (a + 2 > Buf->BufUsed) {
1548                                 Buf->buf[a] = '\0';
1549                                 Buf->BufUsed = a;
1550                         }
1551                         else {
1552                                 hex[0] = Buf->buf[a + 1];
1553                                 hex[1] = Buf->buf[a + 2];
1554                                 hex[2] = 0;
1555                                 b = 0;
1556                                 sscanf(hex, "%02x", &b);
1557                                 Buf->buf[a] = (char) b;
1558                                 len = Buf->BufUsed - a - 2;
1559                                 if (len > 0)
1560                                         memmove(&Buf->buf[a + 1], &Buf->buf[a + 3], len);
1561
1562                                 Buf->BufUsed -=2;
1563                         }
1564                 }
1565                 a++;
1566         }
1567         return a;
1568 }
1569
1570
1571 /**
1572  * \brief       RFC2047-encode a header field if necessary.
1573  *              If no non-ASCII characters are found, the string
1574  *              will be copied verbatim without encoding.
1575  *
1576  * \param       target          Target buffer.
1577  * \param       source          Source string to be encoded.
1578  * \returns     encoded length; -1 if non success.
1579  */
1580 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source)
1581 {
1582         const char headerStr[] = "=?UTF-8?Q?";
1583         int need_to_encode = 0;
1584         int i = 0;
1585         unsigned char ch;
1586
1587         if ((source == NULL) ||
1588             (target == NULL))
1589             return -1;
1590
1591         while ((i < source->BufUsed) &&
1592                (!IsEmptyStr (&source->buf[i])) &&
1593                (need_to_encode == 0)) {
1594                 if (((unsigned char) source->buf[i] < 32) ||
1595                     ((unsigned char) source->buf[i] > 126)) {
1596                         need_to_encode = 1;
1597                 }
1598                 i++;
1599         }
1600
1601         if (!need_to_encode) {
1602                 if (*target == NULL) {
1603                         *target = NewStrBufPlain(source->buf, source->BufUsed);
1604                 }
1605                 else {
1606                         FlushStrBuf(*target);
1607                         StrBufAppendBuf(*target, source, 0);
1608                 }
1609                 return (*target)->BufUsed;
1610         }
1611         if (*target == NULL)
1612                 *target = NewStrBufPlain(NULL, sizeof(headerStr) + source->BufUsed * 2);
1613         else if (sizeof(headerStr) + source->BufUsed > (*target)->BufSize)
1614                 IncreaseBuf(*target, sizeof(headerStr) + source->BufUsed, 0);
1615         memcpy ((*target)->buf, headerStr, sizeof(headerStr) - 1);
1616         (*target)->BufUsed = sizeof(headerStr) - 1;
1617         for (i=0; (i < source->BufUsed); ++i) {
1618                 if ((*target)->BufUsed + 4 > (*target)->BufSize)
1619                         IncreaseBuf(*target, 1, 0);
1620                 ch = (unsigned char) source->buf[i];
1621                 if ((ch < 32) || (ch > 126) || (ch == 61)) {
1622                         sprintf(&(*target)->buf[(*target)->BufUsed], "=%02X", ch);
1623                         (*target)->BufUsed += 3;
1624                 }
1625                 else {
1626                         (*target)->buf[(*target)->BufUsed] = ch;
1627                         (*target)->BufUsed++;
1628                 }
1629         }
1630
1631         if ((*target)->BufUsed + 4 > (*target)->BufSize)
1632                 IncreaseBuf(*target, 1, 0);
1633
1634         (*target)->buf[(*target)->BufUsed++] = '?';
1635         (*target)->buf[(*target)->BufUsed++] = '=';
1636         (*target)->buf[(*target)->BufUsed] = '\0';
1637         return (*target)->BufUsed;;
1638 }
1639
1640 /**
1641  * \brief replaces all occurances of 'search' by 'replace'
1642  * \param buf Buffer to modify
1643  * \param search character to search
1644  * \param relpace character to replace search by
1645  */
1646 void StrBufReplaceChars(StrBuf *buf, char search, char replace)
1647 {
1648         long i;
1649         if (buf == NULL)
1650                 return;
1651         for (i=0; i<buf->BufUsed; i++)
1652                 if (buf->buf[i] == search)
1653                         buf->buf[i] = replace;
1654
1655 }
1656
1657
1658
1659 /*
1660  * Wrapper around iconv_open()
1661  * Our version adds aliases for non-standard Microsoft charsets
1662  * such as 'MS950', aliasing them to names like 'CP950'
1663  *
1664  * tocode       Target encoding
1665  * fromcode     Source encoding
1666  */
1667 void  ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic)
1668 {
1669 #ifdef HAVE_ICONV
1670         iconv_t ic = (iconv_t)(-1) ;
1671         ic = iconv_open(tocode, fromcode);
1672         if (ic == (iconv_t)(-1) ) {
1673                 char alias_fromcode[64];
1674                 if ( (strlen(fromcode) == 5) && (!strncasecmp(fromcode, "MS", 2)) ) {
1675                         safestrncpy(alias_fromcode, fromcode, sizeof alias_fromcode);
1676                         alias_fromcode[0] = 'C';
1677                         alias_fromcode[1] = 'P';
1678                         ic = iconv_open(tocode, alias_fromcode);
1679                 }
1680         }
1681         *(iconv_t *)pic = ic;
1682 #endif
1683 }
1684
1685
1686
1687 static inline char *FindNextEnd (const StrBuf *Buf, char *bptr)
1688 {
1689         char * end;
1690         /* Find the next ?Q? */
1691         if (Buf->BufUsed - (bptr - Buf->buf)  < 6)
1692                 return NULL;
1693
1694         end = strchr(bptr + 2, '?');
1695
1696         if (end == NULL)
1697                 return NULL;
1698
1699         if ((Buf->BufUsed - (end - Buf->buf) > 3) &&
1700             ((*(end + 1) == 'B') || (*(end + 1) == 'Q')) &&
1701             (*(end + 2) == '?')) {
1702                 /* skip on to the end of the cluster, the next ?= */
1703                 end = strstr(end + 3, "?=");
1704         }
1705         else
1706                 /* sort of half valid encoding, try to find an end. */
1707                 end = strstr(bptr, "?=");
1708         return end;
1709 }
1710
1711
1712 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic)
1713 {
1714 #ifdef HAVE_ICONV
1715         int BufSize;
1716         iconv_t ic;
1717         char *ibuf;                     /**< Buffer of characters to be converted */
1718         char *obuf;                     /**< Buffer for converted characters */
1719         size_t ibuflen;                 /**< Length of input buffer */
1720         size_t obuflen;                 /**< Length of output buffer */
1721
1722
1723         if (ConvertBuf->BufUsed > TmpBuf->BufSize)
1724                 IncreaseBuf(TmpBuf, 0, ConvertBuf->BufUsed);
1725
1726         ic = *(iconv_t*)pic;
1727         ibuf = ConvertBuf->buf;
1728         ibuflen = ConvertBuf->BufUsed;
1729         obuf = TmpBuf->buf;
1730         obuflen = TmpBuf->BufSize;
1731
1732         iconv(ic, &ibuf, &ibuflen, &obuf, &obuflen);
1733
1734         /* little card game: wheres the red lady? */
1735         ibuf = ConvertBuf->buf;
1736         BufSize = ConvertBuf->BufSize;
1737
1738         ConvertBuf->buf = TmpBuf->buf;
1739         ConvertBuf->BufSize = TmpBuf->BufSize;
1740         ConvertBuf->BufUsed = TmpBuf->BufSize - obuflen;
1741         ConvertBuf->buf[ConvertBuf->BufUsed] = '\0';
1742
1743         TmpBuf->buf = ibuf;
1744         TmpBuf->BufSize = BufSize;
1745         TmpBuf->BufUsed = 0;
1746         TmpBuf->buf[0] = '\0';
1747 #endif
1748 }
1749
1750
1751
1752
1753 inline static void DecodeSegment(StrBuf *Target,
1754                                  const StrBuf *DecodeMe,
1755                                  char *SegmentStart,
1756                                  char *SegmentEnd,
1757                                  StrBuf *ConvertBuf,
1758                                  StrBuf *ConvertBuf2,
1759                                  StrBuf *FoundCharset)
1760 {
1761         StrBuf StaticBuf;
1762         char charset[128];
1763         char encoding[16];
1764         iconv_t ic = (iconv_t)(-1);
1765
1766         /* Now we handle foreign character sets properly encoded
1767          * in RFC2047 format.
1768          */
1769         StaticBuf.buf = SegmentStart;
1770         StaticBuf.BufUsed = SegmentEnd - SegmentStart;
1771         StaticBuf.BufSize = DecodeMe->BufSize - (SegmentStart - DecodeMe->buf);
1772         extract_token(charset, SegmentStart, 1, '?', sizeof charset);
1773         if (FoundCharset != NULL) {
1774                 FlushStrBuf(FoundCharset);
1775                 StrBufAppendBufPlain(FoundCharset, charset, -1, 0);
1776         }
1777         extract_token(encoding, SegmentStart, 2, '?', sizeof encoding);
1778         StrBufExtract_token(ConvertBuf, &StaticBuf, 3, '?');
1779
1780         *encoding = toupper(*encoding);
1781         if (*encoding == 'B') { /**< base64 */
1782                 ConvertBuf2->BufUsed = CtdlDecodeBase64(ConvertBuf2->buf,
1783                                                         ConvertBuf->buf,
1784                                                         ConvertBuf->BufUsed);
1785         }
1786         else if (*encoding == 'Q') {    /**< quoted-printable */
1787                 long pos;
1788
1789                 pos = 0;
1790                 while (pos < ConvertBuf->BufUsed)
1791                 {
1792                         if (ConvertBuf->buf[pos] == '_')
1793                                 ConvertBuf->buf[pos] = ' ';
1794                         pos++;
1795                 }
1796
1797                 ConvertBuf2->BufUsed = CtdlDecodeQuotedPrintable(
1798                         ConvertBuf2->buf,
1799                         ConvertBuf->buf,
1800                         ConvertBuf->BufUsed);
1801         }
1802         else {
1803                 StrBufAppendBuf(ConvertBuf2, ConvertBuf, 0);
1804         }
1805
1806         ctdl_iconv_open("UTF-8", charset, &ic);
1807         if (ic != (iconv_t)(-1) ) {
1808                 StrBufConvert(ConvertBuf2, ConvertBuf, &ic);
1809                 StrBufAppendBuf(Target, ConvertBuf2, 0);
1810                 iconv_close(ic);
1811         }
1812         else {
1813                 StrBufAppendBufPlain(Target, HKEY("(unreadable)"), 0);
1814         }
1815 }
1816 /*
1817  * Handle subjects with RFC2047 encoding such as:
1818  * =?koi8-r?B?78bP0s3Mxc7JxSDXz9rE1dvO2c3JINvB0sHNySDP?=
1819  */
1820 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset)
1821 {
1822         StrBuf *ConvertBuf, *ConvertBuf2;
1823         char *start, *end, *next, *nextend, *ptr = NULL;
1824         iconv_t ic = (iconv_t)(-1) ;
1825         const char *eptr;
1826         int passes = 0;
1827         int i, len, delta;
1828         int illegal_non_rfc2047_encoding = 0;
1829
1830         /* Sometimes, badly formed messages contain strings which were simply
1831          *  written out directly in some foreign character set instead of
1832          *  using RFC2047 encoding.  This is illegal but we will attempt to
1833          *  handle it anyway by converting from a user-specified default
1834          *  charset to UTF-8 if we see any nonprintable characters.
1835          */
1836
1837         len = StrLength(DecodeMe);
1838         for (i=0; i<DecodeMe->BufUsed; ++i) {
1839                 if ((DecodeMe->buf[i] < 32) || (DecodeMe->buf[i] > 126)) {
1840                         illegal_non_rfc2047_encoding = 1;
1841                         break;
1842                 }
1843         }
1844
1845         ConvertBuf = NewStrBufPlain(NULL, StrLength(DecodeMe));
1846         if ((illegal_non_rfc2047_encoding) &&
1847             (strcasecmp(ChrPtr(DefaultCharset), "UTF-8")) &&
1848             (strcasecmp(ChrPtr(DefaultCharset), "us-ascii")) )
1849         {
1850                 ctdl_iconv_open("UTF-8", ChrPtr(DefaultCharset), &ic);
1851                 if (ic != (iconv_t)(-1) ) {
1852                         StrBufConvert((StrBuf*)DecodeMe, ConvertBuf, &ic);///TODO: don't void const?
1853                         iconv_close(ic);
1854                 }
1855         }
1856
1857         /* pre evaluate the first pair */
1858         nextend = end = NULL;
1859         len = StrLength(DecodeMe);
1860         start = strstr(DecodeMe->buf, "=?");
1861         eptr = DecodeMe->buf + DecodeMe->BufUsed;
1862         if (start != NULL)
1863                 end = FindNextEnd (DecodeMe, start);
1864         else {
1865                 StrBufAppendBuf(Target, DecodeMe, 0);
1866                 FreeStrBuf(&ConvertBuf);
1867                 return;
1868         }
1869
1870         ConvertBuf2 = NewStrBufPlain(NULL, StrLength(DecodeMe));
1871
1872         if (start != DecodeMe->buf)
1873                 StrBufAppendBufPlain(Target, DecodeMe->buf, start - DecodeMe->buf, 0);
1874         /*
1875          * Since spammers will go to all sorts of absurd lengths to get their
1876          * messages through, there are LOTS of corrupt headers out there.
1877          * So, prevent a really badly formed RFC2047 header from throwing
1878          * this function into an infinite loop.
1879          */
1880         while ((start != NULL) &&
1881                (end != NULL) &&
1882                (start < eptr) &&
1883                (end < eptr) &&
1884                (passes < 20))
1885         {
1886                 passes++;
1887                 DecodeSegment(Target,
1888                               DecodeMe,
1889                               start,
1890                               end,
1891                               ConvertBuf,
1892                               ConvertBuf2,
1893                               FoundCharset);
1894
1895                 next = strstr(end, "=?");
1896                 nextend = NULL;
1897                 if ((next != NULL) &&
1898                     (next < eptr))
1899                         nextend = FindNextEnd(DecodeMe, next);
1900                 if (nextend == NULL)
1901                         next = NULL;
1902
1903                 /* did we find two partitions */
1904                 if ((next != NULL) &&
1905                     ((next - end) > 2))
1906                 {
1907                         ptr = end + 2;
1908                         while ((ptr < next) &&
1909                                (isspace(*ptr) ||
1910                                 (*ptr == '\r') ||
1911                                 (*ptr == '\n') ||
1912                                 (*ptr == '\t')))
1913                                 ptr ++;
1914                         /* did we find a gab just filled with blanks? */
1915                         if (ptr == next)
1916                         {
1917                                 memmove (end + 2,
1918                                          next,
1919                                          len - (next - start));
1920
1921                                 /* now terminate the gab at the end */
1922                                 delta = (next - end) - 2; ////TODO: const!
1923                                 ((StrBuf*)DecodeMe)->BufUsed -= delta;
1924                                 ((StrBuf*)DecodeMe)->buf[DecodeMe->BufUsed] = '\0';
1925
1926                                 /* move next to its new location. */
1927                                 next -= delta;
1928                                 nextend -= delta;
1929                         }
1930                 }
1931                 /* our next-pair is our new first pair now. */
1932                 ptr = end + 2;
1933                 start = next;
1934                 end = nextend;
1935         }
1936         end = ptr;
1937         nextend = DecodeMe->buf + DecodeMe->BufUsed;
1938         if ((end != NULL) && (end < nextend)) {
1939                 ptr = end;
1940                 while ( (ptr < nextend) &&
1941                         (isspace(*ptr) ||
1942                          (*ptr == '\r') ||
1943                          (*ptr == '\n') ||
1944                          (*ptr == '\t')))
1945                         ptr ++;
1946                 if (ptr < nextend)
1947                         StrBufAppendBufPlain(Target, end, nextend - end, 0);
1948         }
1949         FreeStrBuf(&ConvertBuf);
1950         FreeStrBuf(&ConvertBuf2);
1951 }
1952
1953
1954
1955 long StrBuf_Utf8StrLen(StrBuf *Buf)
1956 {
1957         return Ctdl_Utf8StrLen(Buf->buf);
1958 }
1959
1960 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen)
1961 {
1962         char *CutAt;
1963
1964         CutAt = Ctdl_Utf8StrCut(Buf->buf, maxlen);
1965         if (CutAt != NULL) {
1966                 Buf->BufUsed = CutAt - Buf->buf;
1967                 Buf->buf[Buf->BufUsed] = '\0';
1968         }
1969         return Buf->BufUsed;
1970 }
1971
1972
1973
1974 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr)
1975 {
1976         const char *aptr, *ptr, *eptr;
1977         char *optr, *xptr;
1978
1979         if (Buf == NULL)
1980                 return 0;
1981
1982         if (*Ptr==NULL)
1983                 ptr = aptr = Buf->buf;
1984         else
1985                 ptr = aptr = *Ptr;
1986
1987         optr = LineBuf->buf;
1988         eptr = Buf->buf + Buf->BufUsed;
1989         xptr = LineBuf->buf + LineBuf->BufSize;
1990
1991         while ((*ptr != '\n') &&
1992                (*ptr != '\r') &&
1993                (ptr < eptr))
1994         {
1995                 *optr = *ptr;
1996                 optr++; ptr++;
1997                 if (optr == xptr) {
1998                         LineBuf->BufUsed = optr - LineBuf->buf;
1999                         IncreaseBuf(LineBuf,  1, LineBuf->BufUsed + 1);
2000                         optr = LineBuf->buf + LineBuf->BufUsed;
2001                         xptr = LineBuf->buf + LineBuf->BufSize;
2002                 }
2003         }
2004         LineBuf->BufUsed = optr - LineBuf->buf;
2005         *optr = '\0';
2006         if (*ptr == '\r')
2007                 ptr ++;
2008         if (*ptr == '\n')
2009                 ptr ++;
2010
2011         *Ptr = ptr;
2012
2013         return Buf->BufUsed - (ptr - Buf->buf);
2014 }