8 #include <sys/select.h>
10 #include <sys/types.h>
11 #define SHOW_ME_VAPPEND_PRINTF
13 #include "libcitadel.h"
25 int ZEXPORT compress_gzip(Bytef * dest, size_t * destLen,
26 const Bytef * source, uLong sourceLen, int level);
28 int BaseStrBufSize = 64;
30 const char *StrBufNOTNULL = ((char*) NULL) - 1;
32 const char HexList[256][3] = {
33 "00","01","02","03","04","05","06","07","08","09","0A","0B","0C","0D","0E","0F",
34 "10","11","12","13","14","15","16","17","18","19","1A","1B","1C","1D","1E","1F",
35 "20","21","22","23","24","25","26","27","28","29","2A","2B","2C","2D","2E","2F",
36 "30","31","32","33","34","35","36","37","38","39","3A","3B","3C","3D","3E","3F",
37 "40","41","42","43","44","45","46","47","48","49","4A","4B","4C","4D","4E","4F",
38 "50","51","52","53","54","55","56","57","58","59","5A","5B","5C","5D","5E","5F",
39 "60","61","62","63","64","65","66","67","68","69","6A","6B","6C","6D","6E","6F",
40 "70","71","72","73","74","75","76","77","78","79","7A","7B","7C","7D","7E","7F",
41 "80","81","82","83","84","85","86","87","88","89","8A","8B","8C","8D","8E","8F",
42 "90","91","92","93","94","95","96","97","98","99","9A","9B","9C","9D","9E","9F",
43 "A0","A1","A2","A3","A4","A5","A6","A7","A8","A9","AA","AB","AC","AD","AE","AF",
44 "B0","B1","B2","B3","B4","B5","B6","B7","B8","B9","BA","BB","BC","BD","BE","BF",
45 "C0","C1","C2","C3","C4","C5","C6","C7","C8","C9","CA","CB","CC","CD","CE","CF",
46 "D0","D1","D2","D3","D4","D5","D6","D7","D8","D9","DA","DB","DC","DD","DE","DF",
47 "E0","E1","E2","E3","E4","E5","E6","E7","E8","E9","EA","EB","EC","ED","EE","EF",
48 "F0","F1","F2","F3","F4","F5","F6","F7","F8","F9","FA","FB","FC","FD","FE","FF"};
51 * @defgroup StrBuf Stringbuffer, A class for manipulating strings with dynamic buffers
52 * StrBuf is a versatile class, aiding the handling of dynamic strings
53 * * reduce de/reallocations
54 * * reduce the need to remeasure it
55 * * reduce scanning over the string (in @ref StrBuf_NextTokenizer "Tokenizers")
56 * * allow asyncroneous IO for line and Blob based operations
57 * * reduce the use of memove in those
58 * * Quick filling in several operations with append functions
62 * @defgroup StrBuf_DeConstructors Create/Destroy StrBufs
67 * @defgroup StrBuf_Cast Cast operators to interact with char* based code
69 * use these operators to interfere with code demanding char*;
70 * if you need to own the content, smash me. Avoid, since we loose the length information.
74 * @defgroup StrBuf_Filler Create/Replace/Append Content into a StrBuf
76 * operations to get your Strings into a StrBuf, manipulating them, or appending
79 * @defgroup StrBuf_NextTokenizer Fast tokenizer to pull tokens in sequence
81 * Quick tokenizer; demands of the user to pull its tokens in sequence
85 * @defgroup StrBuf_Tokenizer tokenizer Functions; Slow ones.
87 * versatile tokenizer; random access to tokens, but slower; Prefer the @ref StrBuf_NextTokenizer "Next Tokenizer"
91 * @defgroup StrBuf_BufferedIO Buffered IO with Asynchroneous reads and no unneeded memmoves (the fast ones)
93 * File IO to fill StrBufs; Works with work-buffer shared across several calls;
94 * External Cursor to maintain the current read position inside of the buffer
95 * the non-fast ones will use memove to keep the start of the buffer the read buffer (which is slower)
99 * @defgroup StrBuf_IO FileIO; Prefer @ref StrBuf_BufferedIO
105 * @defgroup StrBuf_DeEnCoder functions to translate the contents of a buffer
107 * these functions translate the content of a buffer into another representation;
108 * some are combined Fillers and encoders
112 * Private Structure for the Stringbuffer
115 char *buf; /**< the pointer to the dynamic buffer */
116 long BufSize; /**< how many spcae do we optain */
117 long BufUsed; /**< StNumber of Chars used excluding the trailing \\0 */
118 int ConstBuf; /**< are we just a wrapper arround a static buffer and musn't we be changed? */
120 long nIncreases; /**< for profiling; cound how many times we needed more */
121 char bt [SIZ]; /**< Stacktrace of last increase */
122 char bt_lastinc [SIZ]; /**< How much did we increase last time? */
127 static inline int Ctdl_GetUtf8SequenceLength(const char *CharS, const char *CharE);
128 static inline int Ctdl_IsUtf8SequenceStart(const char Char);
131 #ifdef HAVE_BACKTRACE
132 static void StrBufBacktrace(StrBuf *Buf, int which)
136 void *stack_frames[50];
141 pstart = pch = Buf->bt;
143 pstart = pch = Buf->bt_lastinc;
144 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
145 strings = backtrace_symbols(stack_frames, size);
146 for (i = 0; i < size; i++) {
148 n = snprintf(pch, SIZ - (pch - pstart), "%s\\n", strings[i]);
150 n = snprintf(pch, SIZ - (pch - pstart), "%p\\n", stack_frames[i]);
159 void dbg_FreeStrBuf(StrBuf *FreeMe, char *FromWhere)
161 if (hFreeDbglog == -1){
162 pid_t pid = getpid();
164 snprintf(path, SIZ, "/tmp/libcitadel_strbuf_realloc.log.%d", pid);
165 hFreeDbglog = open(path, O_APPEND|O_CREAT|O_WRONLY);
167 if ((*FreeMe)->nIncreases > 0)
171 n = snprintf(buf, SIZ * 3, "%c+|%ld|%ld|%ld|%s|%s|\n",
173 (*FreeMe)->nIncreases,
177 (*FreeMe)->bt_lastinc);
178 n = write(hFreeDbglog, buf, n);
184 n = snprintf(buf, 128, "%c_|0|%ld%ld|\n",
188 n = write(hFreeDbglog, buf, n);
192 void dbg_IncreaseBuf(StrBuf *IncMe)
195 #ifdef HAVE_BACKTRACE
196 StrBufBacktrace(Buf, 1);
200 void dbg_Init(StrBuf *Buf)
204 Buf->bt_lastinc[0] = '\0';
205 #ifdef HAVE_BACKTRACE
206 StrBufBacktrace(Buf, 0);
212 #define dbg_FreeStrBuf(a, b)
213 #define dbg_IncreaseBuf(a)
219 * @ingroup StrBuf_Cast
220 * @brief Cast operator to Plain String
221 * @note if the buffer is altered by StrBuf operations, this pointer may become
222 * invalid. So don't lean on it after altering the buffer!
223 * Since this operation is considered cheap, rather call it often than risking
224 * your pointer to become invalid!
225 * @param Str the string we want to get the c-string representation for
226 * @returns the Pointer to the Content. Don't mess with it!
228 inline const char *ChrPtr(const StrBuf *Str)
236 * @ingroup StrBuf_Cast
237 * @brief since we know strlen()'s result, provide it here.
238 * @param Str the string to return the length to
239 * @returns contentlength of the buffer
241 inline int StrLength(const StrBuf *Str)
243 return (Str != NULL) ? Str->BufUsed : 0;
247 * @ingroup StrBuf_DeConstructors
248 * @brief local utility function to resize the buffer
249 * @param Buf the buffer whichs storage we should increase
250 * @param KeepOriginal should we copy the original buffer or just start over with a new one
251 * @param DestSize what should fit in after?
253 static int IncreaseBuf(StrBuf *Buf, int KeepOriginal, int DestSize)
256 size_t NewSize = Buf->BufSize * 2;
262 while ((NewSize <= DestSize) && (NewSize != 0))
268 NewBuf= (char*) malloc(NewSize);
272 if (KeepOriginal && (Buf->BufUsed > 0))
274 memcpy(NewBuf, Buf->buf, Buf->BufUsed);
283 Buf->BufSize = NewSize;
285 dbg_IncreaseBuf(Buf);
291 * @ingroup StrBuf_DeConstructors
292 * @brief shrink / increase an _EMPTY_ buffer to NewSize. Buffercontent is thoroughly ignored and flushed.
293 * @param Buf Buffer to shrink (has to be empty)
294 * @param ThreshHold if the buffer is bigger then this, its readjusted
295 * @param NewSize if we Shrink it, how big are we going to be afterwards?
297 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize)
300 (Buf->BufUsed == 0) &&
301 (Buf->BufSize < ThreshHold)) {
303 Buf->buf = (char*) malloc(NewSize);
305 Buf->BufSize = NewSize;
310 * @ingroup StrBuf_DeConstructors
311 * @brief shrink long term buffers to their real size so they don't waste memory
312 * @param Buf buffer to shrink
313 * @param Force if not set, will just executed if the buffer is much to big; set for lifetime strings
314 * @returns physical size of the buffer
316 long StrBufShrinkToFit(StrBuf *Buf, int Force)
321 (Buf->BufUsed + (Buf->BufUsed / 3) > Buf->BufSize))
323 char *TmpBuf = (char*) malloc(Buf->BufUsed + 1);
324 memcpy (TmpBuf, Buf->buf, Buf->BufUsed + 1);
325 Buf->BufSize = Buf->BufUsed + 1;
333 * @ingroup StrBuf_DeConstructors
334 * @brief Allocate a new buffer with default buffer size
335 * @returns the new stringbuffer
337 StrBuf* NewStrBuf(void)
341 NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
342 NewBuf->buf = (char*) malloc(BaseStrBufSize);
343 NewBuf->buf[0] = '\0';
344 NewBuf->BufSize = BaseStrBufSize;
346 NewBuf->ConstBuf = 0;
354 * @ingroup StrBuf_DeConstructors
355 * @brief Copy Constructor; returns a duplicate of CopyMe
356 * @param CopyMe Buffer to faxmilate
357 * @returns the new stringbuffer
359 StrBuf* NewStrBufDup(const StrBuf *CopyMe)
366 NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
367 NewBuf->buf = (char*) malloc(CopyMe->BufSize);
368 memcpy(NewBuf->buf, CopyMe->buf, CopyMe->BufUsed + 1);
369 NewBuf->BufUsed = CopyMe->BufUsed;
370 NewBuf->BufSize = CopyMe->BufSize;
371 NewBuf->ConstBuf = 0;
379 * @ingroup StrBuf_DeConstructors
380 * @brief create a new Buffer using an existing c-string
381 * this function should also be used if you want to pre-suggest
382 * the buffer size to allocate in conjunction with ptr == NULL
383 * @param ptr the c-string to copy; may be NULL to create a blank instance
384 * @param nChars How many chars should we copy; -1 if we should measure the length ourselves
385 * @returns the new stringbuffer
387 StrBuf* NewStrBufPlain(const char* ptr, int nChars)
390 size_t Siz = BaseStrBufSize;
393 NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
395 CopySize = strlen((ptr != NULL)?ptr:"");
399 while ((Siz <= CopySize) && (Siz != 0))
407 NewBuf->buf = (char*) malloc(Siz);
408 NewBuf->BufSize = Siz;
410 memcpy(NewBuf->buf, ptr, CopySize);
411 NewBuf->buf[CopySize] = '\0';
412 NewBuf->BufUsed = CopySize;
415 NewBuf->buf[0] = '\0';
418 NewBuf->ConstBuf = 0;
426 * @ingroup StrBuf_DeConstructors
427 * @brief Set an existing buffer from a c-string
428 * @param Buf buffer to load
429 * @param ptr c-string to put into
430 * @param nChars set to -1 if we should work 0-terminated
431 * @returns the new length of the string
433 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars)
448 CopySize = strlen(ptr);
452 while ((Siz <= CopySize) && (Siz != 0))
460 if (Siz != Buf->BufSize)
461 IncreaseBuf(Buf, 0, Siz);
462 memcpy(Buf->buf, ptr, CopySize);
463 Buf->buf[CopySize] = '\0';
464 Buf->BufUsed = CopySize;
471 * @ingroup StrBuf_DeConstructors
472 * @brief use strbuf as wrapper for a string constant for easy handling
473 * @param StringConstant a string to wrap
474 * @param SizeOfStrConstant should be sizeof(StringConstant)-1
476 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant)
480 NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
481 NewBuf->buf = (char*) StringConstant;
482 NewBuf->BufSize = SizeOfStrConstant;
483 NewBuf->BufUsed = SizeOfStrConstant;
484 NewBuf->ConstBuf = 1;
493 * @ingroup StrBuf_DeConstructors
494 * @brief flush the content of a Buf; keep its struct
495 * @param buf Buffer to flush
497 int FlushStrBuf(StrBuf *buf)
509 * @ingroup StrBuf_DeConstructors
510 * @brief wipe the content of a Buf thoroughly (overwrite it -> expensive); keep its struct
511 * @param buf Buffer to wipe
513 int FLUSHStrBuf(StrBuf *buf)
519 if (buf->BufUsed > 0) {
520 memset(buf->buf, 0, buf->BufUsed);
527 int hFreeDbglog = -1;
530 * @ingroup StrBuf_DeConstructors
531 * @brief Release a Buffer
532 * Its a double pointer, so it can NULL your pointer
533 * so fancy SIG11 appear instead of random results
534 * @param FreeMe Pointer Pointer to the buffer to free
536 void FreeStrBuf (StrBuf **FreeMe)
541 dbg_FreeStrBuf(FreeMe, 'F');
543 if (!(*FreeMe)->ConstBuf)
544 free((*FreeMe)->buf);
550 * @ingroup StrBuf_DeConstructors
551 * @brief flatten a Buffer to the Char * we return
552 * Its a double pointer, so it can NULL your pointer
553 * so fancy SIG11 appear instead of random results
554 * The Callee then owns the buffer and is responsible for freeing it.
555 * @param SmashMe Pointer Pointer to the buffer to release Buf from and free
556 * @returns the pointer of the buffer; Callee owns the memory thereafter.
558 char *SmashStrBuf (StrBuf **SmashMe)
562 if ((SmashMe == NULL) || (*SmashMe == NULL))
565 dbg_FreeStrBuf(SmashMe, 'S');
567 Ret = (*SmashMe)->buf;
574 * @ingroup StrBuf_DeConstructors
575 * @brief Release the buffer
576 * If you want put your StrBuf into a Hash, use this as Destructor.
577 * @param VFreeMe untyped pointer to a StrBuf. be shure to do the right thing [TM]
579 void HFreeStrBuf (void *VFreeMe)
581 StrBuf *FreeMe = (StrBuf*)VFreeMe;
585 dbg_FreeStrBuf(SmashMe, 'H');
587 if (!FreeMe->ConstBuf)
593 /*******************************************************************************
594 * Simple string transformations *
595 *******************************************************************************/
599 * @brief Wrapper around atol
601 long StrTol(const StrBuf *Buf)
606 return atol(Buf->buf);
613 * @brief Wrapper around atoi
615 int StrToi(const StrBuf *Buf)
619 if (Buf->BufUsed > 0)
620 return atoi(Buf->buf);
627 * @brief Checks to see if the string is a pure number
628 * @param Buf The buffer to inspect
629 * @returns 1 if its a pure number, 0, if not.
631 int StrBufIsNumber(const StrBuf *Buf) {
633 if ((Buf == NULL) || (Buf->BufUsed == 0)) {
636 strtoll(Buf->buf, &pEnd, 10);
637 if (pEnd == Buf->buf)
639 if ((pEnd != NULL) && (pEnd == Buf->buf + Buf->BufUsed))
641 if (Buf->buf == pEnd)
647 * @ingroup StrBuf_Filler
648 * @brief modifies a Single char of the Buf
649 * You can point to it via char* or a zero-based integer
650 * @param Buf The buffer to manipulate
651 * @param ptr char* to zero; use NULL if unused
652 * @param nThChar zero based pointer into the string; use -1 if unused
653 * @param PeekValue The Character to place into the position
655 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue)
660 nThChar = ptr - Buf->buf;
661 if ((nThChar < 0) || (nThChar > Buf->BufUsed))
663 Buf->buf[nThChar] = PeekValue;
668 * @ingroup StrBuf_Filler
669 * @brief modifies a range of chars of the Buf
670 * You can point to it via char* or a zero-based integer
671 * @param Buf The buffer to manipulate
672 * @param ptr char* to zero; use NULL if unused
673 * @param nThChar zero based pointer into the string; use -1 if unused
674 * @param nChars how many chars are to be flushed?
675 * @param PookValue The Character to place into that area
677 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue)
682 nThChar = ptr - Buf->buf;
683 if ((nThChar < 0) || (nThChar > Buf->BufUsed))
685 if (nThChar + nChars > Buf->BufUsed)
686 nChars = Buf->BufUsed - nThChar;
688 memset(Buf->buf + nThChar, PookValue, nChars);
689 /* just to be shure... */
690 Buf->buf[Buf->BufUsed] = 0;
695 * @ingroup StrBuf_Filler
696 * @brief Append a StringBuffer to the buffer
697 * @param Buf Buffer to modify
698 * @param AppendBuf Buffer to copy at the end of our buffer
699 * @param Offset Should we start copying from an offset?
701 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset)
703 if ((AppendBuf == NULL) || (Buf == NULL) || (AppendBuf->buf == NULL))
706 if (Buf->BufSize - Offset < AppendBuf->BufUsed + Buf->BufUsed + 1)
709 AppendBuf->BufUsed + Buf->BufUsed);
711 memcpy(Buf->buf + Buf->BufUsed,
712 AppendBuf->buf + Offset,
713 AppendBuf->BufUsed - Offset);
714 Buf->BufUsed += AppendBuf->BufUsed - Offset;
715 Buf->buf[Buf->BufUsed] = '\0';
720 * @ingroup StrBuf_Filler
721 * @brief Append a C-String to the buffer
722 * @param Buf Buffer to modify
723 * @param AppendBuf Buffer to copy at the end of our buffer
724 * @param AppendSize number of bytes to copy; set to -1 if we should count it in advance
725 * @param Offset Should we start copying from an offset?
727 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset)
730 long BufSizeRequired;
732 if ((AppendBuf == NULL) || (Buf == NULL))
736 aps = strlen(AppendBuf + Offset);
738 aps = AppendSize - Offset;
740 BufSizeRequired = Buf->BufUsed + aps + 1;
741 if (Buf->BufSize <= BufSizeRequired)
742 IncreaseBuf(Buf, (Buf->BufUsed > 0), BufSizeRequired);
744 memcpy(Buf->buf + Buf->BufUsed,
748 Buf->buf[Buf->BufUsed] = '\0';
752 * @ingroup StrBuf_Filler
753 * @brief sprintf like function appending the formated string to the buffer
754 * vsnprintf version to wrap into own calls
755 * @param Buf Buffer to extend by format and Params
756 * @param format printf alike format to add
757 * @param ap va_list containing the items for format
759 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap)
767 if ((Buf == NULL) || (format == NULL))
770 BufSize = Buf->BufSize;
771 nWritten = Buf->BufSize + 1;
772 Offset = Buf->BufUsed;
773 newused = Offset + nWritten;
775 while (newused >= BufSize) {
777 nWritten = vsnprintf(Buf->buf + Offset,
778 Buf->BufSize - Offset,
781 newused = Offset + nWritten;
782 if (newused >= Buf->BufSize) {
783 if (IncreaseBuf(Buf, 1, newused) == -1)
784 return; /* TODO: error handling? */
785 newused = Buf->BufSize + 1;
788 Buf->BufUsed = Offset + nWritten;
789 BufSize = Buf->BufSize;
796 * @ingroup StrBuf_Filler
797 * @brief sprintf like function appending the formated string to the buffer
798 * @param Buf Buffer to extend by format and Params
799 * @param format printf alike format to add
801 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...)
809 if ((Buf == NULL) || (format == NULL))
812 BufSize = Buf->BufSize;
813 nWritten = Buf->BufSize + 1;
814 Offset = Buf->BufUsed;
815 newused = Offset + nWritten;
817 while (newused >= BufSize) {
818 va_start(arg_ptr, format);
819 nWritten = vsnprintf(Buf->buf + Buf->BufUsed,
820 Buf->BufSize - Buf->BufUsed,
823 newused = Buf->BufUsed + nWritten;
824 if (newused >= Buf->BufSize) {
825 if (IncreaseBuf(Buf, 1, newused) == -1)
826 return; /* TODO: error handling? */
827 newused = Buf->BufSize + 1;
830 Buf->BufUsed += nWritten;
831 BufSize = Buf->BufSize;
838 * @ingroup StrBuf_Filler
839 * @brief sprintf like function putting the formated string into the buffer
840 * @param Buf Buffer to extend by format and Parameters
841 * @param format printf alike format to add
843 void StrBufPrintf(StrBuf *Buf, const char *format, ...)
848 if ((Buf == NULL) || (format == NULL))
851 nWritten = Buf->BufSize + 1;
852 while (nWritten >= Buf->BufSize) {
853 va_start(arg_ptr, format);
854 nWritten = vsnprintf(Buf->buf, Buf->BufSize, format, arg_ptr);
856 if (nWritten >= Buf->BufSize) {
857 if (IncreaseBuf(Buf, 0, 0) == -1)
858 return; /* TODO: error handling? */
859 nWritten = Buf->BufSize + 1;
862 Buf->BufUsed = nWritten ;
867 * @ingroup StrBuf_Filler
868 * @brief Callback for cURL to append the webserver reply to a buffer
869 * @param ptr pre-defined by the cURL API; see man 3 curl for mre info
870 * @param size pre-defined by the cURL API; see man 3 curl for mre info
871 * @param nmemb pre-defined by the cURL API; see man 3 curl for mre info
872 * @param stream pre-defined by the cURL API; see man 3 curl for mre info
874 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream)
883 StrBufAppendBufPlain(Target, ptr, size * nmemb, 0);
890 * @brief extracts a substring from Source into dest
891 * @param dest buffer to place substring into
892 * @param Source string to copy substring from
893 * @param Offset chars to skip from start
894 * @param nChars number of chars to copy
895 * @returns the number of chars copied; may be different from nChars due to the size of Source
897 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars)
900 if (Offset > Source->BufUsed)
906 if (Offset + nChars < Source->BufUsed)
908 if (nChars >= dest->BufSize)
909 IncreaseBuf(dest, 0, nChars + 1);
910 memcpy(dest->buf, Source->buf + Offset, nChars);
911 dest->BufUsed = nChars;
912 dest->buf[dest->BufUsed] = '\0';
915 NCharsRemain = Source->BufUsed - Offset;
916 if (NCharsRemain >= dest->BufSize)
917 IncreaseBuf(dest, 0, NCharsRemain + 1);
918 memcpy(dest->buf, Source->buf + Offset, NCharsRemain);
919 dest->BufUsed = NCharsRemain;
920 dest->buf[dest->BufUsed] = '\0';
926 * @brief Cut nChars from the start of the string
927 * @param Buf Buffer to modify
928 * @param nChars how many chars should be skipped?
930 void StrBufCutLeft(StrBuf *Buf, int nChars)
932 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
933 if (nChars >= Buf->BufUsed) {
937 memmove(Buf->buf, Buf->buf + nChars, Buf->BufUsed - nChars);
938 Buf->BufUsed -= nChars;
939 Buf->buf[Buf->BufUsed] = '\0';
944 * @brief Cut the trailing n Chars from the string
945 * @param Buf Buffer to modify
946 * @param nChars how many chars should be trunkated?
948 void StrBufCutRight(StrBuf *Buf, int nChars)
950 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
951 if (nChars >= Buf->BufUsed) {
955 Buf->BufUsed -= nChars;
956 Buf->buf[Buf->BufUsed] = '\0';
961 * @brief Cut the string after n Chars
962 * @param Buf Buffer to modify
963 * @param AfternChars after how many chars should we trunkate the string?
964 * @param At if non-null and points inside of our string, cut it there.
966 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At)
968 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
970 AfternChars = At - Buf->buf;
973 if ((AfternChars < 0) || (AfternChars >= Buf->BufUsed))
975 Buf->BufUsed = AfternChars;
976 Buf->buf[Buf->BufUsed] = '\0';
982 * @brief Strip leading and trailing spaces from a string; with premeasured and adjusted length.
983 * @param Buf the string to modify
985 void StrBufTrim(StrBuf *Buf)
988 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
990 while ((Buf->BufUsed > 0) &&
991 isspace(Buf->buf[Buf->BufUsed - 1]))
995 Buf->buf[Buf->BufUsed] = '\0';
997 if (Buf->BufUsed == 0) return;
999 while ((Buf->BufUsed > delta) && (isspace(Buf->buf[delta]))){
1002 if (delta > 0) StrBufCutLeft(Buf, delta);
1005 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary)
1013 pLeft = pBuff = Buf->buf;
1014 while (pBuff != NULL) {
1016 pBuff = strchr(pBuff, leftboundary);
1025 pRight = strchr(pBuff, rightboundary);
1027 StrBufCutAt(Buf, 0, pRight);
1029 StrBufCutLeft(Buf, pLeft - Buf->buf);
1034 * @ingroup StrBuf_Filler
1035 * @brief uppercase the contents of a buffer
1036 * @param Buf the buffer to translate
1038 void StrBufUpCase(StrBuf *Buf)
1042 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1045 pche = pch + Buf->BufUsed;
1046 while (pch < pche) {
1047 *pch = toupper(*pch);
1054 * @ingroup StrBuf_Filler
1055 * @brief lowercase the contents of a buffer
1056 * @param Buf the buffer to translate
1058 void StrBufLowerCase(StrBuf *Buf)
1062 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1065 pche = pch + Buf->BufUsed;
1066 while (pch < pche) {
1067 *pch = tolower(*pch);
1073 /*******************************************************************************
1074 * a tokenizer that kills, maims, and destroys *
1075 *******************************************************************************/
1078 * @ingroup StrBuf_Tokenizer
1079 * @brief Replace a token at a given place with a given length by another token with given length
1080 * @param Buf String where to work on
1081 * @param where where inside of the Buf is the search-token
1082 * @param HowLong How long is the token to be replaced
1083 * @param Repl Token to insert at 'where'
1084 * @param ReplLen Length of repl
1085 * @returns -1 if fail else length of resulting Buf
1087 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong,
1088 const char *Repl, long ReplLen)
1091 if ((Buf == NULL) ||
1092 (where > Buf->BufUsed) ||
1093 (where + HowLong > Buf->BufUsed))
1096 if (where + ReplLen - HowLong > Buf->BufSize)
1097 if (IncreaseBuf(Buf, 1, Buf->BufUsed + ReplLen) < 0)
1100 memmove(Buf->buf + where + ReplLen,
1101 Buf->buf + where + HowLong,
1102 Buf->BufUsed - where - HowLong);
1104 memcpy(Buf->buf + where,
1107 Buf->BufUsed += ReplLen - HowLong;
1109 return Buf->BufUsed;
1113 * @ingroup StrBuf_Tokenizer
1114 * @brief Counts the numbmer of tokens in a buffer
1115 * @param source String to count tokens in
1116 * @param tok Tokenizer char to count
1117 * @returns numbers of tokenizer chars found
1119 int StrBufNum_tokens(const StrBuf *source, char tok)
1123 if ((source == NULL) || (source->BufUsed == 0))
1125 if ((source->BufUsed == 1) && (*source->buf == tok))
1129 pche = pch + source->BufUsed;
1140 * @ingroup StrBuf_Tokenizer
1141 * @brief a string tokenizer
1142 * @param Source StringBuffer to read into
1143 * @param parmnum n'th Parameter to remove
1144 * @param separator tokenizer character
1145 * @returns -1 if not found, else length of token.
1147 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator)
1150 char *d, *s, *end; /* dest, source */
1153 /* Find desired @parameter */
1154 end = Source->buf + Source->BufUsed;
1156 while ((d <= end) &&
1159 /* End of string, bail! */
1164 if (*d == separator) {
1169 if ((d == NULL) || (d >= end))
1170 return 0; /* @Parameter not found */
1172 /* Find next @parameter */
1174 while ((s <= end) &&
1175 (*s && *s != separator))
1179 if (*s == separator)
1183 /* Hack and slash */
1188 memmove(d, s, Source->BufUsed - (s - Source->buf));
1189 Source->BufUsed += ReducedBy;
1190 Source->buf[Source->BufUsed] = '\0';
1192 else if (d == Source->buf) {
1194 Source->BufUsed = 0;
1198 Source->BufUsed += ReducedBy;
1211 * @ingroup StrBuf_Tokenizer
1212 * @brief a string tokenizer
1213 * @param dest Destination StringBuffer
1214 * @param Source StringBuffer to read into
1215 * @param parmnum n'th Parameter to extract
1216 * @param separator tokenizer character
1217 * @returns -1 if not found, else length of token.
1219 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator)
1221 const char *s, *e; //* source * /
1222 int len = 0; //* running total length of extracted string * /
1223 int current_token = 0; //* token currently being processed * /
1226 dest->buf[0] = '\0';
1232 if ((Source == NULL) || (Source->BufUsed ==0)) {
1236 e = s + Source->BufUsed;
1239 //lprintf (CTDL_DEBUG, "test >: n: %d sep: %c source: %s \n willi \n", parmnum, separator, source);
1241 while ((s < e) && !IsEmptyStr(s)) {
1242 if (*s == separator) {
1245 if (len >= dest->BufSize) {
1246 dest->BufUsed = len;
1247 if (IncreaseBuf(dest, 1, -1) < 0) {
1252 if ( (current_token == parmnum) &&
1253 (*s != separator)) {
1254 dest->buf[len] = *s;
1257 else if (current_token > parmnum) {
1263 dest->buf[len] = '\0';
1264 dest->BufUsed = len;
1266 if (current_token < parmnum) {
1267 //lprintf (CTDL_DEBUG,"test <!: %s\n", dest);
1270 //lprintf (CTDL_DEBUG,"test <: %d; %s\n", len, dest);
1279 * @ingroup StrBuf_Tokenizer
1280 * @brief a string tokenizer to fetch an integer
1281 * @param Source String containing tokens
1282 * @param parmnum n'th Parameter to extract
1283 * @param separator tokenizer character
1284 * @returns 0 if not found, else integer representation of the token
1286 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator)
1296 if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0)
1303 * @ingroup StrBuf_Tokenizer
1304 * @brief a string tokenizer to fetch a long integer
1305 * @param Source String containing tokens
1306 * @param parmnum n'th Parameter to extract
1307 * @param separator tokenizer character
1308 * @returns 0 if not found, else long integer representation of the token
1310 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator)
1320 if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0)
1328 * @ingroup StrBuf_Tokenizer
1329 * @brief a string tokenizer to fetch an unsigned long
1330 * @param Source String containing tokens
1331 * @param parmnum n'th Parameter to extract
1332 * @param separator tokenizer character
1333 * @returns 0 if not found, else unsigned long representation of the token
1335 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator)
1346 if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0) {
1350 return (unsigned long) atol(pnum);
1359 * @ingroup StrBuf_NextTokenizer
1360 * @brief a string tokenizer; Bounds checker
1361 * function to make shure whether StrBufExtract_NextToken and friends have reached the end of the string.
1362 * @param Source our tokenbuffer
1363 * @param pStart the token iterator pointer to inspect
1364 * @returns whether the revolving pointer is inside of the search range
1366 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart)
1368 if ((Source == NULL) ||
1369 (*pStart == StrBufNOTNULL) ||
1370 (Source->BufUsed == 0))
1374 if (*pStart == NULL)
1378 else if (*pStart > Source->buf + Source->BufUsed)
1382 else if (*pStart <= Source->buf)
1391 * @ingroup StrBuf_NextTokenizer
1392 * @brief a string tokenizer
1393 * @param dest Destination StringBuffer
1394 * @param Source StringBuffer to read into
1395 * @param pStart pointer to the end of the last token. Feed with NULL on start.
1396 * @param separator tokenizer
1397 * @returns -1 if not found, else length of token.
1399 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator)
1401 const char *s; /* source */
1402 const char *EndBuffer; /* end stop of source buffer */
1403 int current_token = 0; /* token currently being processed */
1404 int len = 0; /* running total length of extracted string */
1406 if ((Source == NULL) ||
1407 (Source->BufUsed == 0) )
1409 *pStart = StrBufNOTNULL;
1413 EndBuffer = Source->buf + Source->BufUsed;
1417 dest->buf[0] = '\0';
1422 *pStart = EndBuffer + 1;
1426 if (*pStart == NULL)
1428 *pStart = Source->buf; /* we're starting to examine this buffer. */
1430 else if ((*pStart < Source->buf) ||
1431 (*pStart > EndBuffer ) )
1433 return -1; /* no more tokens to find. */
1437 /* start to find the next token */
1438 while ((s <= EndBuffer) &&
1439 (current_token == 0) )
1441 if (*s == separator)
1443 /* we found the next token */
1447 if (len >= dest->BufSize)
1449 /* our Dest-buffer isn't big enough, increase it. */
1450 dest->BufUsed = len;
1452 if (IncreaseBuf(dest, 1, -1) < 0) {
1453 /* WHUT? no more mem? bail out. */
1460 if ( (current_token == 0 ) && /* are we in our target token? */
1461 (!IsEmptyStr(s) ) &&
1462 (separator != *s) ) /* don't copy the token itself */
1464 dest->buf[len] = *s; /* Copy the payload */
1465 ++len; /* remember the bigger size. */
1471 /* did we reach the end? */
1472 if ((s > EndBuffer)) {
1473 EndBuffer = StrBufNOTNULL;
1474 *pStart = EndBuffer;
1477 *pStart = s; /* remember the position for the next run */
1480 /* sanitize our extracted token */
1481 dest->buf[len] = '\0';
1482 dest->BufUsed = len;
1489 * @ingroup StrBuf_NextTokenizer
1490 * @brief a string tokenizer
1491 * @param Source StringBuffer to read from
1492 * @param pStart pointer to the end of the last token. Feed with NULL.
1493 * @param separator tokenizer character
1494 * @param nTokens number of tokens to fastforward over
1495 * @returns -1 if not found, else length of token.
1497 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens)
1499 const char *s, *EndBuffer; //* source * /
1500 int len = 0; //* running total length of extracted string * /
1501 int current_token = 0; //* token currently being processed * /
1503 if ((Source == NULL) ||
1504 (Source->BufUsed ==0)) {
1508 return Source->BufUsed;
1510 if (*pStart == NULL)
1511 *pStart = Source->buf;
1513 EndBuffer = Source->buf + Source->BufUsed;
1515 if ((*pStart < Source->buf) ||
1516 (*pStart > EndBuffer)) {
1524 //lprintf (CTDL_DEBUG, "test >: n: %d sep: %c source: %s \n willi \n", parmnum, separator, source);
1526 while ((s < EndBuffer) && !IsEmptyStr(s)) {
1527 if (*s == separator) {
1530 if (current_token >= nTokens) {
1542 * @ingroup StrBuf_NextTokenizer
1543 * @brief a string tokenizer to fetch an integer
1544 * @param Source StringBuffer to read from
1545 * @param pStart Cursor on the tokenstring
1546 * @param separator tokenizer character
1547 * @returns 0 if not found, else integer representation of the token
1549 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator)
1559 if (StrBufExtract_NextToken(&tmp, Source, pStart, separator) > 0)
1566 * @ingroup StrBuf_NextTokenizer
1567 * @brief a string tokenizer to fetch a long integer
1568 * @param Source StringBuffer to read from
1569 * @param pStart Cursor on the tokenstring
1570 * @param separator tokenizer character
1571 * @returns 0 if not found, else long integer representation of the token
1573 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator)
1583 if (StrBufExtract_NextToken(&tmp, Source, pStart, separator) > 0)
1591 * @ingroup StrBuf_NextTokenizer
1592 * @brief a string tokenizer to fetch an unsigned long
1593 * @param Source StringBuffer to read from
1594 * @param pStart Cursor on the tokenstring
1595 * @param separator tokenizer character
1596 * @returns 0 if not found, else unsigned long representation of the token
1598 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator)
1609 if (StrBufExtract_NextToken(&tmp, Source, pStart, separator) > 0) {
1613 return (unsigned long) atol(pnum);
1623 /*******************************************************************************
1624 * Escape Appending *
1625 *******************************************************************************/
1628 * @ingroup StrBuf_DeEnCoder
1629 * @brief Escape a string for feeding out as a URL while appending it to a Buffer
1630 * @param OutBuf the output buffer
1631 * @param In Buffer to encode
1632 * @param PlainIn way in from plain old c strings
1634 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn)
1636 const char *pch, *pche;
1640 if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
1642 if (PlainIn != NULL) {
1643 len = strlen(PlainIn);
1649 pche = pch + In->BufUsed;
1656 pt = OutBuf->buf + OutBuf->BufUsed;
1657 pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
1659 while (pch < pche) {
1661 IncreaseBuf(OutBuf, 1, -1);
1662 pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
1663 pt = OutBuf->buf + OutBuf->BufUsed;
1666 if((*pch >= 'a' && *pch <= 'z') ||
1667 (*pch >= '@' && *pch <= 'Z') || /* @ A-Z */
1668 (*pch >= '0' && *pch <= ':') || /* 0-9 : */
1669 (*pch == '!') || (*pch == '_') ||
1670 (*pch == ',') || (*pch == '.'))
1677 *(pt + 1) = HexList[(unsigned char)*pch][0];
1678 *(pt + 2) = HexList[(unsigned char)*pch][1];
1680 OutBuf->BufUsed += 3;
1688 * @ingroup StrBuf_DeEnCoder
1689 * @brief append a string in hex encoding to the buffer
1690 * @param OutBuf the output buffer
1691 * @param In Buffer to encode
1692 * @param PlainIn way in from plain old c strings
1694 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn)
1696 const char *pch, *pche;
1700 if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
1702 if (PlainIn != NULL) {
1703 len = strlen(PlainIn);
1709 pche = pch + In->BufUsed;
1716 pt = OutBuf->buf + OutBuf->BufUsed;
1717 pte = OutBuf->buf + OutBuf->BufSize - 3; /**< we max append 3 chars at once plus the \0 */
1719 while (pch < pche) {
1721 IncreaseBuf(OutBuf, 1, -1);
1722 pte = OutBuf->buf + OutBuf->BufSize - 3; /**< we max append 3 chars at once plus the \0 */
1723 pt = OutBuf->buf + OutBuf->BufUsed;
1726 *pt = HexList[(unsigned char)*pch][0];
1728 *pt = HexList[(unsigned char)*pch][1];
1729 pt ++; pch ++; OutBuf->BufUsed += 2;
1735 * @ingroup StrBuf_DeEnCoder
1736 * @brief Append a string, escaping characters which have meaning in HTML.
1738 * @param Target target buffer
1739 * @param Source source buffer; set to NULL if you just have a C-String
1740 * @param PlainIn Plain-C string to append; set to NULL if unused
1741 * @param nbsp If nonzero, spaces are converted to non-breaking spaces.
1742 * @param nolinebreaks if set to 1, linebreaks are removed from the string.
1743 * if set to 2, linebreaks are replaced by <br/>
1745 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks)
1747 const char *aptr, *eiptr;
1751 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
1754 if (PlainIn != NULL) {
1756 len = strlen(PlainIn);
1761 eiptr = aptr + Source->BufUsed;
1762 len = Source->BufUsed;
1768 bptr = Target->buf + Target->BufUsed;
1769 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
1771 while (aptr < eiptr){
1773 IncreaseBuf(Target, 1, -1);
1774 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
1775 bptr = Target->buf + Target->BufUsed;
1778 memcpy(bptr, "<", 4);
1780 Target->BufUsed += 4;
1782 else if (*aptr == '>') {
1783 memcpy(bptr, ">", 4);
1785 Target->BufUsed += 4;
1787 else if (*aptr == '&') {
1788 memcpy(bptr, "&", 5);
1790 Target->BufUsed += 5;
1792 else if (*aptr == '"') {
1793 memcpy(bptr, """, 6);
1795 Target->BufUsed += 6;
1797 else if (*aptr == '\'') {
1798 memcpy(bptr, "'", 5);
1800 Target->BufUsed += 5;
1802 else if (*aptr == LB) {
1807 else if (*aptr == RB) {
1812 else if (*aptr == QU) {
1817 else if ((*aptr == 32) && (nbsp == 1)) {
1818 memcpy(bptr, " ", 6);
1820 Target->BufUsed += 6;
1822 else if ((*aptr == '\n') && (nolinebreaks == 1)) {
1823 *bptr='\0'; /* nothing */
1825 else if ((*aptr == '\n') && (nolinebreaks == 2)) {
1826 memcpy(bptr, "<br/>", 11);
1828 Target->BufUsed += 11;
1832 else if ((*aptr == '\r') && (nolinebreaks != 0)) {
1833 *bptr='\0'; /* nothing */
1843 if ((bptr = eptr - 1 ) && !IsEmptyStr(aptr) )
1845 return Target->BufUsed;
1849 * @ingroup StrBuf_DeEnCoder
1850 * @brief Append a string, escaping characters which have meaning in HTML.
1851 * Converts linebreaks into blanks; escapes single quotes
1852 * @param Target target buffer
1853 * @param Source source buffer; set to NULL if you just have a C-String
1854 * @param PlainIn Plain-C string to append; set to NULL if unused
1856 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn)
1858 const char *aptr, *eiptr;
1862 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
1865 if (PlainIn != NULL) {
1867 len = strlen(PlainIn);
1872 eiptr = aptr + Source->BufUsed;
1873 len = Source->BufUsed;
1879 eptr = Target->buf + Target->BufSize - 8;
1880 tptr = Target->buf + Target->BufUsed;
1882 while (aptr < eiptr){
1884 IncreaseBuf(Target, 1, -1);
1885 eptr = Target->buf + Target->BufSize - 8;
1886 tptr = Target->buf + Target->BufUsed;
1889 if (*aptr == '\n') {
1893 else if (*aptr == '\r') {
1897 else if (*aptr == '\'') {
1903 Target->BufUsed += 5;
1916 * @ingroup StrBuf_DeEnCoder
1917 * @brief Append a string, escaping characters which have meaning in ICAL.
1919 * @param Target target buffer
1920 * @param Source source buffer; set to NULL if you just have a C-String
1921 * @param PlainIn Plain-C string to append; set to NULL if unused
1923 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn)
1925 const char *aptr, *eiptr;
1929 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
1932 if (PlainIn != NULL) {
1934 len = strlen(PlainIn);
1939 eiptr = aptr + Source->BufUsed;
1940 len = Source->BufUsed;
1946 eptr = Target->buf + Target->BufSize - 8;
1947 tptr = Target->buf + Target->BufUsed;
1949 while (aptr < eiptr){
1950 if(tptr + 3 >= eptr) {
1951 IncreaseBuf(Target, 1, -1);
1952 eptr = Target->buf + Target->BufSize - 8;
1953 tptr = Target->buf + Target->BufUsed;
1956 if (*aptr == '\n') {
1963 else if (*aptr == '\r') {
1970 else if (*aptr == ',') {
1986 * @ingroup StrBuf_DeEnCoder
1987 * @brief Append a string, escaping characters which have meaning in JavaScript strings .
1989 * @param Target target buffer
1990 * @param Source source buffer; set to NULL if you just have a C-String
1991 * @param PlainIn Plain-C string to append; set to NULL if unused
1992 * @returns size of result or -1
1994 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn)
1996 const char *aptr, *eiptr;
2000 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2003 if (PlainIn != NULL) {
2005 len = strlen(PlainIn);
2010 eiptr = aptr + Source->BufUsed;
2011 len = Source->BufUsed;
2017 bptr = Target->buf + Target->BufUsed;
2018 eptr = Target->buf + Target->BufSize - 3; /* our biggest unit to put in... */
2020 while (aptr < eiptr){
2022 IncreaseBuf(Target, 1, -1);
2023 eptr = Target->buf + Target->BufSize - 3;
2024 bptr = Target->buf + Target->BufUsed;
2031 Target->BufUsed += 2;
2032 } else if (*aptr == '\\') {
2037 Target->BufUsed += 2;
2047 if ((bptr == eptr - 1 ) && !IsEmptyStr(aptr) )
2049 return Target->BufUsed;
2053 * @ingroup StrBuf_DeEnCoder
2054 * @brief Append a string, escaping characters which have meaning in HTML + json.
2056 * @param Target target buffer
2057 * @param Source source buffer; set to NULL if you just have a C-String
2058 * @param PlainIn Plain-C string to append; set to NULL if unused
2059 * @param nbsp If nonzero, spaces are converted to non-breaking spaces.
2060 * @param nolinebreaks if set to 1, linebreaks are removed from the string.
2061 * if set to 2, linebreaks are replaced by <br/>
2063 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks)
2065 const char *aptr, *eiptr;
2068 int IsUtf8Sequence = 0;
2070 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2073 if (PlainIn != NULL) {
2075 len = strlen(PlainIn);
2080 eiptr = aptr + Source->BufUsed;
2081 len = Source->BufUsed;
2087 bptr = Target->buf + Target->BufUsed;
2088 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
2090 while (aptr < eiptr){
2092 IncreaseBuf(Target, 1, -1);
2093 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
2094 bptr = Target->buf + Target->BufUsed;
2097 memcpy(bptr, "<", 4);
2099 Target->BufUsed += 4;
2101 else if (*aptr == '>') {
2102 memcpy(bptr, ">", 4);
2104 Target->BufUsed += 4;
2106 else if (*aptr == '&') {
2107 memcpy(bptr, "&", 5);
2109 Target->BufUsed += 5;
2111 else if (*aptr == LB) {
2116 else if (*aptr == RB) {
2121 else if ((*aptr == 32) && (nbsp == 1)) {
2122 memcpy(bptr, " ", 6);
2124 Target->BufUsed += 6;
2126 else if ((*aptr == '\n') && (nolinebreaks == 1)) {
2127 *bptr='\0'; /* nothing */
2129 else if ((*aptr == '\n') && (nolinebreaks == 2)) {
2130 memcpy(bptr, "<br/>", 11);
2132 Target->BufUsed += 11;
2135 else if ((*aptr == '\r') && (nolinebreaks != 0)) {
2136 *bptr='\0'; /* nothing */
2139 else if ((*aptr == '"') || (*aptr == QU)) {
2144 Target->BufUsed += 2;
2145 } else if (*aptr == '\\') {
2150 Target->BufUsed += 2;
2153 if (((unsigned char)*aptr) >= 0x20)
2155 IsUtf8Sequence = Ctdl_GetUtf8SequenceLength(aptr, eiptr);
2159 if (IsUtf8Sequence > 1) while (IsUtf8Sequence > 0){
2160 if(bptr + IsUtf8Sequence >= eptr) {
2161 IncreaseBuf(Target, 1, -1);
2162 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
2163 bptr = Target->buf + Target->BufUsed - 1;
2177 if ((bptr = eptr - 1 ) && !IsEmptyStr(aptr) )
2179 return Target->BufUsed;
2183 * @ingroup StrBuf_DeEnCoder
2184 * @brief unhide special chars hidden to the HTML escaper
2185 * @param target buffer to put the unescaped string in
2186 * @param source buffer to unescape
2188 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source)
2194 FlushStrBuf(target);
2196 if (source == NULL ||target == NULL)
2201 len = source->BufUsed;
2202 for (a = 0; a < len; ++a) {
2203 if (target->BufUsed >= target->BufSize)
2204 IncreaseBuf(target, 1, -1);
2206 if (source->buf[a] == '=') {
2207 hex[0] = source->buf[a + 1];
2208 hex[1] = source->buf[a + 2];
2211 sscanf(hex, "%02x", &b);
2212 target->buf[target->BufUsed] = b;
2213 target->buf[++target->BufUsed] = 0;
2217 target->buf[target->BufUsed] = source->buf[a];
2218 target->buf[++target->BufUsed] = 0;
2225 * @ingroup StrBuf_DeEnCoder
2226 * @brief hide special chars from the HTML escapers and friends
2227 * @param target buffer to put the escaped string in
2228 * @param source buffer to escape
2230 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source)
2235 FlushStrBuf(target);
2237 if (source == NULL ||target == NULL)
2242 len = source->BufUsed;
2243 for (i=0; i<len; ++i) {
2244 if (target->BufUsed + 4 >= target->BufSize)
2245 IncreaseBuf(target, 1, -1);
2246 if ( (isalnum(source->buf[i])) ||
2247 (source->buf[i]=='-') ||
2248 (source->buf[i]=='_') ) {
2249 target->buf[target->BufUsed++] = source->buf[i];
2252 sprintf(&target->buf[target->BufUsed],
2254 (0xFF &source->buf[i]));
2255 target->BufUsed += 3;
2258 target->buf[target->BufUsed + 1] = '\0';
2262 /*******************************************************************************
2263 * Quoted Printable de/encoding *
2264 *******************************************************************************/
2267 * @ingroup StrBuf_DeEnCoder
2268 * @brief decode a buffer from base 64 encoding; destroys original
2269 * @param Buf Buffor to transform
2271 int StrBufDecodeBase64(StrBuf *Buf)
2275 if (Buf == NULL) return -1;
2277 xferbuf = (char*) malloc(Buf->BufSize);
2279 siz = CtdlDecodeBase64(xferbuf,
2289 * @ingroup StrBuf_DeEnCoder
2290 * @brief decode a buffer from base 64 encoding; destroys original
2291 * @param Buf Buffor to transform
2293 int StrBufDecodeHex(StrBuf *Buf)
2296 char *pch, *pche, *pchi;
2298 if (Buf == NULL) return -1;
2300 pch = pchi = Buf->buf;
2301 pche = pch + Buf->BufUsed;
2303 while (pchi < pche){
2304 ch = decode_hex(pchi);
2311 Buf->BufUsed = pch - Buf->buf;
2312 return Buf->BufUsed;
2316 * @ingroup StrBuf_DeEnCoder
2317 * @brief replace all chars >0x20 && < 0x7F with Mute
2318 * @param Mute char to put over invalid chars
2319 * @param Buf Buffor to transform
2321 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute)
2325 if (Buf == NULL) return -1;
2326 pch = (unsigned char *)Buf->buf;
2327 while (pch < (unsigned char *)Buf->buf + Buf->BufUsed) {
2328 if ((*pch < 0x20) || (*pch > 0x7F))
2332 return Buf->BufUsed;
2337 * @ingroup StrBuf_DeEnCoder
2338 * @brief remove escaped strings from i.e. the url string (like %20 for blanks)
2339 * @param Buf Buffer to translate
2340 * @param StripBlanks Reduce several blanks to one?
2342 long StrBufUnescape(StrBuf *Buf, int StripBlanks)
2351 while ((Buf->BufUsed > 0) && (isspace(Buf->buf[Buf->BufUsed - 1]))){
2352 Buf->buf[Buf->BufUsed - 1] = '\0';
2357 while (a < Buf->BufUsed) {
2358 if (Buf->buf[a] == '+')
2360 else if (Buf->buf[a] == '%') {
2361 /* don't let % chars through, rather truncate the input. */
2362 if (a + 2 > Buf->BufUsed) {
2367 hex[0] = Buf->buf[a + 1];
2368 hex[1] = Buf->buf[a + 2];
2371 sscanf(hex, "%02x", &b);
2372 Buf->buf[a] = (char) b;
2373 len = Buf->BufUsed - a - 2;
2375 memmove(&Buf->buf[a + 1], &Buf->buf[a + 3], len);
2387 * @ingroup StrBuf_DeEnCoder
2388 * @brief RFC2047-encode a header field if necessary.
2389 * If no non-ASCII characters are found, the string
2390 * will be copied verbatim without encoding.
2392 * @param target Target buffer.
2393 * @param source Source string to be encoded.
2394 * @returns encoded length; -1 if non success.
2396 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source)
2398 const char headerStr[] = "=?UTF-8?Q?";
2399 int need_to_encode = 0;
2403 if ((source == NULL) ||
2407 while ((i < source->BufUsed) &&
2408 (!IsEmptyStr (&source->buf[i])) &&
2409 (need_to_encode == 0)) {
2410 if (((unsigned char) source->buf[i] < 32) ||
2411 ((unsigned char) source->buf[i] > 126)) {
2417 if (!need_to_encode) {
2418 if (*target == NULL) {
2419 *target = NewStrBufPlain(source->buf, source->BufUsed);
2422 FlushStrBuf(*target);
2423 StrBufAppendBuf(*target, source, 0);
2425 return (*target)->BufUsed;
2427 if (*target == NULL)
2428 *target = NewStrBufPlain(NULL, sizeof(headerStr) + source->BufUsed * 2);
2429 else if (sizeof(headerStr) + source->BufUsed >= (*target)->BufSize)
2430 IncreaseBuf(*target, sizeof(headerStr) + source->BufUsed, 0);
2431 memcpy ((*target)->buf, headerStr, sizeof(headerStr) - 1);
2432 (*target)->BufUsed = sizeof(headerStr) - 1;
2433 for (i=0; (i < source->BufUsed); ++i) {
2434 if ((*target)->BufUsed + 4 >= (*target)->BufSize)
2435 IncreaseBuf(*target, 1, 0);
2436 ch = (unsigned char) source->buf[i];
2443 sprintf(&(*target)->buf[(*target)->BufUsed], "=%02X", ch);
2444 (*target)->BufUsed += 3;
2447 (*target)->buf[(*target)->BufUsed] = ch;
2448 (*target)->BufUsed++;
2452 if ((*target)->BufUsed + 4 >= (*target)->BufSize)
2453 IncreaseBuf(*target, 1, 0);
2455 (*target)->buf[(*target)->BufUsed++] = '?';
2456 (*target)->buf[(*target)->BufUsed++] = '=';
2457 (*target)->buf[(*target)->BufUsed] = '\0';
2458 return (*target)->BufUsed;;
2463 static void AddRecipient(StrBuf *Target,
2465 StrBuf *EmailAddress,
2470 if (StrLength(Target) > 0) StrBufAppendBufPlain(Target, HKEY(", "), 0);
2471 if (strchr(ChrPtr(UserName), ',') != NULL) QuoteMe = 1;
2473 if (QuoteMe) StrBufAppendBufPlain(Target, HKEY("\""), 0);
2474 StrBufRFC2047encode(&EncBuf, UserName);
2475 StrBufAppendBuf(Target, EncBuf, 0);
2476 if (QuoteMe) StrBufAppendBufPlain(Target, HKEY("\" "), 0);
2477 else StrBufAppendBufPlain(Target, HKEY(" "), 0);
2479 if (StrLength(EmailAddress) > 0){
2480 StrBufAppendBufPlain(Target, HKEY("<"), 0);
2481 StrBufAppendBuf(Target, EmailAddress, 0); /* TODO: what about IDN???? */
2482 StrBufAppendBufPlain(Target, HKEY(">"), 0);
2488 * \brief QP encode parts of an email TO/CC/BCC vector, and strip/filter invalid parts
2489 * \param Recp Source list of email recipients
2490 * \param UserName Temporary buffer for internal use; Please provide valid buffer.
2491 * \param EmailAddress Temporary buffer for internal use; Please provide valid buffer.
2492 * \param EncBuf Temporary buffer for internal use; Please provide valid buffer.
2493 * \returns encoded & sanitized buffer with the contents of Recp; Caller owns this memory.
2495 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
2497 StrBuf *EmailAddress,
2503 const char *pch, *pche;
2504 const char *UserStart, *UserEnd, *EmailStart, *EmailEnd, *At;
2506 if ((Recp == NULL) || (StrLength(Recp) == 0))
2511 pche = pch + StrLength(Recp);
2513 if (!CheckEncode(pch, -1, pche))
2514 return NewStrBufDup(Recp);
2516 Target = NewStrBufPlain(NULL, StrLength(Recp));
2518 while ((pch != NULL) && (pch < pche))
2522 while (isspace(*pch)) pch++;
2523 UserStart = UserEnd = EmailStart = EmailEnd = NULL;
2525 if ((*pch == '"') || (*pch == '\'')) {
2526 UserStart = pch + 1;
2528 UserEnd = strchr(UserStart, *pch);
2529 if (UserEnd == NULL)
2530 break; ///TODO: Userfeedback??
2531 EmailStart = UserEnd + 1;
2532 while (isspace(*EmailStart))
2534 if (UserEnd == UserStart) {
2535 UserStart = UserEnd = NULL;
2538 if (*EmailStart == '<') {
2540 EmailEnd = strchr(EmailStart, '>');
2541 if (EmailEnd == NULL)
2542 EmailEnd = strchr(EmailStart, ',');
2546 EmailEnd = strchr(EmailStart, ',');
2548 if (EmailEnd == NULL)
2556 EmailEnd = strchr(UserStart, ',');
2557 if (EmailEnd == NULL) {
2558 EmailEnd = strchr(pch, '>');
2560 if (EmailEnd != NULL) {
2570 while ((EmailEnd > UserStart) && !gt &&
2571 ((*EmailEnd == ',') ||
2572 (*EmailEnd == '>') ||
2573 (isspace(*EmailEnd))))
2575 if (*EmailEnd == '>')
2580 if (EmailEnd == UserStart)
2584 EmailStart = strchr(UserStart, '<');
2585 if ((EmailStart == NULL) || (EmailStart > EmailEnd))
2587 UserEnd = EmailStart;
2589 while ((UserEnd > UserStart) &&
2590 isspace (*(UserEnd - 1)))
2593 if (UserStart >= UserEnd)
2594 UserStart = UserEnd = NULL;
2595 At = strchr(EmailStart, '@');
2597 else { /* this is a local recipient... no domain, just a realname */
2598 EmailStart = UserStart;
2599 At = strchr(EmailStart, '@');
2605 EmailStart = UserStart;
2611 if ((UserStart != NULL) && (UserEnd != NULL))
2612 StrBufPlain(UserName, UserStart, UserEnd - UserStart);
2613 else if ((UserStart != NULL) && (UserEnd == NULL))
2614 StrBufPlain(UserName, UserStart, UserEnd - UserStart);
2616 FlushStrBuf(UserName);
2618 if ((EmailStart != NULL) && (EmailEnd != NULL))
2619 StrBufPlain(EmailAddress, EmailStart, EmailEnd - EmailStart);
2620 else if ((EmailStart != NULL) && (EmailEnd == NULL))
2621 StrBufPlain(EmailAddress, EmailStart, EmailEnd - pche);
2623 FlushStrBuf(EmailAddress);
2625 AddRecipient(Target, UserName, EmailAddress, EncBuf);
2630 if ((pch != NULL) && (*pch == ','))
2632 if (pch != NULL) while (isspace(*pch))
2641 * @brief replaces all occurances of 'search' by 'replace'
2642 * @param buf Buffer to modify
2643 * @param search character to search
2644 * @param replace character to replace search by
2646 void StrBufReplaceChars(StrBuf *buf, char search, char replace)
2651 for (i=0; i<buf->BufUsed; i++)
2652 if (buf->buf[i] == search)
2653 buf->buf[i] = replace;
2659 * @brief removes all \r s from the string, or replaces them with \n if its not a combination of both.
2660 * @param buf Buffer to modify
2662 void StrBufToUnixLF(StrBuf *buf)
2664 char *pche, *pchS, *pchT;
2668 pche = buf->buf + buf->BufUsed;
2669 pchS = pchT = buf->buf;
2675 if (*pchS != '\n') {
2684 buf->BufUsed = pchT - buf->buf;
2688 /*******************************************************************************
2689 * Iconv Wrapper; RFC822 de/encoding *
2690 *******************************************************************************/
2693 * @ingroup StrBuf_DeEnCoder
2694 * @brief Wrapper around iconv_open()
2695 * Our version adds aliases for non-standard Microsoft charsets
2696 * such as 'MS950', aliasing them to names like 'CP950'
2698 * @param tocode Target encoding
2699 * @param fromcode Source encoding
2700 * @param pic anonimized pointer to iconv struct
2702 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic)
2705 iconv_t ic = (iconv_t)(-1) ;
2706 ic = iconv_open(tocode, fromcode);
2707 if (ic == (iconv_t)(-1) ) {
2708 char alias_fromcode[64];
2709 if ( (strlen(fromcode) == 5) && (!strncasecmp(fromcode, "MS", 2)) ) {
2710 safestrncpy(alias_fromcode, fromcode, sizeof alias_fromcode);
2711 alias_fromcode[0] = 'C';
2712 alias_fromcode[1] = 'P';
2713 ic = iconv_open(tocode, alias_fromcode);
2716 *(iconv_t *)pic = ic;
2722 * @ingroup StrBuf_DeEnCoder
2723 * @brief find one chunk of a RFC822 encoded string
2724 * @param Buffer where to search
2725 * @param bptr where to start searching
2726 * @returns found position, NULL if none.
2728 static inline const char *FindNextEnd (const StrBuf *Buf, const char *bptr)
2731 /* Find the next ?Q? */
2732 if (Buf->BufUsed - (bptr - Buf->buf) < 6)
2735 end = strchr(bptr + 2, '?');
2740 if ((Buf->BufUsed - (end - Buf->buf) > 3) &&
2741 ((*(end + 1) == 'B') || (*(end + 1) == 'Q')) &&
2742 (*(end + 2) == '?')) {
2743 /* skip on to the end of the cluster, the next ?= */
2744 end = strstr(end + 3, "?=");
2747 /* sort of half valid encoding, try to find an end. */
2748 end = strstr(bptr, "?=");
2754 * @brief swaps the contents of two StrBufs
2755 * this is to be used to have cheap switched between a work-buffer and a target buffer
2756 * @param A First one
2757 * @param B second one
2759 static inline void SwapBuffers(StrBuf *A, StrBuf *B)
2763 memcpy(&C, A, sizeof(*A));
2764 memcpy(A, B, sizeof(*B));
2765 memcpy(B, &C, sizeof(C));
2771 * @ingroup StrBuf_DeEnCoder
2772 * @brief convert one buffer according to the preselected iconv pointer PIC
2773 * @param ConvertBuf buffer we need to translate
2774 * @param TmpBuf To share a workbuffer over several iterations. prepare to have it filled with useless stuff afterwards.
2775 * @param pic Pointer to the iconv-session Object
2777 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic)
2783 char *ibuf; /**< Buffer of characters to be converted */
2784 char *obuf; /**< Buffer for converted characters */
2785 size_t ibuflen; /**< Length of input buffer */
2786 size_t obuflen; /**< Length of output buffer */
2789 /* since we're converting to utf-8, one glyph may take up to 6 bytes */
2790 if (ConvertBuf->BufUsed * 6 >= TmpBuf->BufSize)
2791 IncreaseBuf(TmpBuf, 0, ConvertBuf->BufUsed * 6);
2793 ic = *(iconv_t*)pic;
2794 ibuf = ConvertBuf->buf;
2795 ibuflen = ConvertBuf->BufUsed;
2797 obuflen = TmpBuf->BufSize;
2799 siz = iconv(ic, &ibuf, &ibuflen, &obuf, &obuflen);
2802 if (errno == E2BIG) {
2804 IncreaseBuf(TmpBuf, 0, 0);
2809 else if (errno == EILSEQ){
2810 /* hm, invalid utf8 sequence... what to do now? */
2811 /* An invalid multibyte sequence has been encountered in the input */
2813 else if (errno == EINVAL) {
2814 /* An incomplete multibyte sequence has been encountered in the input. */
2817 FlushStrBuf(TmpBuf);
2820 TmpBuf->BufUsed = TmpBuf->BufSize - obuflen;
2821 TmpBuf->buf[TmpBuf->BufUsed] = '\0';
2823 /* little card game: wheres the red lady? */
2824 SwapBuffers(ConvertBuf, TmpBuf);
2825 FlushStrBuf(TmpBuf);
2832 * @ingroup StrBuf_DeEnCoder
2833 * @brief catches one RFC822 encoded segment, and decodes it.
2834 * @param Target buffer to fill with result
2835 * @param DecodeMe buffer with stuff to process
2836 * @param SegmentStart points to our current segment in DecodeMe
2837 * @param SegmentEnd Points to the end of our current segment in DecodeMe
2838 * @param ConvertBuf Workbuffer shared between several iterations. Random content; needs to be valid
2839 * @param ConvertBuf2 Workbuffer shared between several iterations. Random content; needs to be valid
2840 * @param FoundCharset Characterset to default decoding to; if we find another we will overwrite it.
2842 inline static void DecodeSegment(StrBuf *Target,
2843 const StrBuf *DecodeMe,
2844 const char *SegmentStart,
2845 const char *SegmentEnd,
2847 StrBuf *ConvertBuf2,
2848 StrBuf *FoundCharset)
2854 iconv_t ic = (iconv_t)(-1);
2858 /* Now we handle foreign character sets properly encoded
2859 * in RFC2047 format.
2861 StaticBuf.buf = (char*) SegmentStart; /*< it will just be read there... */
2862 StaticBuf.BufUsed = SegmentEnd - SegmentStart;
2863 StaticBuf.BufSize = DecodeMe->BufSize - (SegmentStart - DecodeMe->buf);
2864 extract_token(charset, SegmentStart, 1, '?', sizeof charset);
2865 if (FoundCharset != NULL) {
2866 FlushStrBuf(FoundCharset);
2867 StrBufAppendBufPlain(FoundCharset, charset, -1, 0);
2869 extract_token(encoding, SegmentStart, 2, '?', sizeof encoding);
2870 StrBufExtract_token(ConvertBuf, &StaticBuf, 3, '?');
2872 *encoding = toupper(*encoding);
2873 if (*encoding == 'B') { /**< base64 */
2874 if (ConvertBuf2->BufSize < ConvertBuf->BufUsed)
2875 IncreaseBuf(ConvertBuf2, 0, ConvertBuf->BufUsed);
2876 ConvertBuf2->BufUsed = CtdlDecodeBase64(ConvertBuf2->buf,
2878 ConvertBuf->BufUsed);
2880 else if (*encoding == 'Q') { /**< quoted-printable */
2884 while (pos < ConvertBuf->BufUsed)
2886 if (ConvertBuf->buf[pos] == '_')
2887 ConvertBuf->buf[pos] = ' ';
2891 if (ConvertBuf2->BufSize < ConvertBuf->BufUsed)
2892 IncreaseBuf(ConvertBuf2, 0, ConvertBuf->BufUsed);
2894 ConvertBuf2->BufUsed = CtdlDecodeQuotedPrintable(
2897 ConvertBuf->BufUsed);
2900 StrBufAppendBuf(ConvertBuf2, ConvertBuf, 0);
2903 ctdl_iconv_open("UTF-8", charset, &ic);
2904 if (ic != (iconv_t)(-1) ) {
2906 StrBufConvert(ConvertBuf2, ConvertBuf, &ic);
2907 StrBufAppendBuf(Target, ConvertBuf2, 0);
2912 StrBufAppendBufPlain(Target, HKEY("(unreadable)"), 0);
2918 * @ingroup StrBuf_DeEnCoder
2919 * @brief Handle subjects with RFC2047 encoding such as:
2920 * =?koi8-r?B?78bP0s3Mxc7JxSDXz9rE1dvO2c3JINvB0sHNySDP?=
2921 * @param Target where to put the decoded string to
2922 * @param DecodeMe buffer with encoded string
2923 * @param DefaultCharset if we don't find one, which should we use?
2924 * @param FoundCharset overrides DefaultCharset if non-empty; If we find a charset inside of the string,
2925 * put it here for later use where no string might be known.
2927 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset)
2929 StrBuf *DecodedInvalidBuf = NULL;
2930 StrBuf *ConvertBuf, *ConvertBuf2;
2931 const StrBuf *DecodeMee = DecodeMe;
2932 const char *start, *end, *next, *nextend, *ptr = NULL;
2934 iconv_t ic = (iconv_t)(-1) ;
2939 int illegal_non_rfc2047_encoding = 0;
2941 /* Sometimes, badly formed messages contain strings which were simply
2942 * written out directly in some foreign character set instead of
2943 * using RFC2047 encoding. This is illegal but we will attempt to
2944 * handle it anyway by converting from a user-specified default
2945 * charset to UTF-8 if we see any nonprintable characters.
2948 len = StrLength(DecodeMe);
2949 for (i=0; i<DecodeMe->BufUsed; ++i) {
2950 if ((DecodeMe->buf[i] < 32) || (DecodeMe->buf[i] > 126)) {
2951 illegal_non_rfc2047_encoding = 1;
2956 ConvertBuf = NewStrBufPlain(NULL, StrLength(DecodeMe));
2957 if ((illegal_non_rfc2047_encoding) &&
2958 (strcasecmp(ChrPtr(DefaultCharset), "UTF-8")) &&
2959 (strcasecmp(ChrPtr(DefaultCharset), "us-ascii")) )
2962 ctdl_iconv_open("UTF-8", ChrPtr(DefaultCharset), &ic);
2963 if (ic != (iconv_t)(-1) ) {
2964 DecodedInvalidBuf = NewStrBufDup(DecodeMe);
2965 StrBufConvert(DecodedInvalidBuf, ConvertBuf, &ic);///TODO: don't void const?
2966 DecodeMee = DecodedInvalidBuf;
2972 /* pre evaluate the first pair */
2973 nextend = end = NULL;
2974 len = StrLength(DecodeMee);
2975 start = strstr(DecodeMee->buf, "=?");
2976 eptr = DecodeMee->buf + DecodeMee->BufUsed;
2978 end = FindNextEnd (DecodeMee, start);
2980 StrBufAppendBuf(Target, DecodeMee, 0);
2981 FreeStrBuf(&ConvertBuf);
2982 FreeStrBuf(&DecodedInvalidBuf);
2986 ConvertBuf2 = NewStrBufPlain(NULL, StrLength(DecodeMee));
2988 if (start != DecodeMee->buf) {
2991 nFront = start - DecodeMee->buf;
2992 StrBufAppendBufPlain(Target, DecodeMee->buf, nFront, 0);
2996 * Since spammers will go to all sorts of absurd lengths to get their
2997 * messages through, there are LOTS of corrupt headers out there.
2998 * So, prevent a really badly formed RFC2047 header from throwing
2999 * this function into an infinite loop.
3001 while ((start != NULL) &&
3008 DecodeSegment(Target,
3016 next = strstr(end, "=?");
3018 if ((next != NULL) &&
3020 nextend = FindNextEnd(DecodeMee, next);
3021 if (nextend == NULL)
3024 /* did we find two partitions */
3025 if ((next != NULL) &&
3029 while ((ptr < next) &&
3036 * did we find a gab just filled with blanks?
3037 * if not, copy its stuff over.
3041 StrBufAppendBufPlain(Target,
3047 /* our next-pair is our new first pair now. */
3053 nextend = DecodeMee->buf + DecodeMee->BufUsed;
3054 if ((end != NULL) && (end < nextend)) {
3056 while ( (ptr < nextend) &&
3063 StrBufAppendBufPlain(Target, end, nextend - end, 0);
3065 FreeStrBuf(&ConvertBuf);
3066 FreeStrBuf(&ConvertBuf2);
3067 FreeStrBuf(&DecodedInvalidBuf);
3070 /*******************************************************************************
3071 * Manipulating UTF-8 Strings *
3072 *******************************************************************************/
3076 * @brief evaluate the length of an utf8 special character sequence
3077 * @param Char the character to examine
3078 * @returns width of utf8 chars in bytes
3080 static inline int Ctdl_GetUtf8SequenceLength(const char *CharS, const char *CharE)
3085 while ((n < 8) && ((test & *CharS) != 0)) {
3089 if ((n > 6) || ((CharE - CharS) < n))
3096 * @brief detect whether this char starts an utf-8 encoded char
3097 * @param Char character to inspect
3098 * @returns yes or no
3100 static inline int Ctdl_IsUtf8SequenceStart(const char Char)
3102 /** 11??.???? indicates an UTF8 Sequence. */
3103 return ((Char & 0xC0) != 0);
3108 * @brief measure the number of glyphs in an UTF8 string...
3109 * @param Buf string to measure
3110 * @returns the number of glyphs in Buf
3112 long StrBuf_Utf8StrLen(StrBuf *Buf)
3118 if ((Buf == NULL) || (Buf->BufUsed == 0))
3121 eptr = Buf->buf + Buf->BufUsed;
3122 while ((aptr < eptr) && (*aptr != '\0')) {
3123 if (Ctdl_IsUtf8SequenceStart(*aptr)){
3124 m = Ctdl_GetUtf8SequenceLength(aptr, eptr);
3125 while ((aptr < eptr) && (*aptr++ != '\0')&& (m-- > 0) );
3138 * @brief cuts a string after maxlen glyphs
3139 * @param Buf string to cut to maxlen glyphs
3140 * @param maxlen how long may the string become?
3141 * @returns current length of the string
3143 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen)
3149 eptr = Buf->buf + Buf->BufUsed;
3150 while ((aptr < eptr) && (*aptr != '\0')) {
3151 if (Ctdl_IsUtf8SequenceStart(*aptr)){
3152 m = Ctdl_GetUtf8SequenceLength(aptr, eptr);
3153 while ((*aptr++ != '\0') && (m-- > 0));
3162 Buf->BufUsed = aptr - Buf->buf;
3163 return Buf->BufUsed;
3166 return Buf->BufUsed;
3174 /*******************************************************************************
3176 *******************************************************************************/
3179 #define DEF_MEM_LEVEL 8 /*< memlevel??? */
3180 #define OS_CODE 0x03 /*< unix */
3183 * @ingroup StrBuf_DeEnCoder
3184 * @brief uses the same calling syntax as compress2(), but it
3185 * creates a stream compatible with HTTP "Content-encoding: gzip"
3186 * @param dest compressed buffer
3187 * @param destLen length of the compresed data
3188 * @param source source to encode
3189 * @param sourceLen length of source to encode
3190 * @param level compression level
3192 int ZEXPORT compress_gzip(Bytef * dest,
3194 const Bytef * source,
3198 const int gz_magic[2] = { 0x1f, 0x8b }; /* gzip magic header */
3200 /* write gzip header */
3201 snprintf((char *) dest, *destLen,
3202 "%c%c%c%c%c%c%c%c%c%c",
3203 gz_magic[0], gz_magic[1], Z_DEFLATED,
3204 0 /*flags */ , 0, 0, 0, 0 /*time */ , 0 /* xflags */ ,
3207 /* normal deflate */
3210 stream.next_in = (Bytef *) source;
3211 stream.avail_in = (uInt) sourceLen;
3212 stream.next_out = dest + 10L; // after header
3213 stream.avail_out = (uInt) * destLen;
3214 if ((uLong) stream.avail_out != *destLen)
3217 stream.zalloc = (alloc_func) 0;
3218 stream.zfree = (free_func) 0;
3219 stream.opaque = (voidpf) 0;
3221 err = deflateInit2(&stream, level, Z_DEFLATED, -MAX_WBITS,
3222 DEF_MEM_LEVEL, Z_DEFAULT_STRATEGY);
3226 err = deflate(&stream, Z_FINISH);
3227 if (err != Z_STREAM_END) {
3228 deflateEnd(&stream);
3229 return err == Z_OK ? Z_BUF_ERROR : err;
3231 *destLen = stream.total_out + 10L;
3233 /* write CRC and Length */
3234 uLong crc = crc32(0L, source, sourceLen);
3236 for (n = 0; n < 4; ++n, ++*destLen) {
3237 dest[*destLen] = (int) (crc & 0xff);
3240 uLong len = stream.total_in;
3241 for (n = 0; n < 4; ++n, ++*destLen) {
3242 dest[*destLen] = (int) (len & 0xff);
3245 err = deflateEnd(&stream);
3252 * @ingroup StrBuf_DeEnCoder
3253 * @brief compress the buffer with gzip
3254 * Attention! If you feed this a Const String, you must maintain the uncompressed buffer yourself!
3255 * @param Buf buffer whose content is to be gzipped
3257 int CompressBuffer(StrBuf *Buf)
3260 char *compressed_data = NULL;
3261 size_t compressed_len, bufsize;
3264 bufsize = compressed_len = Buf->BufUsed + (Buf->BufUsed / 100) + 100;
3265 compressed_data = malloc(compressed_len);
3267 if (compressed_data == NULL)
3269 /* Flush some space after the used payload so valgrind shuts up... */
3270 while ((i < 10) && (Buf->BufUsed + i < Buf->BufSize))
3271 Buf->buf[Buf->BufUsed + i++] = '\0';
3272 if (compress_gzip((Bytef *) compressed_data,
3275 (uLongf) Buf->BufUsed, Z_BEST_SPEED) == Z_OK) {
3278 Buf->buf = compressed_data;
3279 Buf->BufUsed = compressed_len;
3280 Buf->BufSize = bufsize;
3281 /* Flush some space after the used payload so valgrind shuts up... */
3283 while ((i < 10) && (Buf->BufUsed + i < Buf->BufSize))
3284 Buf->buf[Buf->BufUsed + i++] = '\0';
3287 free(compressed_data);
3289 #endif /* HAVE_ZLIB */
3295 /*******************************************************************************
3296 * File I/O; Prefer buffered read since its faster! *
3297 *******************************************************************************/
3300 * @ingroup StrBuf_IO
3301 * @brief Read a line from socket
3302 * flushes and closes the FD on error
3303 * @param buf the buffer to get the input to
3304 * @param fd pointer to the filedescriptor to read
3305 * @param append Append to an existing string or replace?
3306 * @param Error strerror() on error
3307 * @returns numbers of chars read
3309 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error)
3311 int len, rlen, slen;
3316 slen = len = buf->BufUsed;
3318 rlen = read(*fd, &buf->buf[len], 1);
3320 *Error = strerror(errno);
3327 if (buf->buf[len] == '\n')
3329 if (buf->buf[len] != '\r')
3331 if (len + 2 >= buf->BufSize) {
3333 buf->buf[len+1] = '\0';
3334 IncreaseBuf(buf, 1, -1);
3338 buf->buf[len] = '\0';
3343 * @ingroup StrBuf_BufferedIO
3344 * @brief Read a line from socket
3345 * flushes and closes the FD on error
3346 * @param Line the line to read from the fd / I/O Buffer
3347 * @param buf the buffer to get the input to
3348 * @param fd pointer to the filedescriptor to read
3349 * @param timeout number of successless selects until we bail out
3350 * @param selectresolution how long to wait on each select
3351 * @param Error strerror() on error
3352 * @returns numbers of chars read
3354 int StrBufTCP_read_buffered_line(StrBuf *Line,
3358 int selectresolution,
3362 int nSuccessLess = 0;
3369 if (buf->BufUsed > 0) {
3370 pch = strchr(buf->buf, '\n');
3373 len = pch - buf->buf;
3374 if (len > 0 && (*(pch - 1) == '\r') )
3376 StrBufSub(Line, buf, 0, len - rlen);
3377 StrBufCutLeft(buf, len + 1);
3382 if (buf->BufSize - buf->BufUsed < 10)
3383 IncreaseBuf(buf, 1, -1);
3385 fdflags = fcntl(*fd, F_GETFL);
3386 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
3388 while ((nSuccessLess < timeout) && (pch == NULL)) {
3390 tv.tv_sec = selectresolution;
3395 if (select(*fd + 1, NULL, &rfds, NULL, &tv) == -1) {
3396 *Error = strerror(errno);
3402 if (IsNonBlock && ! FD_ISSET(*fd, &rfds)) {
3407 &buf->buf[buf->BufUsed],
3408 buf->BufSize - buf->BufUsed - 1);
3410 *Error = strerror(errno);
3415 else if (rlen > 0) {
3417 buf->BufUsed += rlen;
3418 buf->buf[buf->BufUsed] = '\0';
3419 if (buf->BufUsed + 10 > buf->BufSize) {
3420 IncreaseBuf(buf, 1, -1);
3422 pch = strchr(buf->buf, '\n');
3429 len = pch - buf->buf;
3430 if (len > 0 && (*(pch - 1) == '\r') )
3432 StrBufSub(Line, buf, 0, len - rlen);
3433 StrBufCutLeft(buf, len + 1);
3440 static const char *ErrRBLF_PreConditionFailed="StrBufTCP_read_buffered_line_fast: Wrong arguments or invalid Filedescriptor";
3441 static const char *ErrRBLF_SelectFailed="StrBufTCP_read_buffered_line_fast: Select failed without reason";
3442 static const char *ErrRBLF_NotEnoughSentFromServer="StrBufTCP_read_buffered_line_fast: No complete line was sent from peer";
3444 * @ingroup StrBuf_BufferedIO
3445 * @brief Read a line from socket
3446 * flushes and closes the FD on error
3447 * @param Line where to append our Line read from the fd / I/O Buffer;
3448 * @param IOBuf the buffer to get the input to; lifetime pair to FD
3449 * @param Pos pointer to the current read position, should be NULL initialized on opening the FD it belongs to.!
3450 * @param fd pointer to the filedescriptor to read
3451 * @param timeout number of successless selects until we bail out
3452 * @param selectresolution how long to wait on each select
3453 * @param Error strerror() on error
3454 * @returns numbers of chars read or -1 in case of error. "\n" will become 0
3456 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
3461 int selectresolution,
3464 const char *pche = NULL;
3465 const char *pos = NULL;
3467 int len, rlen, retlen;
3468 int nSuccessLess = 0;
3470 const char *pch = NULL;
3476 if ((Line == NULL) ||
3483 *Error = ErrRBLF_PreConditionFailed;
3488 if ((IOBuf->BufUsed > 0) &&
3490 (pos < IOBuf->buf + IOBuf->BufUsed))
3494 pche = IOBuf->buf + IOBuf->BufUsed;
3498 while ((pch < pche) && (*pch != '\n'))
3500 if (Line->BufUsed + 10 > Line->BufSize)
3503 apos = pcht - Line->buf;
3505 IncreaseBuf(Line, 1, -1);
3506 pcht = Line->buf + apos;
3514 if (len > 0 && (*(pch - 1) == '\r') )
3523 if ((pch >= pche) || (*pch == '\0'))
3531 if ((pch != NULL) &&
3534 if (pch + 1 >= pche) {
3547 /* If we come here, Pos is Unset since we read everything into Line, and now go for more. */
3549 if (IOBuf->BufSize - IOBuf->BufUsed < 10)
3550 IncreaseBuf(IOBuf, 1, -1);
3552 fdflags = fcntl(*fd, F_GETFL);
3553 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
3556 while ((nSuccessLess < timeout) &&
3566 if (select((*fd) + 1, &rfds, NULL, NULL, &tv) == -1) {
3567 *Error = strerror(errno);
3571 *Error = ErrRBLF_SelectFailed;
3574 if (! FD_ISSET(*fd, &rfds) != 0) {
3580 &IOBuf->buf[IOBuf->BufUsed],
3581 IOBuf->BufSize - IOBuf->BufUsed - 1);
3583 *Error = strerror(errno);
3588 else if (rlen > 0) {
3590 pLF = IOBuf->buf + IOBuf->BufUsed;
3591 IOBuf->BufUsed += rlen;
3592 IOBuf->buf[IOBuf->BufUsed] = '\0';
3594 pche = IOBuf->buf + IOBuf->BufUsed;
3596 while ((pLF < pche) && (*pLF != '\n'))
3598 if ((pLF >= pche) || (*pLF == '\0'))
3601 if (IOBuf->BufUsed + 10 > IOBuf->BufSize)
3605 if (pLF != NULL) apos = pLF - IOBuf->buf;
3606 IncreaseBuf(IOBuf, 1, -1);
3607 if (pLF != NULL) pLF = IOBuf->buf + apos;
3617 if (len > 0 && (*(pLF - 1) == '\r') )
3619 StrBufAppendBufPlain(Line, ChrPtr(IOBuf), len, 0);
3620 if (pLF + 1 >= IOBuf->buf + IOBuf->BufUsed)
3626 return retlen + len;
3628 *Error = ErrRBLF_NotEnoughSentFromServer;
3633 static const char *ErrRBLF_BLOBPreConditionFailed="StrBufReadBLOB: Wrong arguments or invalid Filedescriptor";
3635 * @ingroup StrBuf_IO
3636 * @brief Input binary data from socket
3637 * flushes and closes the FD on error
3638 * @param Buf the buffer to get the input to
3639 * @param fd pointer to the filedescriptor to read
3640 * @param append Append to an existing string or replace?
3641 * @param nBytes the maximal number of bytes to read
3642 * @param Error strerror() on error
3643 * @returns numbers of chars read
3645 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error)
3648 int len, rlen, slen;
3656 if ((Buf == NULL) || (*fd == -1))
3658 *Error = ErrRBLF_BLOBPreConditionFailed;
3663 if (Buf->BufUsed + nBytes >= Buf->BufSize)
3664 IncreaseBuf(Buf, 1, Buf->BufUsed + nBytes);
3666 ptr = Buf->buf + Buf->BufUsed;
3668 slen = len = Buf->BufUsed;
3670 fdflags = fcntl(*fd, F_GETFL);
3671 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
3673 while ((nRead < nBytes) &&
3683 if (select(*fd + 1, &rfds, NULL, NULL, &tv) == -1) {
3684 *Error = strerror(errno);
3688 *Error = ErrRBLF_SelectFailed;
3691 if (! FD_ISSET(*fd, &rfds) != 0) {
3697 if ((rlen = read(*fd,
3699 nBytes - nRead)) == -1) {
3702 *Error = strerror(errno);
3707 Buf->BufUsed += rlen;
3709 Buf->buf[Buf->BufUsed] = '\0';
3713 const char *ErrRBB_BLOBFPreConditionFailed = "StrBufReadBLOBBuffered: to many selects; aborting.";
3714 const char *ErrRBB_too_many_selects = "StrBufReadBLOBBuffered: to many selects; aborting.";
3716 * @ingroup StrBuf_BufferedIO
3717 * @brief Input binary data from socket
3718 * flushes and closes the FD on error
3719 * @param Blob put binary thing here
3720 * @param IOBuf the buffer to get the input to
3721 * @param Pos offset inside of IOBuf
3722 * @param fd pointer to the filedescriptor to read
3723 * @param append Append to an existing string or replace?
3724 * @param nBytes the maximal number of bytes to read
3725 * @param check whether we should search for '000\n' terminators in case of timeouts
3726 * @param Error strerror() on error
3727 * @returns numbers of chars read
3729 int StrBufReadBLOBBuffered(StrBuf *Blob,
3744 int nAlreadyRead = 0;
3750 int nSuccessLess = 0;
3753 if ((Blob == NULL) || (*fd == -1) || (IOBuf == NULL) || (Pos == NULL))
3757 *Error = ErrRBB_BLOBFPreConditionFailed;
3763 if (Blob->BufUsed + nBytes >= Blob->BufSize)
3764 IncreaseBuf(Blob, append, Blob->BufUsed + nBytes);
3769 len = pos - IOBuf->buf;
3770 rlen = IOBuf->BufUsed - len;
3773 if ((IOBuf->BufUsed > 0) &&
3775 (pos < IOBuf->buf + IOBuf->BufUsed))
3777 pche = IOBuf->buf + IOBuf->BufUsed;
3780 if (rlen < nBytes) {
3781 memcpy(Blob->buf + Blob->BufUsed, pos, rlen);
3782 Blob->BufUsed += rlen;
3783 Blob->buf[Blob->BufUsed] = '\0';
3784 nAlreadyRead = nRead = rlen;
3787 if (rlen >= nBytes) {
3788 memcpy(Blob->buf + Blob->BufUsed, pos, nBytes);
3789 Blob->BufUsed += nBytes;
3790 Blob->buf[Blob->BufUsed] = '\0';
3791 if (rlen == nBytes) {
3803 if (IOBuf->BufSize < nBytes - nRead)
3804 IncreaseBuf(IOBuf, 0, nBytes - nRead);
3807 slen = len = Blob->BufUsed;
3809 fdflags = fcntl(*fd, F_GETFL);
3810 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
3818 while ((nSuccessLess < MaxTries) &&
3828 if (select(*fd + 1, &rfds, NULL, NULL, &tv) == -1) {
3829 *Error = strerror(errno);
3833 *Error = ErrRBLF_SelectFailed;
3836 if (! FD_ISSET(*fd, &rfds) != 0) {
3843 IOBuf->BufSize - (ptr - IOBuf->buf));
3847 *Error = strerror(errno);
3850 else if (rlen == 0){
3851 if ((check == NNN_TERM) &&
3853 (strncmp(IOBuf->buf + IOBuf->BufUsed - 5, "\n000\n", 5) == 0))
3855 StrBufPlain(Blob, HKEY("\n000\n"));
3856 StrBufCutRight(Blob, 5);
3857 return Blob->BufUsed;
3859 else if (!IsNonBlock)
3861 else if (nSuccessLess > MaxTries) {
3863 *Error = ErrRBB_too_many_selects;
3867 else if (rlen > 0) {
3871 IOBuf->BufUsed += rlen;
3874 if (nSuccessLess >= MaxTries) {
3876 *Error = ErrRBB_too_many_selects;
3880 if (nRead > nBytes) {
3881 *Pos = IOBuf->buf + nBytes;
3883 Blob->buf[Blob->BufUsed] = '\0';
3884 StrBufAppendBufPlain(Blob, IOBuf->buf, nBytes, 0);
3888 return nRead + nAlreadyRead;
3892 * @ingroup StrBuf_IO
3893 * @brief extract a "next line" from Buf; Ptr to persist across several iterations
3894 * @param LineBuf your line will be copied here.
3895 * @param Buf BLOB with lines of text...
3896 * @param Ptr moved arround to keep the next-line across several iterations
3897 * has to be &NULL on start; will be &NotNULL on end of buffer
3898 * @returns size of copied buffer
3900 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr)
3902 const char *aptr, *ptr, *eptr;
3905 if ((Buf == NULL) || (*Ptr == StrBufNOTNULL)) {
3906 *Ptr = StrBufNOTNULL;
3910 FlushStrBuf(LineBuf);
3912 ptr = aptr = Buf->buf;
3916 optr = LineBuf->buf;
3917 eptr = Buf->buf + Buf->BufUsed;
3918 xptr = LineBuf->buf + LineBuf->BufSize - 1;
3920 while ((ptr <= eptr) &&
3927 LineBuf->BufUsed = optr - LineBuf->buf;
3928 IncreaseBuf(LineBuf, 1, LineBuf->BufUsed + 1);
3929 optr = LineBuf->buf + LineBuf->BufUsed;
3930 xptr = LineBuf->buf + LineBuf->BufSize - 1;
3934 if ((ptr >= eptr) && (optr > LineBuf->buf))
3936 LineBuf->BufUsed = optr - LineBuf->buf;
3938 if ((ptr <= eptr) && (*ptr == '\r'))
3940 if ((ptr <= eptr) && (*ptr == '\n'))
3947 *Ptr = StrBufNOTNULL;
3950 return Buf->BufUsed - (ptr - Buf->buf);
3955 * @ingroup StrBuf_IO
3956 * @brief removes double slashes from pathnames
3957 * @param Dir directory string to filter
3958 * @param RemoveTrailingSlash allows / disallows trailing slashes
3960 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash)
3966 while (!IsEmptyStr(a)) {
3978 if ((RemoveTrailingSlash) && (*(b - 1) != '/')){
3983 Dir->BufUsed = b - Dir->buf;