2 * Copyright (c) 1987-2013 by the citadel.org team
4 * This program is open source software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #include <sys/select.h>
29 #include <sys/types.h>
30 #define SHOW_ME_VAPPEND_PRINTF
33 #include "libcitadel.h"
49 int ZEXPORT compress_gzip(Bytef * dest, size_t * destLen,
50 const Bytef * source, uLong sourceLen, int level);
52 int BaseStrBufSize = 64;
55 const char *StrBufNOTNULL = ((char*) NULL) - 1;
57 const char HexList[256][3] = {
58 "00","01","02","03","04","05","06","07","08","09","0A","0B","0C","0D","0E","0F",
59 "10","11","12","13","14","15","16","17","18","19","1A","1B","1C","1D","1E","1F",
60 "20","21","22","23","24","25","26","27","28","29","2A","2B","2C","2D","2E","2F",
61 "30","31","32","33","34","35","36","37","38","39","3A","3B","3C","3D","3E","3F",
62 "40","41","42","43","44","45","46","47","48","49","4A","4B","4C","4D","4E","4F",
63 "50","51","52","53","54","55","56","57","58","59","5A","5B","5C","5D","5E","5F",
64 "60","61","62","63","64","65","66","67","68","69","6A","6B","6C","6D","6E","6F",
65 "70","71","72","73","74","75","76","77","78","79","7A","7B","7C","7D","7E","7F",
66 "80","81","82","83","84","85","86","87","88","89","8A","8B","8C","8D","8E","8F",
67 "90","91","92","93","94","95","96","97","98","99","9A","9B","9C","9D","9E","9F",
68 "A0","A1","A2","A3","A4","A5","A6","A7","A8","A9","AA","AB","AC","AD","AE","AF",
69 "B0","B1","B2","B3","B4","B5","B6","B7","B8","B9","BA","BB","BC","BD","BE","BF",
70 "C0","C1","C2","C3","C4","C5","C6","C7","C8","C9","CA","CB","CC","CD","CE","CF",
71 "D0","D1","D2","D3","D4","D5","D6","D7","D8","D9","DA","DB","DC","DD","DE","DF",
72 "E0","E1","E2","E3","E4","E5","E6","E7","E8","E9","EA","EB","EC","ED","EE","EF",
73 "F0","F1","F2","F3","F4","F5","F6","F7","F8","F9","FA","FB","FC","FD","FE","FF"};
76 * @defgroup StrBuf Stringbuffer, A class for manipulating strings with dynamic buffers
77 * StrBuf is a versatile class, aiding the handling of dynamic strings
78 * * reduce de/reallocations
79 * * reduce the need to remeasure it
80 * * reduce scanning over the string (in @ref StrBuf_NextTokenizer "Tokenizers")
81 * * allow asyncroneous IO for line and Blob based operations
82 * * reduce the use of memove in those
83 * * Quick filling in several operations with append functions
87 * @defgroup StrBuf_DeConstructors Create/Destroy StrBufs
92 * @defgroup StrBuf_Cast Cast operators to interact with char* based code
94 * use these operators to interfere with code demanding char*;
95 * if you need to own the content, smash me. Avoid, since we loose the length information.
99 * @defgroup StrBuf_Filler Create/Replace/Append Content into a StrBuf
101 * operations to get your Strings into a StrBuf, manipulating them, or appending
104 * @defgroup StrBuf_NextTokenizer Fast tokenizer to pull tokens in sequence
106 * Quick tokenizer; demands of the user to pull its tokens in sequence
110 * @defgroup StrBuf_Tokenizer tokenizer Functions; Slow ones.
112 * versatile tokenizer; random access to tokens, but slower; Prefer the @ref StrBuf_NextTokenizer "Next Tokenizer"
116 * @defgroup StrBuf_BufferedIO Buffered IO with Asynchroneous reads and no unneeded memmoves (the fast ones)
118 * File IO to fill StrBufs; Works with work-buffer shared across several calls;
119 * External Cursor to maintain the current read position inside of the buffer
120 * the non-fast ones will use memove to keep the start of the buffer the read buffer (which is slower)
124 * @defgroup StrBuf_IO FileIO; Prefer @ref StrBuf_BufferedIO
130 * @defgroup StrBuf_DeEnCoder functions to translate the contents of a buffer
132 * these functions translate the content of a buffer into another representation;
133 * some are combined Fillers and encoders
137 * Private Structure for the Stringbuffer
140 char *buf; /**< the pointer to the dynamic buffer */
141 long BufSize; /**< how many spcae do we optain */
142 long BufUsed; /**< StNumber of Chars used excluding the trailing \\0 */
143 int ConstBuf; /**< are we just a wrapper arround a static buffer and musn't we be changed? */
145 long nIncreases; /**< for profiling; cound how many times we needed more */
146 char bt [SIZ]; /**< Stacktrace of last increase */
147 char bt_lastinc [SIZ]; /**< How much did we increase last time? */
152 static inline int Ctdl_GetUtf8SequenceLength(const char *CharS, const char *CharE);
153 static inline int Ctdl_IsUtf8SequenceStart(const char Char);
156 #ifdef HAVE_BACKTRACE
157 static void StrBufBacktrace(StrBuf *Buf, int which)
161 void *stack_frames[50];
166 pstart = pch = Buf->bt;
168 pstart = pch = Buf->bt_lastinc;
169 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
170 strings = backtrace_symbols(stack_frames, size);
171 for (i = 0; i < size; i++) {
173 n = snprintf(pch, SIZ - (pch - pstart), "%s\\n", strings[i]);
175 n = snprintf(pch, SIZ - (pch - pstart), "%p\\n", stack_frames[i]);
184 void dbg_FreeStrBuf(StrBuf *FreeMe, char *FromWhere)
186 if (hFreeDbglog == -1){
187 pid_t pid = getpid();
189 snprintf(path, SIZ, "/tmp/libcitadel_strbuf_realloc.log.%d", pid);
190 hFreeDbglog = open(path, O_APPEND|O_CREAT|O_WRONLY);
192 if ((*FreeMe)->nIncreases > 0)
196 n = snprintf(buf, SIZ * 3, "%c+|%ld|%ld|%ld|%s|%s|\n",
198 (*FreeMe)->nIncreases,
202 (*FreeMe)->bt_lastinc);
203 n = write(hFreeDbglog, buf, n);
209 n = snprintf(buf, 128, "%c_|0|%ld%ld|\n",
213 n = write(hFreeDbglog, buf, n);
217 void dbg_IncreaseBuf(StrBuf *IncMe)
220 #ifdef HAVE_BACKTRACE
221 StrBufBacktrace(Buf, 1);
225 void dbg_Init(StrBuf *Buf)
229 Buf->bt_lastinc[0] = '\0';
230 #ifdef HAVE_BACKTRACE
231 StrBufBacktrace(Buf, 0);
237 #define dbg_FreeStrBuf(a, b)
238 #define dbg_IncreaseBuf(a)
245 * @brief swaps the contents of two StrBufs
246 * this is to be used to have cheap switched between a work-buffer and a target buffer
248 * @param B second one
250 static inline void SwapBuffers(StrBuf *A, StrBuf *B)
254 memcpy(&C, A, sizeof(*A));
255 memcpy(A, B, sizeof(*B));
256 memcpy(B, &C, sizeof(C));
261 * @ingroup StrBuf_Cast
262 * @brief Cast operator to Plain String
263 * @note if the buffer is altered by StrBuf operations, this pointer may become
264 * invalid. So don't lean on it after altering the buffer!
265 * Since this operation is considered cheap, rather call it often than risking
266 * your pointer to become invalid!
267 * @param Str the string we want to get the c-string representation for
268 * @returns the Pointer to the Content. Don't mess with it!
270 inline const char *ChrPtr(const StrBuf *Str)
278 * @ingroup StrBuf_Cast
279 * @brief since we know strlen()'s result, provide it here.
280 * @param Str the string to return the length to
281 * @returns contentlength of the buffer
283 inline int StrLength(const StrBuf *Str)
285 return (Str != NULL) ? Str->BufUsed : 0;
289 * @ingroup StrBuf_DeConstructors
290 * @brief local utility function to resize the buffer
291 * @param Buf the buffer whichs storage we should increase
292 * @param KeepOriginal should we copy the original buffer or just start over with a new one
293 * @param DestSize what should fit in after?
295 static int IncreaseBuf(StrBuf *Buf, int KeepOriginal, int DestSize)
298 size_t NewSize = Buf->BufSize * 2;
304 while ((NewSize <= DestSize) && (NewSize != 0))
310 NewBuf= (char*) malloc(NewSize);
314 if (KeepOriginal && (Buf->BufUsed > 0))
316 memcpy(NewBuf, Buf->buf, Buf->BufUsed);
325 Buf->BufSize = NewSize;
327 dbg_IncreaseBuf(Buf);
333 * @ingroup StrBuf_DeConstructors
334 * @brief shrink / increase an _EMPTY_ buffer to NewSize. Buffercontent is thoroughly ignored and flushed.
335 * @param Buf Buffer to shrink (has to be empty)
336 * @param ThreshHold if the buffer is bigger then this, its readjusted
337 * @param NewSize if we Shrink it, how big are we going to be afterwards?
339 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize)
342 (Buf->BufUsed == 0) &&
343 (Buf->BufSize < ThreshHold)) {
345 Buf->buf = (char*) malloc(NewSize);
347 Buf->BufSize = NewSize;
352 * @ingroup StrBuf_DeConstructors
353 * @brief shrink long term buffers to their real size so they don't waste memory
354 * @param Buf buffer to shrink
355 * @param Force if not set, will just executed if the buffer is much to big; set for lifetime strings
356 * @returns physical size of the buffer
358 long StrBufShrinkToFit(StrBuf *Buf, int Force)
363 (Buf->BufUsed + (Buf->BufUsed / 3) > Buf->BufSize))
367 TmpBuf = (char*) malloc(Buf->BufUsed + 1);
371 memcpy (TmpBuf, Buf->buf, Buf->BufUsed + 1);
372 Buf->BufSize = Buf->BufUsed + 1;
380 * @ingroup StrBuf_DeConstructors
381 * @brief Allocate a new buffer with default buffer size
382 * @returns the new stringbuffer
384 StrBuf* NewStrBuf(void)
388 NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
392 NewBuf->buf = (char*) malloc(BaseStrBufSize);
393 if (NewBuf->buf == NULL)
398 NewBuf->buf[0] = '\0';
399 NewBuf->BufSize = BaseStrBufSize;
401 NewBuf->ConstBuf = 0;
409 * @ingroup StrBuf_DeConstructors
410 * @brief Copy Constructor; returns a duplicate of CopyMe
411 * @param CopyMe Buffer to faxmilate
412 * @returns the new stringbuffer
414 StrBuf* NewStrBufDup(const StrBuf *CopyMe)
421 NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
425 NewBuf->buf = (char*) malloc(CopyMe->BufSize);
426 if (NewBuf->buf == NULL)
432 memcpy(NewBuf->buf, CopyMe->buf, CopyMe->BufUsed + 1);
433 NewBuf->BufUsed = CopyMe->BufUsed;
434 NewBuf->BufSize = CopyMe->BufSize;
435 NewBuf->ConstBuf = 0;
443 * @ingroup StrBuf_DeConstructors
444 * @brief Copy Constructor; CreateRelpaceMe will contain CopyFlushMe afterwards.
445 * @param NoMe if non-NULL, we will use that buffer as value; KeepOriginal will abused as len.
446 * @param CopyFlushMe Buffer to faxmilate if KeepOriginal, or to move into CreateRelpaceMe if !KeepOriginal.
447 * @param CreateRelpaceMe If NULL, will be created, else Flushed and filled CopyFlushMe
448 * @param KeepOriginal should CopyFlushMe remain intact? or may we Steal its buffer?
449 * @returns the new stringbuffer
451 void NewStrBufDupAppendFlush(StrBuf **CreateRelpaceMe, StrBuf *CopyFlushMe, const char *NoMe, int KeepOriginal)
455 if (CreateRelpaceMe == NULL)
460 if (*CreateRelpaceMe != NULL)
461 StrBufPlain(*CreateRelpaceMe, NoMe, KeepOriginal);
463 *CreateRelpaceMe = NewStrBufPlain(NoMe, KeepOriginal);
467 if (CopyFlushMe == NULL)
469 if (*CreateRelpaceMe != NULL)
470 FlushStrBuf(*CreateRelpaceMe);
472 *CreateRelpaceMe = NewStrBuf();
477 * Randomly Chosen: bigger than 64 chars is cheaper to swap the buffers instead of copying.
478 * else *CreateRelpaceMe may use more memory than needed in a longer term, CopyFlushMe might
479 * be a big IO-Buffer...
481 if (KeepOriginal || (StrLength(CopyFlushMe) < 256))
483 if (*CreateRelpaceMe == NULL)
485 *CreateRelpaceMe = NewBuf = NewStrBufPlain(NULL, CopyFlushMe->BufUsed);
490 NewBuf = *CreateRelpaceMe;
493 StrBufAppendBuf(NewBuf, CopyFlushMe, 0);
497 if (*CreateRelpaceMe == NULL)
499 *CreateRelpaceMe = NewBuf = NewStrBufPlain(NULL, CopyFlushMe->BufUsed);
503 NewBuf = *CreateRelpaceMe;
504 SwapBuffers (NewBuf, CopyFlushMe);
507 FlushStrBuf(CopyFlushMe);
512 * @ingroup StrBuf_DeConstructors
513 * @brief create a new Buffer using an existing c-string
514 * this function should also be used if you want to pre-suggest
515 * the buffer size to allocate in conjunction with ptr == NULL
516 * @param ptr the c-string to copy; may be NULL to create a blank instance
517 * @param nChars How many chars should we copy; -1 if we should measure the length ourselves
518 * @returns the new stringbuffer
520 StrBuf* NewStrBufPlain(const char* ptr, int nChars)
523 size_t Siz = BaseStrBufSize;
526 NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
531 CopySize = strlen((ptr != NULL)?ptr:"");
535 while ((Siz <= CopySize) && (Siz != 0))
544 NewBuf->buf = (char*) malloc(Siz);
545 if (NewBuf->buf == NULL)
550 NewBuf->BufSize = Siz;
552 memcpy(NewBuf->buf, ptr, CopySize);
553 NewBuf->buf[CopySize] = '\0';
554 NewBuf->BufUsed = CopySize;
557 NewBuf->buf[0] = '\0';
560 NewBuf->ConstBuf = 0;
568 * @ingroup StrBuf_DeConstructors
569 * @brief Set an existing buffer from a c-string
570 * @param Buf buffer to load
571 * @param ptr c-string to put into
572 * @param nChars set to -1 if we should work 0-terminated
573 * @returns the new length of the string
575 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars)
590 CopySize = strlen(ptr);
594 while ((Siz <= CopySize) && (Siz != 0))
602 if (Siz != Buf->BufSize)
603 IncreaseBuf(Buf, 0, Siz);
604 memcpy(Buf->buf, ptr, CopySize);
605 Buf->buf[CopySize] = '\0';
606 Buf->BufUsed = CopySize;
613 * @ingroup StrBuf_DeConstructors
614 * @brief use strbuf as wrapper for a string constant for easy handling
615 * @param StringConstant a string to wrap
616 * @param SizeOfStrConstant should be sizeof(StringConstant)-1
618 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant)
622 NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
625 NewBuf->buf = (char*) StringConstant;
626 NewBuf->BufSize = SizeOfStrConstant;
627 NewBuf->BufUsed = SizeOfStrConstant;
628 NewBuf->ConstBuf = 1;
637 * @ingroup StrBuf_DeConstructors
638 * @brief flush the content of a Buf; keep its struct
639 * @param buf Buffer to flush
641 int FlushStrBuf(StrBuf *buf)
643 if ((buf == NULL) || (buf->buf == NULL))
653 * @ingroup StrBuf_DeConstructors
654 * @brief wipe the content of a Buf thoroughly (overwrite it -> expensive); keep its struct
655 * @param buf Buffer to wipe
657 int FLUSHStrBuf(StrBuf *buf)
663 if (buf->BufUsed > 0) {
664 memset(buf->buf, 0, buf->BufUsed);
671 int hFreeDbglog = -1;
674 * @ingroup StrBuf_DeConstructors
675 * @brief Release a Buffer
676 * Its a double pointer, so it can NULL your pointer
677 * so fancy SIG11 appear instead of random results
678 * @param FreeMe Pointer Pointer to the buffer to free
680 void FreeStrBuf (StrBuf **FreeMe)
685 dbg_FreeStrBuf(FreeMe, 'F');
687 if (!(*FreeMe)->ConstBuf)
688 free((*FreeMe)->buf);
694 * @ingroup StrBuf_DeConstructors
695 * @brief flatten a Buffer to the Char * we return
696 * Its a double pointer, so it can NULL your pointer
697 * so fancy SIG11 appear instead of random results
698 * The Callee then owns the buffer and is responsible for freeing it.
699 * @param SmashMe Pointer Pointer to the buffer to release Buf from and free
700 * @returns the pointer of the buffer; Callee owns the memory thereafter.
702 char *SmashStrBuf (StrBuf **SmashMe)
706 if ((SmashMe == NULL) || (*SmashMe == NULL))
709 dbg_FreeStrBuf(SmashMe, 'S');
711 Ret = (*SmashMe)->buf;
718 * @ingroup StrBuf_DeConstructors
719 * @brief Release the buffer
720 * If you want put your StrBuf into a Hash, use this as Destructor.
721 * @param VFreeMe untyped pointer to a StrBuf. be shure to do the right thing [TM]
723 void HFreeStrBuf (void *VFreeMe)
725 StrBuf *FreeMe = (StrBuf*)VFreeMe;
729 dbg_FreeStrBuf(SmashMe, 'H');
731 if (!FreeMe->ConstBuf)
737 /*******************************************************************************
738 * Simple string transformations *
739 *******************************************************************************/
743 * @brief Wrapper around atol
745 long StrTol(const StrBuf *Buf)
750 return atol(Buf->buf);
757 * @brief Wrapper around atoi
759 int StrToi(const StrBuf *Buf)
763 if (Buf->BufUsed > 0)
764 return atoi(Buf->buf);
771 * @brief Checks to see if the string is a pure number
772 * @param Buf The buffer to inspect
773 * @returns 1 if its a pure number, 0, if not.
775 int StrBufIsNumber(const StrBuf *Buf) {
777 if ((Buf == NULL) || (Buf->BufUsed == 0)) {
780 strtoll(Buf->buf, &pEnd, 10);
781 if (pEnd == Buf->buf)
783 if ((pEnd != NULL) && (pEnd == Buf->buf + Buf->BufUsed))
785 if (Buf->buf == pEnd)
791 * @ingroup StrBuf_Filler
792 * @brief modifies a Single char of the Buf
793 * You can point to it via char* or a zero-based integer
794 * @param Buf The buffer to manipulate
795 * @param ptr char* to zero; use NULL if unused
796 * @param nThChar zero based pointer into the string; use -1 if unused
797 * @param PeekValue The Character to place into the position
799 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue)
804 nThChar = ptr - Buf->buf;
805 if ((nThChar < 0) || (nThChar > Buf->BufUsed))
807 Buf->buf[nThChar] = PeekValue;
812 * @ingroup StrBuf_Filler
813 * @brief modifies a range of chars of the Buf
814 * You can point to it via char* or a zero-based integer
815 * @param Buf The buffer to manipulate
816 * @param ptr char* to zero; use NULL if unused
817 * @param nThChar zero based pointer into the string; use -1 if unused
818 * @param nChars how many chars are to be flushed?
819 * @param PookValue The Character to place into that area
821 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue)
826 nThChar = ptr - Buf->buf;
827 if ((nThChar < 0) || (nThChar > Buf->BufUsed))
829 if (nThChar + nChars > Buf->BufUsed)
830 nChars = Buf->BufUsed - nThChar;
832 memset(Buf->buf + nThChar, PookValue, nChars);
833 /* just to be shure... */
834 Buf->buf[Buf->BufUsed] = 0;
839 * @ingroup StrBuf_Filler
840 * @brief Append a StringBuffer to the buffer
841 * @param Buf Buffer to modify
842 * @param AppendBuf Buffer to copy at the end of our buffer
843 * @param Offset Should we start copying from an offset?
845 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset)
847 if ((AppendBuf == NULL) || (AppendBuf->buf == NULL) ||
848 (Buf == NULL) || (Buf->buf == NULL))
851 if (Buf->BufSize - Offset < AppendBuf->BufUsed + Buf->BufUsed + 1)
854 AppendBuf->BufUsed + Buf->BufUsed);
856 memcpy(Buf->buf + Buf->BufUsed,
857 AppendBuf->buf + Offset,
858 AppendBuf->BufUsed - Offset);
859 Buf->BufUsed += AppendBuf->BufUsed - Offset;
860 Buf->buf[Buf->BufUsed] = '\0';
865 * @ingroup StrBuf_Filler
866 * @brief Append a C-String to the buffer
867 * @param Buf Buffer to modify
868 * @param AppendBuf Buffer to copy at the end of our buffer
869 * @param AppendSize number of bytes to copy; set to -1 if we should count it in advance
870 * @param Offset Should we start copying from an offset?
872 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset)
875 long BufSizeRequired;
877 if ((AppendBuf == NULL) || (Buf == NULL))
881 aps = strlen(AppendBuf + Offset);
883 aps = AppendSize - Offset;
885 BufSizeRequired = Buf->BufUsed + aps + 1;
886 if (Buf->BufSize <= BufSizeRequired)
887 IncreaseBuf(Buf, (Buf->BufUsed > 0), BufSizeRequired);
889 memcpy(Buf->buf + Buf->BufUsed,
893 Buf->buf[Buf->BufUsed] = '\0';
897 * @ingroup StrBuf_Filler
898 * @brief sprintf like function appending the formated string to the buffer
899 * vsnprintf version to wrap into own calls
900 * @param Buf Buffer to extend by format and Params
901 * @param format printf alike format to add
902 * @param ap va_list containing the items for format
904 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap)
912 if ((Buf == NULL) || (format == NULL))
915 BufSize = Buf->BufSize;
916 nWritten = Buf->BufSize + 1;
917 Offset = Buf->BufUsed;
918 newused = Offset + nWritten;
920 while (newused >= BufSize) {
922 nWritten = vsnprintf(Buf->buf + Offset,
923 Buf->BufSize - Offset,
926 newused = Offset + nWritten;
927 if (newused >= Buf->BufSize) {
928 if (IncreaseBuf(Buf, 1, newused) == -1)
929 return; /* TODO: error handling? */
930 newused = Buf->BufSize + 1;
933 Buf->BufUsed = Offset + nWritten;
934 BufSize = Buf->BufSize;
941 * @ingroup StrBuf_Filler
942 * @brief sprintf like function appending the formated string to the buffer
943 * @param Buf Buffer to extend by format and Params
944 * @param format printf alike format to add
946 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...)
954 if ((Buf == NULL) || (format == NULL))
957 BufSize = Buf->BufSize;
958 nWritten = Buf->BufSize + 1;
959 Offset = Buf->BufUsed;
960 newused = Offset + nWritten;
962 while (newused >= BufSize) {
963 va_start(arg_ptr, format);
964 nWritten = vsnprintf(Buf->buf + Buf->BufUsed,
965 Buf->BufSize - Buf->BufUsed,
968 newused = Buf->BufUsed + nWritten;
969 if (newused >= Buf->BufSize) {
970 if (IncreaseBuf(Buf, 1, newused) == -1)
971 return; /* TODO: error handling? */
972 newused = Buf->BufSize + 1;
975 Buf->BufUsed += nWritten;
976 BufSize = Buf->BufSize;
983 * @ingroup StrBuf_Filler
984 * @brief sprintf like function putting the formated string into the buffer
985 * @param Buf Buffer to extend by format and Parameters
986 * @param format printf alike format to add
988 void StrBufPrintf(StrBuf *Buf, const char *format, ...)
993 if ((Buf == NULL) || (format == NULL))
996 nWritten = Buf->BufSize + 1;
997 while (nWritten >= Buf->BufSize) {
998 va_start(arg_ptr, format);
999 nWritten = vsnprintf(Buf->buf, Buf->BufSize, format, arg_ptr);
1001 if (nWritten >= Buf->BufSize) {
1002 if (IncreaseBuf(Buf, 0, 0) == -1)
1003 return; /* TODO: error handling? */
1004 nWritten = Buf->BufSize + 1;
1007 Buf->BufUsed = nWritten ;
1012 * @ingroup StrBuf_Filler
1013 * @brief Callback for cURL to append the webserver reply to a buffer
1014 * @param ptr pre-defined by the cURL API; see man 3 curl for mre info
1015 * @param size pre-defined by the cURL API; see man 3 curl for mre info
1016 * @param nmemb pre-defined by the cURL API; see man 3 curl for mre info
1017 * @param stream pre-defined by the cURL API; see man 3 curl for mre info
1019 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream)
1028 StrBufAppendBufPlain(Target, ptr, size * nmemb, 0);
1029 return size * nmemb;
1035 * @brief extracts a substring from Source into dest
1036 * @param dest buffer to place substring into
1037 * @param Source string to copy substring from
1038 * @param Offset chars to skip from start
1039 * @param nChars number of chars to copy
1040 * @returns the number of chars copied; may be different from nChars due to the size of Source
1042 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars)
1044 size_t NCharsRemain;
1045 if (Offset > Source->BufUsed)
1051 if (Offset + nChars < Source->BufUsed)
1053 if ((nChars >= dest->BufSize) &&
1054 (IncreaseBuf(dest, 0, nChars + 1) == -1))
1056 memcpy(dest->buf, Source->buf + Offset, nChars);
1057 dest->BufUsed = nChars;
1058 dest->buf[dest->BufUsed] = '\0';
1061 NCharsRemain = Source->BufUsed - Offset;
1062 if ((NCharsRemain >= dest->BufSize) &&
1063 (IncreaseBuf(dest, 0, NCharsRemain + 1) == -1))
1065 memcpy(dest->buf, Source->buf + Offset, NCharsRemain);
1066 dest->BufUsed = NCharsRemain;
1067 dest->buf[dest->BufUsed] = '\0';
1068 return NCharsRemain;
1073 * @brief Cut nChars from the start of the string
1074 * @param Buf Buffer to modify
1075 * @param nChars how many chars should be skipped?
1077 void StrBufCutLeft(StrBuf *Buf, int nChars)
1079 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1080 if (nChars >= Buf->BufUsed) {
1084 memmove(Buf->buf, Buf->buf + nChars, Buf->BufUsed - nChars);
1085 Buf->BufUsed -= nChars;
1086 Buf->buf[Buf->BufUsed] = '\0';
1091 * @brief Cut the trailing n Chars from the string
1092 * @param Buf Buffer to modify
1093 * @param nChars how many chars should be trunkated?
1095 void StrBufCutRight(StrBuf *Buf, int nChars)
1097 if ((Buf == NULL) || (Buf->BufUsed == 0) || (Buf->buf == NULL))
1100 if (nChars >= Buf->BufUsed) {
1104 Buf->BufUsed -= nChars;
1105 Buf->buf[Buf->BufUsed] = '\0';
1110 * @brief Cut the string after n Chars
1111 * @param Buf Buffer to modify
1112 * @param AfternChars after how many chars should we trunkate the string?
1113 * @param At if non-null and points inside of our string, cut it there.
1115 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At)
1117 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1119 AfternChars = At - Buf->buf;
1122 if ((AfternChars < 0) || (AfternChars >= Buf->BufUsed))
1124 Buf->BufUsed = AfternChars;
1125 Buf->buf[Buf->BufUsed] = '\0';
1131 * @brief Strip leading and trailing spaces from a string; with premeasured and adjusted length.
1132 * @param Buf the string to modify
1134 void StrBufTrim(StrBuf *Buf)
1137 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1139 while ((Buf->BufUsed > 0) &&
1140 isspace(Buf->buf[Buf->BufUsed - 1]))
1144 Buf->buf[Buf->BufUsed] = '\0';
1146 if (Buf->BufUsed == 0) return;
1148 while ((Buf->BufUsed > delta) && (isspace(Buf->buf[delta]))){
1151 if (delta > 0) StrBufCutLeft(Buf, delta);
1155 * @brief changes all spaces in the string (tab, linefeed...) to Blank (0x20)
1156 * @param Buf the string to modify
1158 void StrBufSpaceToBlank(StrBuf *Buf)
1162 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1165 pche = pch + Buf->BufUsed;
1174 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary)
1179 if ((Buf == NULL) || (Buf->buf == NULL)) {
1183 pRight = strchr(Buf->buf, rightboundary);
1184 if (pRight != NULL) {
1185 StrBufCutAt(Buf, 0, pRight);
1188 StrBufCutAt(Buf, 0, Buf->buf);
1192 pLeft = strrchr(ChrPtr(Buf), leftboundary);
1193 if (pLeft != NULL) {
1194 StrBufCutLeft(Buf, pLeft - Buf->buf + 1);
1197 StrBufCutAt(Buf, 0, Buf->buf);
1204 * @ingroup StrBuf_Filler
1205 * @brief uppercase the contents of a buffer
1206 * @param Buf the buffer to translate
1208 void StrBufUpCase(StrBuf *Buf)
1212 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1215 pche = pch + Buf->BufUsed;
1216 while (pch < pche) {
1217 *pch = toupper(*pch);
1224 * @ingroup StrBuf_Filler
1225 * @brief lowercase the contents of a buffer
1226 * @param Buf the buffer to translate
1228 void StrBufLowerCase(StrBuf *Buf)
1232 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1235 pche = pch + Buf->BufUsed;
1236 while (pch < pche) {
1237 *pch = tolower(*pch);
1243 /*******************************************************************************
1244 * a tokenizer that kills, maims, and destroys *
1245 *******************************************************************************/
1248 * @ingroup StrBuf_Tokenizer
1249 * @brief Replace a token at a given place with a given length by another token with given length
1250 * @param Buf String where to work on
1251 * @param where where inside of the Buf is the search-token
1252 * @param HowLong How long is the token to be replaced
1253 * @param Repl Token to insert at 'where'
1254 * @param ReplLen Length of repl
1255 * @returns -1 if fail else length of resulting Buf
1257 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong,
1258 const char *Repl, long ReplLen)
1261 if ((Buf == NULL) ||
1262 (where > Buf->BufUsed) ||
1263 (where + HowLong > Buf->BufUsed))
1266 if (where + ReplLen - HowLong > Buf->BufSize)
1267 if (IncreaseBuf(Buf, 1, Buf->BufUsed + ReplLen) < 0)
1270 memmove(Buf->buf + where + ReplLen,
1271 Buf->buf + where + HowLong,
1272 Buf->BufUsed - where - HowLong);
1274 memcpy(Buf->buf + where,
1277 Buf->BufUsed += ReplLen - HowLong;
1279 return Buf->BufUsed;
1283 * @ingroup StrBuf_Tokenizer
1284 * @brief Counts the numbmer of tokens in a buffer
1285 * @param source String to count tokens in
1286 * @param tok Tokenizer char to count
1287 * @returns numbers of tokenizer chars found
1289 int StrBufNum_tokens(const StrBuf *source, char tok)
1293 if ((source == NULL) || (source->BufUsed == 0))
1295 if ((source->BufUsed == 1) && (*source->buf == tok))
1299 pche = pch + source->BufUsed;
1310 * @ingroup StrBuf_Tokenizer
1311 * @brief a string tokenizer
1312 * @param Source StringBuffer to read into
1313 * @param parmnum n'th Parameter to remove
1314 * @param separator tokenizer character
1315 * @returns -1 if not found, else length of token.
1317 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator)
1320 char *d, *s, *end; /* dest, source */
1323 /* Find desired @parameter */
1324 end = Source->buf + Source->BufUsed;
1326 while ((d <= end) &&
1329 /* End of string, bail! */
1334 if (*d == separator) {
1339 if ((d == NULL) || (d >= end))
1340 return 0; /* @Parameter not found */
1342 /* Find next @parameter */
1344 while ((s <= end) &&
1345 (*s && *s != separator))
1349 if (*s == separator)
1353 /* Hack and slash */
1358 memmove(d, s, Source->BufUsed - (s - Source->buf));
1359 Source->BufUsed += ReducedBy;
1360 Source->buf[Source->BufUsed] = '\0';
1362 else if (d == Source->buf) {
1364 Source->BufUsed = 0;
1368 Source->BufUsed += ReducedBy;
1379 int StrBufExtract_tokenFromStr(StrBuf *dest, const char *Source, long SourceLen, int parmnum, char separator)
1381 const StrBuf Temp = {
1394 return StrBufExtract_token(dest, &Temp, parmnum, separator);
1398 * @ingroup StrBuf_Tokenizer
1399 * @brief a string tokenizer
1400 * @param dest Destination StringBuffer
1401 * @param Source StringBuffer to read into
1402 * @param parmnum n'th Parameter to extract
1403 * @param separator tokenizer character
1404 * @returns -1 if not found, else length of token.
1406 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator)
1408 const char *s, *e; //* source * /
1409 int len = 0; //* running total length of extracted string * /
1410 int current_token = 0; //* token currently being processed * /
1413 dest->buf[0] = '\0';
1419 if ((Source == NULL) || (Source->BufUsed ==0)) {
1423 e = s + Source->BufUsed;
1426 //lprintf (CTDL_DEBUG, "test >: n: %d sep: %c source: %s \n willi \n", parmnum, separator, source);
1428 while ((s < e) && !IsEmptyStr(s)) {
1429 if (*s == separator) {
1432 if (len >= dest->BufSize) {
1433 dest->BufUsed = len;
1434 if (IncreaseBuf(dest, 1, -1) < 0) {
1439 if ( (current_token == parmnum) &&
1440 (*s != separator)) {
1441 dest->buf[len] = *s;
1444 else if (current_token > parmnum) {
1450 dest->buf[len] = '\0';
1451 dest->BufUsed = len;
1453 if (current_token < parmnum) {
1454 //lprintf (CTDL_DEBUG,"test <!: %s\n", dest);
1457 //lprintf (CTDL_DEBUG,"test <: %d; %s\n", len, dest);
1466 * @ingroup StrBuf_Tokenizer
1467 * @brief a string tokenizer to fetch an integer
1468 * @param Source String containing tokens
1469 * @param parmnum n'th Parameter to extract
1470 * @param separator tokenizer character
1471 * @returns 0 if not found, else integer representation of the token
1473 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator)
1483 if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0)
1490 * @ingroup StrBuf_Tokenizer
1491 * @brief a string tokenizer to fetch a long integer
1492 * @param Source String containing tokens
1493 * @param parmnum n'th Parameter to extract
1494 * @param separator tokenizer character
1495 * @returns 0 if not found, else long integer representation of the token
1497 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator)
1507 if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0)
1515 * @ingroup StrBuf_Tokenizer
1516 * @brief a string tokenizer to fetch an unsigned long
1517 * @param Source String containing tokens
1518 * @param parmnum n'th Parameter to extract
1519 * @param separator tokenizer character
1520 * @returns 0 if not found, else unsigned long representation of the token
1522 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator)
1533 if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0) {
1537 return (unsigned long) atol(pnum);
1546 * @ingroup StrBuf_NextTokenizer
1547 * @brief a string tokenizer; Bounds checker
1548 * function to make shure whether StrBufExtract_NextToken and friends have reached the end of the string.
1549 * @param Source our tokenbuffer
1550 * @param pStart the token iterator pointer to inspect
1551 * @returns whether the revolving pointer is inside of the search range
1553 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart)
1555 if ((Source == NULL) ||
1556 (*pStart == StrBufNOTNULL) ||
1557 (Source->BufUsed == 0))
1561 if (*pStart == NULL)
1565 else if (*pStart > Source->buf + Source->BufUsed)
1569 else if (*pStart <= Source->buf)
1578 * @ingroup StrBuf_NextTokenizer
1579 * @brief a string tokenizer
1580 * @param dest Destination StringBuffer
1581 * @param Source StringBuffer to read into
1582 * @param pStart pointer to the end of the last token. Feed with NULL on start.
1583 * @param separator tokenizer
1584 * @returns -1 if not found, else length of token.
1586 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator)
1588 const char *s; /* source */
1589 const char *EndBuffer; /* end stop of source buffer */
1590 int current_token = 0; /* token currently being processed */
1591 int len = 0; /* running total length of extracted string */
1593 if ((Source == NULL) ||
1594 (Source->BufUsed == 0) )
1596 *pStart = StrBufNOTNULL;
1602 EndBuffer = Source->buf + Source->BufUsed;
1606 dest->buf[0] = '\0';
1611 *pStart = EndBuffer + 1;
1615 if (*pStart == NULL)
1617 *pStart = Source->buf; /* we're starting to examine this buffer. */
1619 else if ((*pStart < Source->buf) ||
1620 (*pStart > EndBuffer ) )
1622 return -1; /* no more tokens to find. */
1626 /* start to find the next token */
1627 while ((s <= EndBuffer) &&
1628 (current_token == 0) )
1630 if (*s == separator)
1632 /* we found the next token */
1636 if (len >= dest->BufSize)
1638 /* our Dest-buffer isn't big enough, increase it. */
1639 dest->BufUsed = len;
1641 if (IncreaseBuf(dest, 1, -1) < 0) {
1642 /* WHUT? no more mem? bail out. */
1649 if ( (current_token == 0 ) && /* are we in our target token? */
1650 (!IsEmptyStr(s) ) &&
1651 (separator != *s) ) /* don't copy the token itself */
1653 dest->buf[len] = *s; /* Copy the payload */
1654 ++len; /* remember the bigger size. */
1660 /* did we reach the end? */
1661 if ((s > EndBuffer)) {
1662 EndBuffer = StrBufNOTNULL;
1663 *pStart = EndBuffer;
1666 *pStart = s; /* remember the position for the next run */
1669 /* sanitize our extracted token */
1670 dest->buf[len] = '\0';
1671 dest->BufUsed = len;
1678 * @ingroup StrBuf_NextTokenizer
1679 * @brief a string tokenizer
1680 * @param Source StringBuffer to read from
1681 * @param pStart pointer to the end of the last token. Feed with NULL.
1682 * @param separator tokenizer character
1683 * @param nTokens number of tokens to fastforward over
1684 * @returns -1 if not found, else length of token.
1686 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens)
1688 const char *s, *EndBuffer; //* source * /
1689 int len = 0; //* running total length of extracted string * /
1690 int current_token = 0; //* token currently being processed * /
1692 if ((Source == NULL) ||
1693 (Source->BufUsed ==0)) {
1697 return Source->BufUsed;
1699 if (*pStart == NULL)
1700 *pStart = Source->buf;
1702 EndBuffer = Source->buf + Source->BufUsed;
1704 if ((*pStart < Source->buf) ||
1705 (*pStart > EndBuffer)) {
1713 //lprintf (CTDL_DEBUG, "test >: n: %d sep: %c source: %s \n willi \n", parmnum, separator, source);
1715 while ((s < EndBuffer) && !IsEmptyStr(s)) {
1716 if (*s == separator) {
1719 if (current_token >= nTokens) {
1731 * @ingroup StrBuf_NextTokenizer
1732 * @brief a string tokenizer to fetch an integer
1733 * @param Source StringBuffer to read from
1734 * @param pStart Cursor on the tokenstring
1735 * @param separator tokenizer character
1736 * @returns 0 if not found, else integer representation of the token
1738 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator)
1748 if (StrBufExtract_NextToken(&tmp, Source, pStart, separator) > 0)
1755 * @ingroup StrBuf_NextTokenizer
1756 * @brief a string tokenizer to fetch a long integer
1757 * @param Source StringBuffer to read from
1758 * @param pStart Cursor on the tokenstring
1759 * @param separator tokenizer character
1760 * @returns 0 if not found, else long integer representation of the token
1762 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator)
1772 if (StrBufExtract_NextToken(&tmp, Source, pStart, separator) > 0)
1780 * @ingroup StrBuf_NextTokenizer
1781 * @brief a string tokenizer to fetch an unsigned long
1782 * @param Source StringBuffer to read from
1783 * @param pStart Cursor on the tokenstring
1784 * @param separator tokenizer character
1785 * @returns 0 if not found, else unsigned long representation of the token
1787 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator)
1798 if (StrBufExtract_NextToken(&tmp, Source, pStart, separator) > 0) {
1802 return (unsigned long) atol(pnum);
1812 /*******************************************************************************
1813 * Escape Appending *
1814 *******************************************************************************/
1817 * @ingroup StrBuf_DeEnCoder
1818 * @brief Escape a string for feeding out as a URL while appending it to a Buffer
1819 * @param OutBuf the output buffer
1820 * @param In Buffer to encode
1821 * @param PlainIn way in from plain old c strings
1823 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn)
1825 const char *pch, *pche;
1829 if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
1831 if (PlainIn != NULL) {
1832 len = strlen(PlainIn);
1838 pche = pch + In->BufUsed;
1845 pt = OutBuf->buf + OutBuf->BufUsed;
1846 pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
1848 while (pch < pche) {
1850 IncreaseBuf(OutBuf, 1, -1);
1851 pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
1852 pt = OutBuf->buf + OutBuf->BufUsed;
1855 if((*pch >= 'a' && *pch <= 'z') ||
1856 (*pch >= '@' && *pch <= 'Z') || /* @ A-Z */
1857 (*pch >= '0' && *pch <= ':') || /* 0-9 : */
1858 (*pch == '!') || (*pch == '_') ||
1859 (*pch == ',') || (*pch == '.'))
1866 *(pt + 1) = HexList[(unsigned char)*pch][0];
1867 *(pt + 2) = HexList[(unsigned char)*pch][1];
1869 OutBuf->BufUsed += 3;
1877 * @ingroup StrBuf_DeEnCoder
1878 * @brief Escape a string for feeding out as a the username/password part of an URL while appending it to a Buffer
1879 * @param OutBuf the output buffer
1880 * @param In Buffer to encode
1881 * @param PlainIn way in from plain old c strings
1883 void StrBufUrlescUPAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn)
1885 const char *pch, *pche;
1889 if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
1891 if (PlainIn != NULL) {
1892 len = strlen(PlainIn);
1898 pche = pch + In->BufUsed;
1905 pt = OutBuf->buf + OutBuf->BufUsed;
1906 pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
1908 while (pch < pche) {
1910 IncreaseBuf(OutBuf, 1, -1);
1911 pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
1912 pt = OutBuf->buf + OutBuf->BufUsed;
1915 if((*pch >= 'a' && *pch <= 'z') ||
1916 (*pch >= 'A' && *pch <= 'Z') || /* A-Z */
1917 (*pch >= '0' && *pch <= ':') || /* 0-9 : */
1918 (*pch == '!') || (*pch == '_') ||
1919 (*pch == ',') || (*pch == '.'))
1926 *(pt + 1) = HexList[(unsigned char)*pch][0];
1927 *(pt + 2) = HexList[(unsigned char)*pch][1];
1929 OutBuf->BufUsed += 3;
1937 * @ingroup StrBuf_DeEnCoder
1938 * @brief append a string in hex encoding to the buffer
1939 * @param OutBuf the output buffer
1940 * @param In Buffer to encode
1941 * @param PlainIn way in from plain old c strings
1942 * @param PlainInLen way in from plain old c strings; maybe you've got binary data or know the length?
1944 void StrBufHexEscAppend(StrBuf *OutBuf, const StrBuf *In, const unsigned char *PlainIn, long PlainInLen)
1946 const unsigned char *pch, *pche;
1950 if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
1952 if (PlainIn != NULL) {
1954 len = strlen((const char*)PlainIn);
1961 pch = (const unsigned char*)In->buf;
1962 pche = pch + In->BufUsed;
1969 pt = OutBuf->buf + OutBuf->BufUsed;
1970 pte = OutBuf->buf + OutBuf->BufSize - 3; /**< we max append 3 chars at once plus the \0 */
1972 while (pch < pche) {
1974 IncreaseBuf(OutBuf, 1, -1);
1975 pte = OutBuf->buf + OutBuf->BufSize - 3; /**< we max append 3 chars at once plus the \0 */
1976 pt = OutBuf->buf + OutBuf->BufUsed;
1979 *pt = HexList[*pch][0];
1981 *pt = HexList[*pch][1];
1982 pt ++; pch ++; OutBuf->BufUsed += 2;
1988 * @ingroup StrBuf_DeEnCoder
1989 * @brief append a string in hex encoding to the buffer
1990 * @param OutBuf the output buffer
1991 * @param In Buffer to encode
1992 * @param PlainIn way in from plain old c strings
1994 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn)
1996 StrBufHexEscAppend(OutBuf, In, (const unsigned char*) PlainIn, -1);
2000 * @ingroup StrBuf_DeEnCoder
2001 * @brief Append a string, escaping characters which have meaning in HTML.
2003 * @param Target target buffer
2004 * @param Source source buffer; set to NULL if you just have a C-String
2005 * @param PlainIn Plain-C string to append; set to NULL if unused
2006 * @param nbsp If nonzero, spaces are converted to non-breaking spaces.
2007 * @param nolinebreaks if set to 1, linebreaks are removed from the string.
2008 * if set to 2, linebreaks are replaced by <br/>
2010 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks)
2012 const char *aptr, *eiptr;
2016 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2019 if (PlainIn != NULL) {
2021 len = strlen(PlainIn);
2026 eiptr = aptr + Source->BufUsed;
2027 len = Source->BufUsed;
2033 bptr = Target->buf + Target->BufUsed;
2034 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
2036 while (aptr < eiptr){
2038 IncreaseBuf(Target, 1, -1);
2039 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
2040 bptr = Target->buf + Target->BufUsed;
2043 memcpy(bptr, "<", 4);
2045 Target->BufUsed += 4;
2047 else if (*aptr == '>') {
2048 memcpy(bptr, ">", 4);
2050 Target->BufUsed += 4;
2052 else if (*aptr == '&') {
2053 memcpy(bptr, "&", 5);
2055 Target->BufUsed += 5;
2057 else if (*aptr == '"') {
2058 memcpy(bptr, """, 6);
2060 Target->BufUsed += 6;
2062 else if (*aptr == '\'') {
2063 memcpy(bptr, "'", 5);
2065 Target->BufUsed += 5;
2067 else if (*aptr == LB) {
2072 else if (*aptr == RB) {
2077 else if (*aptr == QU) {
2082 else if ((*aptr == 32) && (nbsp == 1)) {
2083 memcpy(bptr, " ", 6);
2085 Target->BufUsed += 6;
2087 else if ((*aptr == '\n') && (nolinebreaks == 1)) {
2088 *bptr='\0'; /* nothing */
2090 else if ((*aptr == '\n') && (nolinebreaks == 2)) {
2091 memcpy(bptr, "<br/>", 11);
2093 Target->BufUsed += 11;
2097 else if ((*aptr == '\r') && (nolinebreaks != 0)) {
2098 *bptr='\0'; /* nothing */
2108 if ((bptr = eptr - 1 ) && !IsEmptyStr(aptr) )
2110 return Target->BufUsed;
2114 * @ingroup StrBuf_DeEnCoder
2115 * @brief Append a string, escaping characters which have meaning in HTML.
2116 * Converts linebreaks into blanks; escapes single quotes
2117 * @param Target target buffer
2118 * @param Source source buffer; set to NULL if you just have a C-String
2119 * @param PlainIn Plain-C string to append; set to NULL if unused
2121 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn)
2123 const char *aptr, *eiptr;
2127 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2130 if (PlainIn != NULL) {
2132 len = strlen(PlainIn);
2137 eiptr = aptr + Source->BufUsed;
2138 len = Source->BufUsed;
2144 eptr = Target->buf + Target->BufSize - 8;
2145 tptr = Target->buf + Target->BufUsed;
2147 while (aptr < eiptr){
2149 IncreaseBuf(Target, 1, -1);
2150 eptr = Target->buf + Target->BufSize - 8;
2151 tptr = Target->buf + Target->BufUsed;
2154 if (*aptr == '\n') {
2158 else if (*aptr == '\r') {
2162 else if (*aptr == '\'') {
2168 Target->BufUsed += 5;
2181 * @ingroup StrBuf_DeEnCoder
2182 * @brief Append a string, escaping characters which have meaning in ICAL.
2184 * @param Target target buffer
2185 * @param Source source buffer; set to NULL if you just have a C-String
2186 * @param PlainIn Plain-C string to append; set to NULL if unused
2188 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn)
2190 const char *aptr, *eiptr;
2194 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2197 if (PlainIn != NULL) {
2199 len = strlen(PlainIn);
2204 eiptr = aptr + Source->BufUsed;
2205 len = Source->BufUsed;
2211 eptr = Target->buf + Target->BufSize - 8;
2212 tptr = Target->buf + Target->BufUsed;
2214 while (aptr < eiptr){
2215 if(tptr + 3 >= eptr) {
2216 IncreaseBuf(Target, 1, -1);
2217 eptr = Target->buf + Target->BufSize - 8;
2218 tptr = Target->buf + Target->BufUsed;
2221 if (*aptr == '\n') {
2228 else if (*aptr == '\r') {
2235 else if (*aptr == ',') {
2251 * @ingroup StrBuf_DeEnCoder
2252 * @brief Append a string, escaping characters which have meaning in JavaScript strings .
2254 * @param Target target buffer
2255 * @param Source source buffer; set to NULL if you just have a C-String
2256 * @param PlainIn Plain-C string to append; set to NULL if unused
2257 * @returns size of result or -1
2259 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn)
2261 const char *aptr, *eiptr;
2266 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2269 if (PlainIn != NULL) {
2271 len = strlen(PlainIn);
2276 eiptr = aptr + Source->BufUsed;
2277 len = Source->BufUsed;
2283 bptr = Target->buf + Target->BufUsed;
2284 eptr = Target->buf + Target->BufSize - 7; /* our biggest unit to put in... */
2286 while (aptr < eiptr){
2288 IncreaseBuf(Target, 1, -1);
2289 eptr = Target->buf + Target->BufSize - 7; /* our biggest unit to put in... */
2290 bptr = Target->buf + Target->BufUsed;
2294 memcpy(bptr, HKEY("\\n"));
2296 Target->BufUsed += 2;
2299 memcpy(bptr, HKEY("\\r"));
2301 Target->BufUsed += 2;
2308 Target->BufUsed += 2;
2311 if ((*(aptr + 1) == 'u') &&
2312 isxdigit(*(aptr + 2)) &&
2313 isxdigit(*(aptr + 3)) &&
2314 isxdigit(*(aptr + 4)) &&
2315 isxdigit(*(aptr + 5)))
2316 { /* oh, a unicode escaper. let it pass through. */
2317 memcpy(bptr, aptr, 6);
2320 Target->BufUsed += 6;
2328 Target->BufUsed += 2;
2336 Target->BufUsed += 2;
2343 Target->BufUsed += 2;
2350 Target->BufUsed += 2;
2353 IsUtf8Sequence = Ctdl_GetUtf8SequenceLength(aptr, eiptr);
2354 while (IsUtf8Sequence > 0){
2357 if (--IsUtf8Sequence)
2365 if ((bptr == eptr - 1 ) && !IsEmptyStr(aptr) )
2367 return Target->BufUsed;
2371 * @ingroup StrBuf_DeEnCoder
2372 * @brief Append a string, escaping characters which have meaning in HTML + json.
2374 * @param Target target buffer
2375 * @param Source source buffer; set to NULL if you just have a C-String
2376 * @param PlainIn Plain-C string to append; set to NULL if unused
2377 * @param nbsp If nonzero, spaces are converted to non-breaking spaces.
2378 * @param nolinebreaks if set to 1, linebreaks are removed from the string.
2379 * if set to 2, linebreaks are replaced by <br/>
2381 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks)
2383 const char *aptr, *eiptr;
2386 int IsUtf8Sequence = 0;
2388 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2391 if (PlainIn != NULL) {
2393 len = strlen(PlainIn);
2398 eiptr = aptr + Source->BufUsed;
2399 len = Source->BufUsed;
2405 bptr = Target->buf + Target->BufUsed;
2406 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
2408 while (aptr < eiptr){
2410 IncreaseBuf(Target, 1, -1);
2411 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
2412 bptr = Target->buf + Target->BufUsed;
2416 memcpy(bptr, HKEY("<"));
2418 Target->BufUsed += 4;
2421 memcpy(bptr, HKEY(">"));
2423 Target->BufUsed += 4;
2426 memcpy(bptr, HKEY("&"));
2428 Target->BufUsed += 5;
2441 switch (nolinebreaks) {
2443 *bptr='\0'; /* nothing */
2446 memcpy(bptr, HKEY("<br/>"));
2448 Target->BufUsed += 11;
2451 memcpy(bptr, HKEY("\\n"));
2453 Target->BufUsed += 2;
2457 switch (nolinebreaks) {
2460 *bptr='\0'; /* nothing */
2463 memcpy(bptr, HKEY("\\r"));
2465 Target->BufUsed += 2;
2475 Target->BufUsed += 2;
2478 if ((*(aptr + 1) == 'u') &&
2479 isxdigit(*(aptr + 2)) &&
2480 isxdigit(*(aptr + 3)) &&
2481 isxdigit(*(aptr + 4)) &&
2482 isxdigit(*(aptr + 5)))
2483 { /* oh, a unicode escaper. let it pass through. */
2484 memcpy(bptr, aptr, 6);
2487 Target->BufUsed += 6;
2495 Target->BufUsed += 2;
2503 Target->BufUsed += 2;
2510 Target->BufUsed += 2;
2517 Target->BufUsed += 2;
2521 memcpy(bptr, HKEY(" "));
2523 Target->BufUsed += 6;
2527 IsUtf8Sequence = Ctdl_GetUtf8SequenceLength(aptr, eiptr);
2528 while (IsUtf8Sequence > 0){
2531 if (--IsUtf8Sequence)
2539 if ((bptr = eptr - 1 ) && !IsEmptyStr(aptr) )
2541 return Target->BufUsed;
2546 * @ingroup StrBuf_DeEnCoder
2547 * @brief replace all non-Ascii characters by another
2548 * @param Buf buffer to inspect
2549 * @param repl charater to stamp over non ascii chars
2551 void StrBufAsciify(StrBuf *Buf, const char repl)
2555 for (offset = 0; offset < Buf->BufUsed; offset ++)
2556 if (!isascii(Buf->buf[offset]))
2557 Buf->buf[offset] = repl;
2562 * @ingroup StrBuf_DeEnCoder
2563 * @brief unhide special chars hidden to the HTML escaper
2564 * @param target buffer to put the unescaped string in
2565 * @param source buffer to unescape
2567 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source)
2572 if ((source == NULL) || (target == NULL) || (target->buf == NULL))
2578 FlushStrBuf(target);
2580 len = source->BufUsed;
2581 for (a = 0; a < len; ++a) {
2582 if (target->BufUsed >= target->BufSize)
2583 IncreaseBuf(target, 1, -1);
2585 if (source->buf[a] == '=') {
2586 hex[0] = source->buf[a + 1];
2587 hex[1] = source->buf[a + 2];
2590 sscanf(hex, "%02x", &b);
2591 target->buf[target->BufUsed] = b;
2592 target->buf[++target->BufUsed] = 0;
2596 target->buf[target->BufUsed] = source->buf[a];
2597 target->buf[++target->BufUsed] = 0;
2604 * @ingroup StrBuf_DeEnCoder
2605 * @brief hide special chars from the HTML escapers and friends
2606 * @param target buffer to put the escaped string in
2607 * @param source buffer to escape
2609 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source)
2614 FlushStrBuf(target);
2616 if ((source == NULL) || (target == NULL) || (target->buf == NULL))
2621 len = source->BufUsed;
2622 for (i=0; i<len; ++i) {
2623 if (target->BufUsed + 4 >= target->BufSize)
2624 IncreaseBuf(target, 1, -1);
2625 if ( (isalnum(source->buf[i])) ||
2626 (source->buf[i]=='-') ||
2627 (source->buf[i]=='_') ) {
2628 target->buf[target->BufUsed++] = source->buf[i];
2631 sprintf(&target->buf[target->BufUsed],
2633 (0xFF &source->buf[i]));
2634 target->BufUsed += 3;
2637 target->buf[target->BufUsed + 1] = '\0';
2641 /*******************************************************************************
2642 * Quoted Printable de/encoding *
2643 *******************************************************************************/
2646 * @ingroup StrBuf_DeEnCoder
2647 * @brief decode a buffer from base 64 encoding; destroys original
2648 * @param Buf Buffor to transform
2650 int StrBufDecodeBase64(StrBuf *Buf)
2658 xferbuf = (char*) malloc(Buf->BufSize);
2659 if (xferbuf == NULL)
2663 siz = CtdlDecodeBase64(xferbuf,
2673 * @ingroup StrBuf_DeEnCoder
2674 * @brief decode a buffer from base 64 encoding; destroys original
2675 * @param Buf Buffor to transform
2677 int StrBufDecodeHex(StrBuf *Buf)
2680 char *pch, *pche, *pchi;
2682 if (Buf == NULL) return -1;
2684 pch = pchi = Buf->buf;
2685 pche = pch + Buf->BufUsed;
2687 while (pchi < pche){
2688 ch = decode_hex(pchi);
2695 Buf->BufUsed = pch - Buf->buf;
2696 return Buf->BufUsed;
2700 * @ingroup StrBuf_DeEnCoder
2701 * @brief replace all chars >0x20 && < 0x7F with Mute
2702 * @param Mute char to put over invalid chars
2703 * @param Buf Buffor to transform
2705 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute)
2709 if (Buf == NULL) return -1;
2710 pch = (unsigned char *)Buf->buf;
2711 while (pch < (unsigned char *)Buf->buf + Buf->BufUsed) {
2712 if ((*pch < 0x20) || (*pch > 0x7F))
2716 return Buf->BufUsed;
2721 * @ingroup StrBuf_DeEnCoder
2722 * @brief remove escaped strings from i.e. the url string (like %20 for blanks)
2723 * @param Buf Buffer to translate
2724 * @param StripBlanks Reduce several blanks to one?
2726 long StrBufUnescape(StrBuf *Buf, int StripBlanks)
2735 while ((Buf->BufUsed > 0) && (isspace(Buf->buf[Buf->BufUsed - 1]))){
2736 Buf->buf[Buf->BufUsed - 1] = '\0';
2741 while (a < Buf->BufUsed) {
2742 if (Buf->buf[a] == '+')
2744 else if (Buf->buf[a] == '%') {
2745 /* don't let % chars through, rather truncate the input. */
2746 if (a + 2 > Buf->BufUsed) {
2751 hex[0] = Buf->buf[a + 1];
2752 hex[1] = Buf->buf[a + 2];
2755 sscanf(hex, "%02x", &b);
2756 Buf->buf[a] = (char) b;
2757 len = Buf->BufUsed - a - 2;
2759 memmove(&Buf->buf[a + 1], &Buf->buf[a + 3], len);
2771 * @ingroup StrBuf_DeEnCoder
2772 * @brief RFC2047-encode a header field if necessary.
2773 * If no non-ASCII characters are found, the string
2774 * will be copied verbatim without encoding.
2776 * @param target Target buffer.
2777 * @param source Source string to be encoded.
2778 * @returns encoded length; -1 if non success.
2780 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source)
2782 const char headerStr[] = "=?UTF-8?Q?";
2783 int need_to_encode = 0;
2787 if ((source == NULL) ||
2791 while ((i < source->BufUsed) &&
2792 (!IsEmptyStr (&source->buf[i])) &&
2793 (need_to_encode == 0)) {
2794 if (((unsigned char) source->buf[i] < 32) ||
2795 ((unsigned char) source->buf[i] > 126)) {
2801 if (!need_to_encode) {
2802 if (*target == NULL) {
2803 *target = NewStrBufPlain(source->buf, source->BufUsed);
2806 FlushStrBuf(*target);
2807 StrBufAppendBuf(*target, source, 0);
2810 return (*target)->BufUsed;
2814 if (*target == NULL)
2815 *target = NewStrBufPlain(NULL, sizeof(headerStr) + source->BufUsed * 2);
2816 else if (sizeof(headerStr) + source->BufUsed >= (*target)->BufSize)
2817 IncreaseBuf(*target, sizeof(headerStr) + source->BufUsed, 0);
2818 memcpy ((*target)->buf, headerStr, sizeof(headerStr) - 1);
2819 (*target)->BufUsed = sizeof(headerStr) - 1;
2820 for (i=0; (i < source->BufUsed); ++i) {
2821 if ((*target)->BufUsed + 4 >= (*target)->BufSize)
2822 IncreaseBuf(*target, 1, 0);
2823 ch = (unsigned char) source->buf[i];
2833 sprintf(&(*target)->buf[(*target)->BufUsed], "=%02X", ch);
2834 (*target)->BufUsed += 3;
2838 (*target)->buf[(*target)->BufUsed] = '_';
2840 (*target)->buf[(*target)->BufUsed] = ch;
2841 (*target)->BufUsed++;
2845 if ((*target)->BufUsed + 4 >= (*target)->BufSize)
2846 IncreaseBuf(*target, 1, 0);
2848 (*target)->buf[(*target)->BufUsed++] = '?';
2849 (*target)->buf[(*target)->BufUsed++] = '=';
2850 (*target)->buf[(*target)->BufUsed] = '\0';
2851 return (*target)->BufUsed;;
2856 static void AddRecipient(StrBuf *Target,
2858 StrBuf *EmailAddress,
2863 if (StrLength(Target) > 0) StrBufAppendBufPlain(Target, HKEY(", "), 0);
2864 if (strchr(ChrPtr(UserName), ',') != NULL) QuoteMe = 1;
2866 if (QuoteMe) StrBufAppendBufPlain(Target, HKEY("\""), 0);
2867 StrBufRFC2047encode(&EncBuf, UserName);
2868 StrBufAppendBuf(Target, EncBuf, 0);
2869 if (QuoteMe) StrBufAppendBufPlain(Target, HKEY("\" "), 0);
2870 else StrBufAppendBufPlain(Target, HKEY(" "), 0);
2872 if (StrLength(EmailAddress) > 0){
2873 StrBufAppendBufPlain(Target, HKEY("<"), 0);
2874 StrBufAppendBuf(Target, EmailAddress, 0); /* TODO: what about IDN???? */
2875 StrBufAppendBufPlain(Target, HKEY(">"), 0);
2881 * \brief QP encode parts of an email TO/CC/BCC vector, and strip/filter invalid parts
2882 * \param Recp Source list of email recipients
2883 * \param UserName Temporary buffer for internal use; Please provide valid buffer.
2884 * \param EmailAddress Temporary buffer for internal use; Please provide valid buffer.
2885 * \param EncBuf Temporary buffer for internal use; Please provide valid buffer.
2886 * \returns encoded & sanitized buffer with the contents of Recp; Caller owns this memory.
2888 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
2890 StrBuf *EmailAddress,
2894 const char *pch, *pche;
2895 const char *UserStart, *UserEnd, *EmailStart, *EmailEnd, *At;
2897 if ((Recp == NULL) || (StrLength(Recp) == 0))
2901 pche = pch + StrLength(Recp);
2903 if (!CheckEncode(pch, -1, pche))
2904 return NewStrBufDup(Recp);
2906 Target = NewStrBufPlain(NULL, StrLength(Recp));
2908 while ((pch != NULL) && (pch < pche))
2910 while (isspace(*pch)) pch++;
2911 UserEnd = EmailStart = EmailEnd = NULL;
2913 if ((*pch == '"') || (*pch == '\'')) {
2914 UserStart = pch + 1;
2916 UserEnd = strchr(UserStart, *pch);
2917 if (UserEnd == NULL)
2918 break; ///TODO: Userfeedback??
2919 EmailStart = UserEnd + 1;
2920 while (isspace(*EmailStart))
2922 if (UserEnd == UserStart) {
2923 UserStart = UserEnd = NULL;
2926 if (*EmailStart == '<') {
2928 EmailEnd = strchr(EmailStart, '>');
2929 if (EmailEnd == NULL)
2930 EmailEnd = strchr(EmailStart, ',');
2934 EmailEnd = strchr(EmailStart, ',');
2936 if (EmailEnd == NULL)
2943 EmailEnd = strchr(UserStart, ',');
2944 if (EmailEnd == NULL) {
2945 EmailEnd = strchr(pch, '>');
2947 if (EmailEnd != NULL) {
2957 while ((EmailEnd > UserStart) && !gt &&
2958 ((*EmailEnd == ',') ||
2959 (*EmailEnd == '>') ||
2960 (isspace(*EmailEnd))))
2962 if (*EmailEnd == '>')
2967 if (EmailEnd == UserStart)
2971 EmailStart = strchr(UserStart, '<');
2972 if ((EmailStart == NULL) || (EmailStart > EmailEnd))
2974 UserEnd = EmailStart;
2976 while ((UserEnd > UserStart) &&
2977 isspace (*(UserEnd - 1)))
2980 if (UserStart >= UserEnd)
2981 UserStart = UserEnd = NULL;
2983 else { /* this is a local recipient... no domain, just a realname */
2984 EmailStart = UserStart;
2985 At = strchr(EmailStart, '@');
2991 EmailStart = UserStart;
2997 if ((UserStart != NULL) && (UserEnd != NULL))
2998 StrBufPlain(UserName, UserStart, UserEnd - UserStart);
2999 else if ((UserStart != NULL) && (UserEnd == NULL))
3000 StrBufPlain(UserName, UserStart, UserEnd - UserStart);
3002 FlushStrBuf(UserName);
3004 if ((EmailStart != NULL) && (EmailEnd != NULL))
3005 StrBufPlain(EmailAddress, EmailStart, EmailEnd - EmailStart);
3006 else if ((EmailStart != NULL) && (EmailEnd == NULL))
3007 StrBufPlain(EmailAddress, EmailStart, EmailEnd - pche);
3009 FlushStrBuf(EmailAddress);
3011 AddRecipient(Target, UserName, EmailAddress, EncBuf);
3016 if ((pch != NULL) && (*pch == ','))
3018 if (pch != NULL) while (isspace(*pch))
3027 * @brief replaces all occurances of 'search' by 'replace'
3028 * @param buf Buffer to modify
3029 * @param search character to search
3030 * @param replace character to replace search by
3032 void StrBufReplaceChars(StrBuf *buf, char search, char replace)
3037 for (i=0; i<buf->BufUsed; i++)
3038 if (buf->buf[i] == search)
3039 buf->buf[i] = replace;
3045 * @brief removes all \\r s from the string, or replaces them with \n if its not a combination of both.
3046 * @param buf Buffer to modify
3048 void StrBufToUnixLF(StrBuf *buf)
3050 char *pche, *pchS, *pchT;
3054 pche = buf->buf + buf->BufUsed;
3055 pchS = pchT = buf->buf;
3061 if (*pchS != '\n') {
3070 buf->BufUsed = pchT - buf->buf;
3074 /*******************************************************************************
3075 * Iconv Wrapper; RFC822 de/encoding *
3076 *******************************************************************************/
3079 * @ingroup StrBuf_DeEnCoder
3080 * @brief Wrapper around iconv_open()
3081 * Our version adds aliases for non-standard Microsoft charsets
3082 * such as 'MS950', aliasing them to names like 'CP950'
3084 * @param tocode Target encoding
3085 * @param fromcode Source encoding
3086 * @param pic anonimized pointer to iconv struct
3088 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic)
3091 iconv_t ic = (iconv_t)(-1) ;
3092 ic = iconv_open(tocode, fromcode);
3093 if (ic == (iconv_t)(-1) ) {
3094 char alias_fromcode[64];
3095 if ( (strlen(fromcode) == 5) && (!strncasecmp(fromcode, "MS", 2)) ) {
3096 safestrncpy(alias_fromcode, fromcode, sizeof alias_fromcode);
3097 alias_fromcode[0] = 'C';
3098 alias_fromcode[1] = 'P';
3099 ic = iconv_open(tocode, alias_fromcode);
3102 *(iconv_t *)pic = ic;
3108 * @ingroup StrBuf_DeEnCoder
3109 * @brief find one chunk of a RFC822 encoded string
3110 * @param Buffer where to search
3111 * @param bptr where to start searching
3112 * @returns found position, NULL if none.
3114 static inline const char *FindNextEnd (const StrBuf *Buf, const char *bptr)
3117 /* Find the next ?Q? */
3118 if (Buf->BufUsed - (bptr - Buf->buf) < 6)
3121 end = strchr(bptr + 2, '?');
3126 if ((Buf->BufUsed - (end - Buf->buf) > 3) &&
3127 (((*(end + 1) == 'B') || (*(end + 1) == 'Q')) ||
3128 ((*(end + 1) == 'b') || (*(end + 1) == 'q'))) &&
3129 (*(end + 2) == '?')) {
3130 /* skip on to the end of the cluster, the next ?= */
3131 end = strstr(end + 3, "?=");
3134 /* sort of half valid encoding, try to find an end. */
3135 end = strstr(bptr, "?=");
3142 * @ingroup StrBuf_DeEnCoder
3143 * @brief convert one buffer according to the preselected iconv pointer PIC
3144 * @param ConvertBuf buffer we need to translate
3145 * @param TmpBuf To share a workbuffer over several iterations. prepare to have it filled with useless stuff afterwards.
3146 * @param pic Pointer to the iconv-session Object
3148 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic)
3154 char *ibuf; /**< Buffer of characters to be converted */
3155 char *obuf; /**< Buffer for converted characters */
3156 size_t ibuflen; /**< Length of input buffer */
3157 size_t obuflen; /**< Length of output buffer */
3160 if ((ConvertBuf == NULL) || (TmpBuf == NULL))
3163 /* since we're converting to utf-8, one glyph may take up to 6 bytes */
3164 if (ConvertBuf->BufUsed * 6 >= TmpBuf->BufSize)
3165 IncreaseBuf(TmpBuf, 0, ConvertBuf->BufUsed * 6);
3167 ic = *(iconv_t*)pic;
3168 ibuf = ConvertBuf->buf;
3169 ibuflen = ConvertBuf->BufUsed;
3171 obuflen = TmpBuf->BufSize;
3173 siz = iconv(ic, &ibuf, &ibuflen, &obuf, &obuflen);
3176 if (errno == E2BIG) {
3178 IncreaseBuf(TmpBuf, 0, 0);
3183 else if (errno == EILSEQ){
3184 /* hm, invalid utf8 sequence... what to do now? */
3185 /* An invalid multibyte sequence has been encountered in the input */
3187 else if (errno == EINVAL) {
3188 /* An incomplete multibyte sequence has been encountered in the input. */
3191 FlushStrBuf(TmpBuf);
3194 TmpBuf->BufUsed = TmpBuf->BufSize - obuflen;
3195 TmpBuf->buf[TmpBuf->BufUsed] = '\0';
3197 /* little card game: wheres the red lady? */
3198 SwapBuffers(ConvertBuf, TmpBuf);
3199 FlushStrBuf(TmpBuf);
3206 * @ingroup StrBuf_DeEnCoder
3207 * @brief catches one RFC822 encoded segment, and decodes it.
3208 * @param Target buffer to fill with result
3209 * @param DecodeMe buffer with stuff to process
3210 * @param SegmentStart points to our current segment in DecodeMe
3211 * @param SegmentEnd Points to the end of our current segment in DecodeMe
3212 * @param ConvertBuf Workbuffer shared between several iterations. Random content; needs to be valid
3213 * @param ConvertBuf2 Workbuffer shared between several iterations. Random content; needs to be valid
3214 * @param FoundCharset Characterset to default decoding to; if we find another we will overwrite it.
3216 inline static void DecodeSegment(StrBuf *Target,
3217 const StrBuf *DecodeMe,
3218 const char *SegmentStart,
3219 const char *SegmentEnd,
3221 StrBuf *ConvertBuf2,
3222 StrBuf *FoundCharset)
3228 iconv_t ic = (iconv_t)(-1);
3232 /* Now we handle foreign character sets properly encoded
3233 * in RFC2047 format.
3235 StaticBuf.buf = (char*) SegmentStart; /*< it will just be read there... */
3236 StaticBuf.BufUsed = SegmentEnd - SegmentStart;
3237 StaticBuf.BufSize = DecodeMe->BufSize - (SegmentStart - DecodeMe->buf);
3238 extract_token(charset, SegmentStart, 1, '?', sizeof charset);
3239 if (FoundCharset != NULL) {
3240 FlushStrBuf(FoundCharset);
3241 StrBufAppendBufPlain(FoundCharset, charset, -1, 0);
3243 extract_token(encoding, SegmentStart, 2, '?', sizeof encoding);
3244 StrBufExtract_token(ConvertBuf, &StaticBuf, 3, '?');
3246 *encoding = toupper(*encoding);
3247 if (*encoding == 'B') { /**< base64 */
3248 if (ConvertBuf2->BufSize < ConvertBuf->BufUsed)
3249 IncreaseBuf(ConvertBuf2, 0, ConvertBuf->BufUsed);
3250 ConvertBuf2->BufUsed = CtdlDecodeBase64(ConvertBuf2->buf,
3252 ConvertBuf->BufUsed);
3254 else if (*encoding == 'Q') { /**< quoted-printable */
3258 while (pos < ConvertBuf->BufUsed)
3260 if (ConvertBuf->buf[pos] == '_')
3261 ConvertBuf->buf[pos] = ' ';
3265 if (ConvertBuf2->BufSize < ConvertBuf->BufUsed)
3266 IncreaseBuf(ConvertBuf2, 0, ConvertBuf->BufUsed);
3268 ConvertBuf2->BufUsed = CtdlDecodeQuotedPrintable(
3271 ConvertBuf->BufUsed);
3274 StrBufAppendBuf(ConvertBuf2, ConvertBuf, 0);
3277 ctdl_iconv_open("UTF-8", charset, &ic);
3278 if (ic != (iconv_t)(-1) ) {
3280 StrBufConvert(ConvertBuf2, ConvertBuf, &ic);
3281 StrBufAppendBuf(Target, ConvertBuf2, 0);
3286 StrBufAppendBufPlain(Target, HKEY("(unreadable)"), 0);
3292 * @ingroup StrBuf_DeEnCoder
3293 * @brief Handle subjects with RFC2047 encoding such as: [deprecated old syntax!]
3294 * =?koi8-r?B?78bP0s3Mxc7JxSDXz9rE1dvO2c3JINvB0sHNySDP?=
3295 * @param Target where to put the decoded string to
3296 * @param DecodeMe buffer with encoded string
3297 * @param DefaultCharset if we don't find one, which should we use?
3298 * @param FoundCharset overrides DefaultCharset if non-empty; If we find a charset inside of the string,
3299 * put it here for later use where no string might be known.
3301 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset)
3304 StrBuf *ConvertBuf2;
3305 ConvertBuf = NewStrBufPlain(NULL, StrLength(DecodeMe));
3306 ConvertBuf2 = NewStrBufPlain(NULL, StrLength(DecodeMe));
3308 StrBuf_RFC822_2_Utf8(Target,
3314 FreeStrBuf(&ConvertBuf);
3315 FreeStrBuf(&ConvertBuf2);
3319 * @ingroup StrBuf_DeEnCoder
3320 * @brief Handle subjects with RFC2047 encoding such as:
3321 * =?koi8-r?B?78bP0s3Mxc7JxSDXz9rE1dvO2c3JINvB0sHNySDP?=
3322 * @param Target where to put the decoded string to
3323 * @param DecodeMe buffer with encoded string
3324 * @param DefaultCharset if we don't find one, which should we use?
3325 * @param FoundCharset overrides DefaultCharset if non-empty; If we find a charset inside of the string,
3326 * put it here for later use where no string might be known.
3327 * @param ConvertBuf workbuffer. feed in, you shouldn't care about its content.
3328 * @param ConvertBuf2 workbuffer. feed in, you shouldn't care about its content.
3330 void StrBuf_RFC822_2_Utf8(StrBuf *Target,
3331 const StrBuf *DecodeMe,
3332 const StrBuf* DefaultCharset,
3333 StrBuf *FoundCharset,
3335 StrBuf *ConvertBuf2)
3337 StrBuf *DecodedInvalidBuf = NULL;
3338 const StrBuf *DecodeMee = DecodeMe;
3339 const char *start, *end, *next, *nextend, *ptr = NULL;
3341 iconv_t ic = (iconv_t)(-1) ;
3346 int illegal_non_rfc2047_encoding = 0;
3349 if (DecodeMe == NULL)
3351 /* Sometimes, badly formed messages contain strings which were simply
3352 * written out directly in some foreign character set instead of
3353 * using RFC2047 encoding. This is illegal but we will attempt to
3354 * handle it anyway by converting from a user-specified default
3355 * charset to UTF-8 if we see any nonprintable characters.
3358 for (i=0; i<DecodeMe->BufUsed; ++i) {
3359 if ((DecodeMe->buf[i] < 32) || (DecodeMe->buf[i] > 126)) {
3360 illegal_non_rfc2047_encoding = 1;
3365 if ((illegal_non_rfc2047_encoding) &&
3366 (strcasecmp(ChrPtr(DefaultCharset), "UTF-8")) &&
3367 (strcasecmp(ChrPtr(DefaultCharset), "us-ascii")) )
3370 ctdl_iconv_open("UTF-8", ChrPtr(DefaultCharset), &ic);
3371 if (ic != (iconv_t)(-1) ) {
3372 DecodedInvalidBuf = NewStrBufDup(DecodeMe);
3373 StrBufConvert(DecodedInvalidBuf, ConvertBuf, &ic);///TODO: don't void const?
3374 DecodeMee = DecodedInvalidBuf;
3380 /* pre evaluate the first pair */
3382 start = strstr(DecodeMee->buf, "=?");
3383 eptr = DecodeMee->buf + DecodeMee->BufUsed;
3385 end = FindNextEnd (DecodeMee, start + 2);
3387 StrBufAppendBuf(Target, DecodeMee, 0);
3388 FreeStrBuf(&DecodedInvalidBuf);
3393 if (start != DecodeMee->buf) {
3396 nFront = start - DecodeMee->buf;
3397 StrBufAppendBufPlain(Target, DecodeMee->buf, nFront, 0);
3400 * Since spammers will go to all sorts of absurd lengths to get their
3401 * messages through, there are LOTS of corrupt headers out there.
3402 * So, prevent a really badly formed RFC2047 header from throwing
3403 * this function into an infinite loop.
3405 while ((start != NULL) &&
3412 DecodeSegment(Target,
3420 next = strstr(end, "=?");
3422 if ((next != NULL) &&
3424 nextend = FindNextEnd(DecodeMee, next);
3425 if (nextend == NULL)
3428 /* did we find two partitions */
3429 if ((next != NULL) &&
3433 while ((ptr < next) &&
3440 * did we find a gab just filled with blanks?
3441 * if not, copy its stuff over.
3445 StrBufAppendBufPlain(Target,
3451 /* our next-pair is our new first pair now. */
3457 nextend = DecodeMee->buf + DecodeMee->BufUsed;
3458 if ((end != NULL) && (end < nextend)) {
3460 while ( (ptr < nextend) &&
3467 StrBufAppendBufPlain(Target, end, nextend - end, 0);
3469 FreeStrBuf(&DecodedInvalidBuf);
3472 /*******************************************************************************
3473 * Manipulating UTF-8 Strings *
3474 *******************************************************************************/
3478 * @brief evaluate the length of an utf8 special character sequence
3479 * @param Char the character to examine
3480 * @returns width of utf8 chars in bytes; if the sequence is broken 0 is returned; 1 if its simply ASCII.
3482 static inline int Ctdl_GetUtf8SequenceLength(const char *CharS, const char *CharE)
3485 unsigned char test = (1<<7);
3487 if ((*CharS & 0xC0) != 0xC0)
3491 ((test & ((unsigned char)*CharS)) != 0))
3496 if ((n > 6) || ((CharE - CharS) < n))
3503 * @brief detect whether this char starts an utf-8 encoded char
3504 * @param Char character to inspect
3505 * @returns yes or no
3507 static inline int Ctdl_IsUtf8SequenceStart(const char Char)
3509 /** 11??.???? indicates an UTF8 Sequence. */
3510 return ((Char & 0xC0) == 0xC0);
3515 * @brief measure the number of glyphs in an UTF8 string...
3516 * @param Buf string to measure
3517 * @returns the number of glyphs in Buf
3519 long StrBuf_Utf8StrLen(StrBuf *Buf)
3525 if ((Buf == NULL) || (Buf->BufUsed == 0))
3528 eptr = Buf->buf + Buf->BufUsed;
3529 while ((aptr < eptr) && (*aptr != '\0')) {
3530 if (Ctdl_IsUtf8SequenceStart(*aptr)){
3531 m = Ctdl_GetUtf8SequenceLength(aptr, eptr);
3532 while ((aptr < eptr) && (*aptr++ != '\0')&& (m-- > 0) );
3545 * @brief cuts a string after maxlen glyphs
3546 * @param Buf string to cut to maxlen glyphs
3547 * @param maxlen how long may the string become?
3548 * @returns current length of the string
3550 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen)
3556 eptr = Buf->buf + Buf->BufUsed;
3557 while ((aptr < eptr) && (*aptr != '\0')) {
3558 if (Ctdl_IsUtf8SequenceStart(*aptr)){
3559 m = Ctdl_GetUtf8SequenceLength(aptr, eptr);
3560 while ((*aptr++ != '\0') && (m-- > 0));
3569 Buf->BufUsed = aptr - Buf->buf;
3570 return Buf->BufUsed;
3573 return Buf->BufUsed;
3581 /*******************************************************************************
3583 *******************************************************************************/
3586 #define DEF_MEM_LEVEL 8 /*< memlevel??? */
3587 #define OS_CODE 0x03 /*< unix */
3590 * @ingroup StrBuf_DeEnCoder
3591 * @brief uses the same calling syntax as compress2(), but it
3592 * creates a stream compatible with HTTP "Content-encoding: gzip"
3593 * @param dest compressed buffer
3594 * @param destLen length of the compresed data
3595 * @param source source to encode
3596 * @param sourceLen length of source to encode
3597 * @param level compression level
3599 int ZEXPORT compress_gzip(Bytef * dest,
3601 const Bytef * source,
3605 const int gz_magic[2] = { 0x1f, 0x8b }; /* gzip magic header */
3607 /* write gzip header */
3608 snprintf((char *) dest, *destLen,
3609 "%c%c%c%c%c%c%c%c%c%c",
3610 gz_magic[0], gz_magic[1], Z_DEFLATED,
3611 0 /*flags */ , 0, 0, 0, 0 /*time */ , 0 /* xflags */ ,
3614 /* normal deflate */
3617 stream.next_in = (Bytef *) source;
3618 stream.avail_in = (uInt) sourceLen;
3619 stream.next_out = dest + 10L; // after header
3620 stream.avail_out = (uInt) * destLen;
3621 if ((uLong) stream.avail_out != *destLen)
3624 stream.zalloc = (alloc_func) 0;
3625 stream.zfree = (free_func) 0;
3626 stream.opaque = (voidpf) 0;
3628 err = deflateInit2(&stream, level, Z_DEFLATED, -MAX_WBITS,
3629 DEF_MEM_LEVEL, Z_DEFAULT_STRATEGY);
3633 err = deflate(&stream, Z_FINISH);
3634 if (err != Z_STREAM_END) {
3635 deflateEnd(&stream);
3636 return err == Z_OK ? Z_BUF_ERROR : err;
3638 *destLen = stream.total_out + 10L;
3640 /* write CRC and Length */
3641 uLong crc = crc32(0L, source, sourceLen);
3643 for (n = 0; n < 4; ++n, ++*destLen) {
3644 dest[*destLen] = (int) (crc & 0xff);
3647 uLong len = stream.total_in;
3648 for (n = 0; n < 4; ++n, ++*destLen) {
3649 dest[*destLen] = (int) (len & 0xff);
3652 err = deflateEnd(&stream);
3659 * @ingroup StrBuf_DeEnCoder
3660 * @brief compress the buffer with gzip
3661 * Attention! If you feed this a Const String, you must maintain the uncompressed buffer yourself!
3662 * @param Buf buffer whose content is to be gzipped
3664 int CompressBuffer(StrBuf *Buf)
3667 char *compressed_data = NULL;
3668 size_t compressed_len, bufsize;
3671 bufsize = compressed_len = Buf->BufUsed + (Buf->BufUsed / 100) + 100;
3672 compressed_data = malloc(compressed_len);
3674 if (compressed_data == NULL)
3676 /* Flush some space after the used payload so valgrind shuts up... */
3677 while ((i < 10) && (Buf->BufUsed + i < Buf->BufSize))
3678 Buf->buf[Buf->BufUsed + i++] = '\0';
3679 if (compress_gzip((Bytef *) compressed_data,
3682 (uLongf) Buf->BufUsed, Z_BEST_SPEED) == Z_OK) {
3685 Buf->buf = compressed_data;
3686 Buf->BufUsed = compressed_len;
3687 Buf->BufSize = bufsize;
3688 /* Flush some space after the used payload so valgrind shuts up... */
3690 while ((i < 10) && (Buf->BufUsed + i < Buf->BufSize))
3691 Buf->buf[Buf->BufUsed + i++] = '\0';
3694 free(compressed_data);
3696 #endif /* HAVE_ZLIB */
3700 /*******************************************************************************
3701 * File I/O; Callbacks to libevent *
3702 *******************************************************************************/
3704 long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB)
3709 if ((FB == NULL) || (FB->Buf == NULL))
3713 * check whether the read pointer is somewhere in a range
3714 * where a cut left is inexpensive
3717 if (FB->ReadWritePointer != NULL)
3721 already_read = FB->ReadWritePointer - FB->Buf->buf;
3722 bufremain = FB->Buf->BufSize - FB->Buf->BufUsed - 1;
3724 if (already_read != 0) {
3727 unread = FB->Buf->BufUsed - already_read;
3729 /* else nothing to compact... */
3731 FB->ReadWritePointer = FB->Buf->buf;
3732 bufremain = FB->Buf->BufSize;
3734 else if ((unread < 64) ||
3735 (bufremain < already_read))
3738 * if its just a tiny bit remaining, or we run out of space...
3741 FB->Buf->BufUsed = unread;
3742 if (unread < already_read)
3743 memcpy(FB->Buf->buf, FB->ReadWritePointer, unread);
3745 memmove(FB->Buf->buf, FB->ReadWritePointer, unread);
3746 FB->ReadWritePointer = FB->Buf->buf;
3747 bufremain = FB->Buf->BufSize - unread - 1;
3749 else if (bufremain < (FB->Buf->BufSize / 10))
3751 /* get a bigger buffer */
3753 IncreaseBuf(FB->Buf, 0, FB->Buf->BufUsed + 1);
3755 FB->ReadWritePointer = FB->Buf->buf + unread;
3757 bufremain = FB->Buf->BufSize - unread - 1;
3758 /*TODO: special increase function that won't copy the already read! */
3761 else if (bufremain < 10) {
3762 IncreaseBuf(FB->Buf, 1, FB->Buf->BufUsed + 10);
3764 FB->ReadWritePointer = FB->Buf->buf;
3766 bufremain = FB->Buf->BufSize - FB->Buf->BufUsed - 1;
3771 FB->ReadWritePointer = FB->Buf->buf;
3772 bufremain = FB->Buf->BufSize - 1;
3775 n = read(fd, FB->Buf->buf + FB->Buf->BufUsed, bufremain);
3778 FB->Buf->BufUsed += n;
3779 FB->Buf->buf[FB->Buf->BufUsed] = '\0';
3784 int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB)
3789 if ((FB == NULL) || (FB->Buf == NULL))
3792 if (FB->ReadWritePointer != NULL)
3794 WriteRemain = FB->Buf->BufUsed -
3795 (FB->ReadWritePointer -
3799 FB->ReadWritePointer = FB->Buf->buf;
3800 WriteRemain = FB->Buf->BufUsed;
3803 n = write(fd, FB->ReadWritePointer, WriteRemain);
3805 FB->ReadWritePointer += n;
3807 if (FB->ReadWritePointer ==
3808 FB->Buf->buf + FB->Buf->BufUsed)
3810 FlushStrBuf(FB->Buf);
3811 FB->ReadWritePointer = NULL;
3814 // check whether we've got something to write
3815 // get the maximum chunk plus the pointer we can send
3816 // write whats there
3817 // if not all was sent, remember the send pointer for the next time
3818 return FB->ReadWritePointer - FB->Buf->buf + FB->Buf->BufUsed;
3824 * @ingroup StrBuf_IO
3825 * @brief extract a "next line" from Buf; Ptr to persist across several iterations
3826 * @param LineBuf your line will be copied here.
3827 * @param FB BLOB with lines of text...
3828 * @param Ptr moved arround to keep the next-line across several iterations
3829 * has to be &NULL on start; will be &NotNULL on end of buffer
3830 * @returns size of copied buffer
3832 eReadState StrBufChunkSipLine(StrBuf *LineBuf, IOBuffer *FB)
3834 const char *aptr, *ptr, *eptr;
3837 if ((FB == NULL) || (LineBuf == NULL) || (LineBuf->buf == NULL))
3841 if ((FB->Buf == NULL) || (FB->ReadWritePointer == StrBufNOTNULL)) {
3842 FB->ReadWritePointer = StrBufNOTNULL;
3846 FlushStrBuf(LineBuf);
3847 if (FB->ReadWritePointer == NULL)
3848 ptr = aptr = FB->Buf->buf;
3850 ptr = aptr = FB->ReadWritePointer;
3852 optr = LineBuf->buf;
3853 eptr = FB->Buf->buf + FB->Buf->BufUsed;
3854 xptr = LineBuf->buf + LineBuf->BufSize - 1;
3856 while ((ptr <= eptr) &&
3863 LineBuf->BufUsed = optr - LineBuf->buf;
3864 IncreaseBuf(LineBuf, 1, LineBuf->BufUsed + 1);
3865 optr = LineBuf->buf + LineBuf->BufUsed;
3866 xptr = LineBuf->buf + LineBuf->BufSize - 1;
3871 if (optr > LineBuf->buf)
3873 if ((*(ptr - 1) != '\r') && (*(ptr - 1) != '\n')) {
3874 LineBuf->BufUsed = optr - LineBuf->buf;
3876 if ((FB->ReadWritePointer != NULL) &&
3877 (FB->ReadWritePointer != FB->Buf->buf))
3879 /* Ok, the client application read all the data
3880 it was interested in so far. Since there is more to read,
3881 we now shrink the buffer, and move the rest over.
3883 StrBufCutLeft(FB->Buf,
3884 FB->ReadWritePointer - FB->Buf->buf);
3885 FB->ReadWritePointer = FB->Buf->buf;
3887 return eMustReadMore;
3890 LineBuf->BufUsed = optr - LineBuf->buf;
3892 if ((ptr <= eptr) && (*ptr == '\r'))
3894 if ((ptr <= eptr) && (*ptr == '\n'))
3898 FB->ReadWritePointer = ptr;
3901 FlushStrBuf(FB->Buf);
3902 FB->ReadWritePointer = NULL;
3905 return eReadSuccess;
3909 * @ingroup StrBuf_CHUNKED_IO
3910 * @brief check whether the chunk-buffer has more data waiting or not.
3911 * @param FB Chunk-Buffer to inspect
3913 eReadState StrBufCheckBuffer(IOBuffer *FB)
3917 if (FB->Buf->BufUsed == 0)
3918 return eReadSuccess;
3919 if (FB->ReadWritePointer == NULL)
3920 return eBufferNotEmpty;
3921 if (FB->Buf->buf + FB->Buf->BufUsed > FB->ReadWritePointer)
3922 return eBufferNotEmpty;
3923 return eReadSuccess;
3926 long IOBufferStrLength(IOBuffer *FB)
3928 if ((FB == NULL) || (FB->Buf == NULL))
3930 if (FB->ReadWritePointer == NULL)
3931 return StrLength(FB->Buf);
3933 return StrLength(FB->Buf) - (FB->ReadWritePointer - FB->Buf->buf);
3936 inline static void FDIOBufferFlush(FDIOBuffer *FDB)
3938 memset(FDB, 0, sizeof(FDIOBuffer));
3940 FDB->SplicePipe[0] = -1;
3941 FDB->SplicePipe[1] = -1;
3944 void FDIOBufferInit(FDIOBuffer *FDB, IOBuffer *IO, int FD, long TotalSendSize)
3946 FDIOBufferFlush(FDB);
3948 FDB->TotalSendSize = TotalSendSize;
3952 pipe(FDB->SplicePipe);
3955 FDB->ChunkBuffer = NewStrBufPlain(NULL, TotalSendSize + 1);
3960 void FDIOBufferDelete(FDIOBuffer *FDB)
3965 if (FDB->SplicePipe[0] > 0)
3966 close(FDB->SplicePipe[0]);
3967 if (FDB->SplicePipe[1] > 0)
3968 close(FDB->SplicePipe[1]);
3972 FreeStrBuf(&FDB->ChunkBuffer);
3974 if (FDB->OtherFD > 0)
3975 close(FDB->OtherFD);
3976 FDIOBufferFlush(FDB);
3979 int FileSendChunked(FDIOBuffer *FDB, const char **Err)
3981 ssize_t sent, pipesize;
3985 if (FDB->PipeSize == 0)
3987 pipesize = splice(FDB->OtherFD,
3988 &FDB->TotalSentAlready,
3991 FDB->ChunkSendRemain,
3996 *Err = strerror(errno);
3999 FDB->PipeSize = pipesize;
4001 sent = splice(FDB->SplicePipe[0],
4006 SPLICE_F_MORE | SPLICE_F_MOVE | SPLICE_F_NONBLOCK);
4009 *Err = strerror(errno);
4012 FDB->PipeSize -= sent;
4013 FDB->ChunkSendRemain -= sent;
4022 pRead = FDB->ChunkBuffer->buf;
4023 while ((FDB->ChunkBuffer->BufUsed < FDB->TotalSendSize) && (nRead >= 0))
4025 nRead = read(FDB->OtherFD, pRead, FDB->TotalSendSize - FDB->ChunkBuffer->BufUsed);
4027 FDB->ChunkBuffer->BufUsed += nRead;
4028 FDB->ChunkBuffer->buf[FDB->ChunkBuffer->BufUsed] = '\0';
4030 else if (nRead == 0) {}
4035 nRead = write(FDB->IOB->fd, FDB->ChunkBuffer->buf + FDB->TotalSentAlready, FDB->ChunkSendRemain);
4038 FDB->TotalSentAlready += nRead;
4039 FDB->ChunkSendRemain -= nRead;
4040 return FDB->ChunkSendRemain;
4048 int FileRecvChunked(FDIOBuffer *FDB, const char **Err)
4050 ssize_t sent, pipesize;
4055 if (FDB->PipeSize == 0)
4057 pipesize = splice(FDB->IOB->fd,
4061 FDB->ChunkSendRemain,
4062 SPLICE_F_MORE | SPLICE_F_MOVE|SPLICE_F_NONBLOCK);
4066 *Err = strerror(errno);
4069 FDB->PipeSize = pipesize;
4072 sent = splice(FDB->SplicePipe[0],
4075 &FDB->TotalSentAlready,
4077 SPLICE_F_MORE | SPLICE_F_MOVE);
4081 *Err = strerror(errno);
4084 FDB->PipeSize -= sent;
4085 FDB->ChunkSendRemain -= sent;
4091 sent = read(FDB->IOB->fd, FDB->ChunkBuffer->buf, FDB->ChunkSendRemain);
4096 FDB->ChunkBuffer->BufUsed = sent;
4098 while (nWritten < FDB->ChunkBuffer->BufUsed) {
4099 rc = write(FDB->OtherFD, FDB->ChunkBuffer->buf + nWritten, FDB->ChunkBuffer->BufUsed - nWritten);
4101 *Err = strerror(errno);
4107 FDB->ChunkBuffer->BufUsed = 0;
4108 FDB->TotalSentAlready += sent;
4109 FDB->ChunkSendRemain -= sent;
4110 return FDB->ChunkSendRemain;
4112 else if (sent < 0) {
4113 *Err = strerror(errno);
4120 int FileMoveChunked(FDIOBuffer *FDB, const char **Err)
4122 ssize_t sent, pipesize;
4127 if (FDB->PipeSize == 0)
4129 pipesize = splice(FDB->IOB->fd,
4130 &FDB->TotalReadAlready,
4133 FDB->ChunkSendRemain,
4134 SPLICE_F_MORE | SPLICE_F_MOVE|SPLICE_F_NONBLOCK);
4138 *Err = strerror(errno);
4141 FDB->PipeSize = pipesize;
4144 sent = splice(FDB->SplicePipe[0],
4147 &FDB->TotalSentAlready,
4149 SPLICE_F_MORE | SPLICE_F_MOVE);
4153 *Err = strerror(errno);
4156 FDB->PipeSize -= sent;
4157 FDB->ChunkSendRemain -= sent;
4163 sent = read(FDB->IOB->fd, FDB->ChunkBuffer->buf, FDB->ChunkSendRemain);
4168 FDB->ChunkBuffer->BufUsed = sent;
4170 while (nWritten < FDB->ChunkBuffer->BufUsed) {
4171 rc = write(FDB->OtherFD, FDB->ChunkBuffer->buf + nWritten, FDB->ChunkBuffer->BufUsed - nWritten);
4173 *Err = strerror(errno);
4179 FDB->ChunkBuffer->BufUsed = 0;
4180 FDB->TotalSentAlready += sent;
4181 FDB->ChunkSendRemain -= sent;
4182 return FDB->ChunkSendRemain;
4184 else if (sent < 0) {
4185 *Err = strerror(errno);
4192 eReadState WriteIOBAlreadyRead(FDIOBuffer *FDB, const char **Error)
4198 int nSuccessLess = 0;
4202 fdflags = fcntl(FDB->OtherFD, F_GETFL);
4203 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
4205 while ((FDB->IOB->ReadWritePointer - FDB->IOB->Buf->buf < FDB->IOB->Buf->BufUsed) &&
4206 (FDB->ChunkSendRemain > 0))
4209 tv.tv_sec = 1; /* selectresolution; */
4213 FD_SET(FDB->OtherFD, &rfds);
4214 if (select(FDB->OtherFD + 1, NULL, &rfds, NULL, &tv) == -1) {
4215 *Error = strerror(errno);
4219 if (IsNonBlock && ! FD_ISSET(FDB->OtherFD, &rfds)) {
4224 should_write = FDB->IOB->Buf->BufUsed -
4225 (FDB->IOB->ReadWritePointer - FDB->IOB->Buf->buf);
4226 if (should_write > FDB->ChunkSendRemain)
4227 should_write = FDB->ChunkSendRemain;
4229 rlen = write(FDB->OtherFD,
4230 FDB->IOB->ReadWritePointer,
4233 *Error = strerror(errno);
4237 FDB->TotalSentAlready += rlen;
4238 FDB->IOB->ReadWritePointer += rlen;
4239 FDB->ChunkSendRemain -= rlen;
4241 if (FDB->IOB->ReadWritePointer >= FDB->IOB->Buf->buf + FDB->IOB->Buf->BufUsed)
4243 FlushStrBuf(FDB->IOB->Buf);
4244 FDB->IOB->ReadWritePointer = NULL;
4247 if (FDB->ChunkSendRemain == 0)
4248 return eReadSuccess;
4250 return eMustReadMore;
4253 /*******************************************************************************
4254 * File I/O; Prefer buffered read since its faster! *
4255 *******************************************************************************/
4258 * @ingroup StrBuf_IO
4259 * @brief Read a line from socket
4260 * flushes and closes the FD on error
4261 * @param buf the buffer to get the input to
4262 * @param fd pointer to the filedescriptor to read
4263 * @param append Append to an existing string or replace?
4264 * @param Error strerror() on error
4265 * @returns numbers of chars read
4267 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error)
4269 int len, rlen, slen;
4271 if ((buf == NULL) || (buf->buf == NULL)) {
4272 *Error = strerror(EINVAL);
4279 slen = len = buf->BufUsed;
4281 rlen = read(*fd, &buf->buf[len], 1);
4283 *Error = strerror(errno);
4290 if (buf->buf[len] == '\n')
4292 if (buf->buf[len] != '\r')
4294 if (len + 2 >= buf->BufSize) {
4296 buf->buf[len+1] = '\0';
4297 IncreaseBuf(buf, 1, -1);
4301 buf->buf[len] = '\0';
4306 * @ingroup StrBuf_BufferedIO
4307 * @brief Read a line from socket
4308 * flushes and closes the FD on error
4309 * @param Line the line to read from the fd / I/O Buffer
4310 * @param buf the buffer to get the input to
4311 * @param fd pointer to the filedescriptor to read
4312 * @param timeout number of successless selects until we bail out
4313 * @param selectresolution how long to wait on each select
4314 * @param Error strerror() on error
4315 * @returns numbers of chars read
4317 int StrBufTCP_read_buffered_line(StrBuf *Line,
4321 int selectresolution,
4325 int nSuccessLess = 0;
4332 if (buf->BufUsed > 0) {
4333 pch = strchr(buf->buf, '\n');
4336 len = pch - buf->buf;
4337 if (len > 0 && (*(pch - 1) == '\r') )
4339 StrBufSub(Line, buf, 0, len - rlen);
4340 StrBufCutLeft(buf, len + 1);
4345 if (buf->BufSize - buf->BufUsed < 10)
4346 IncreaseBuf(buf, 1, -1);
4348 fdflags = fcntl(*fd, F_GETFL);
4349 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
4351 while ((nSuccessLess < timeout) && (pch == NULL)) {
4353 tv.tv_sec = selectresolution;
4358 if (select(*fd + 1, NULL, &rfds, NULL, &tv) == -1) {
4359 *Error = strerror(errno);
4365 if (IsNonBlock && ! FD_ISSET(*fd, &rfds)) {
4370 &buf->buf[buf->BufUsed],
4371 buf->BufSize - buf->BufUsed - 1);
4373 *Error = strerror(errno);
4378 else if (rlen > 0) {
4380 buf->BufUsed += rlen;
4381 buf->buf[buf->BufUsed] = '\0';
4382 pch = strchr(buf->buf, '\n');
4383 if ((pch == NULL) &&
4384 (buf->BufUsed + 10 > buf->BufSize) &&
4385 (IncreaseBuf(buf, 1, -1) == -1))
4393 len = pch - buf->buf;
4394 if (len > 0 && (*(pch - 1) == '\r') )
4396 StrBufSub(Line, buf, 0, len - rlen);
4397 StrBufCutLeft(buf, len + 1);
4404 static const char *ErrRBLF_PreConditionFailed="StrBufTCP_read_buffered_line_fast: Wrong arguments or invalid Filedescriptor";
4405 static const char *ErrRBLF_SelectFailed="StrBufTCP_read_buffered_line_fast: Select failed without reason";
4406 static const char *ErrRBLF_NotEnoughSentFromServer="StrBufTCP_read_buffered_line_fast: No complete line was sent from peer";
4408 * @ingroup StrBuf_BufferedIO
4409 * @brief Read a line from socket
4410 * flushes and closes the FD on error
4411 * @param Line where to append our Line read from the fd / I/O Buffer;
4412 * @param IOBuf the buffer to get the input to; lifetime pair to FD
4413 * @param Pos pointer to the current read position, should be NULL initialized on opening the FD it belongs to.!
4414 * @param fd pointer to the filedescriptor to read
4415 * @param timeout number of successless selects until we bail out
4416 * @param selectresolution how long to wait on each select
4417 * @param Error strerror() on error
4418 * @returns numbers of chars read or -1 in case of error. "\n" will become 0
4420 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
4425 int selectresolution,
4428 const char *pche = NULL;
4429 const char *pos = NULL;
4431 int len, rlen, retlen;
4432 int nSuccessLess = 0;
4434 const char *pch = NULL;
4440 if ((Line == NULL) ||
4447 *Error = ErrRBLF_PreConditionFailed;
4452 if ((IOBuf->BufUsed > 0) &&
4454 (pos < IOBuf->buf + IOBuf->BufUsed))
4458 pche = IOBuf->buf + IOBuf->BufUsed;
4462 while ((pch < pche) && (*pch != '\n'))
4464 if (Line->BufUsed + 10 > Line->BufSize)
4467 apos = pcht - Line->buf;
4469 IncreaseBuf(Line, 1, -1);
4470 pcht = Line->buf + apos;
4478 if (len > 0 && (*(pch - 1) == '\r') )
4487 if ((pch >= pche) || (*pch == '\0'))
4495 if ((pch != NULL) &&
4498 if (pch + 1 >= pche) {
4511 /* If we come here, Pos is Unset since we read everything into Line, and now go for more. */
4513 if (IOBuf->BufSize - IOBuf->BufUsed < 10)
4514 IncreaseBuf(IOBuf, 1, -1);
4516 fdflags = fcntl(*fd, F_GETFL);
4517 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
4520 while ((nSuccessLess < timeout) &&
4530 if (select((*fd) + 1, &rfds, NULL, NULL, &tv) == -1) {
4531 *Error = strerror(errno);
4535 *Error = ErrRBLF_SelectFailed;
4538 if (! FD_ISSET(*fd, &rfds) != 0) {
4544 &IOBuf->buf[IOBuf->BufUsed],
4545 IOBuf->BufSize - IOBuf->BufUsed - 1);
4547 *Error = strerror(errno);
4552 else if (rlen > 0) {
4554 pLF = IOBuf->buf + IOBuf->BufUsed;
4555 IOBuf->BufUsed += rlen;
4556 IOBuf->buf[IOBuf->BufUsed] = '\0';
4558 pche = IOBuf->buf + IOBuf->BufUsed;
4560 while ((pLF < pche) && (*pLF != '\n'))
4562 if ((pLF >= pche) || (*pLF == '\0'))
4565 if (IOBuf->BufUsed + 10 > IOBuf->BufSize)
4569 if (pLF != NULL) apos = pLF - IOBuf->buf;
4570 IncreaseBuf(IOBuf, 1, -1);
4571 if (pLF != NULL) pLF = IOBuf->buf + apos;
4585 if (len > 0 && (*(pLF - 1) == '\r') )
4587 StrBufAppendBufPlain(Line, ChrPtr(IOBuf), len, 0);
4588 if (pLF + 1 >= IOBuf->buf + IOBuf->BufUsed)
4594 return retlen + len;
4596 *Error = ErrRBLF_NotEnoughSentFromServer;
4601 static const char *ErrRBLF_BLOBPreConditionFailed="StrBufReadBLOB: Wrong arguments or invalid Filedescriptor";
4603 * @ingroup StrBuf_IO
4604 * @brief Input binary data from socket
4605 * flushes and closes the FD on error
4606 * @param Buf the buffer to get the input to
4607 * @param fd pointer to the filedescriptor to read
4608 * @param append Append to an existing string or replace?
4609 * @param nBytes the maximal number of bytes to read
4610 * @param Error strerror() on error
4611 * @returns numbers of chars read
4613 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error)
4624 if ((Buf == NULL) || (Buf->buf == NULL) || (*fd == -1))
4626 *Error = ErrRBLF_BLOBPreConditionFailed;
4631 if (Buf->BufUsed + nBytes >= Buf->BufSize)
4632 IncreaseBuf(Buf, 1, Buf->BufUsed + nBytes);
4634 ptr = Buf->buf + Buf->BufUsed;
4636 fdflags = fcntl(*fd, F_GETFL);
4637 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
4639 while ((nRead < nBytes) &&
4649 if (select(*fd + 1, &rfds, NULL, NULL, &tv) == -1) {
4650 *Error = strerror(errno);
4654 *Error = ErrRBLF_SelectFailed;
4657 if (! FD_ISSET(*fd, &rfds) != 0) {
4663 if ((rlen = read(*fd,
4665 nBytes - nRead)) == -1) {
4668 *Error = strerror(errno);
4673 Buf->BufUsed += rlen;
4675 Buf->buf[Buf->BufUsed] = '\0';
4679 const char *ErrRBB_BLOBFPreConditionFailed = "StrBufReadBLOBBuffered: to many selects; aborting.";
4680 const char *ErrRBB_too_many_selects = "StrBufReadBLOBBuffered: to many selects; aborting.";
4682 * @ingroup StrBuf_BufferedIO
4683 * @brief Input binary data from socket
4684 * flushes and closes the FD on error
4685 * @param Blob put binary thing here
4686 * @param IOBuf the buffer to get the input to
4687 * @param Pos offset inside of IOBuf
4688 * @param fd pointer to the filedescriptor to read
4689 * @param append Append to an existing string or replace?
4690 * @param nBytes the maximal number of bytes to read
4691 * @param check whether we should search for '000\n' terminators in case of timeouts
4692 * @param Error strerror() on error
4693 * @returns numbers of chars read
4695 int StrBufReadBLOBBuffered(StrBuf *Blob,
4708 int nAlreadyRead = 0;
4713 int nSuccessLess = 0;
4716 if ((Blob == NULL) ||
4723 *Error = ErrRBB_BLOBFPreConditionFailed;
4729 if (Blob->BufUsed + nBytes >= Blob->BufSize)
4730 IncreaseBuf(Blob, append, Blob->BufUsed + nBytes);
4735 rlen = pos - IOBuf->buf;
4736 rlen = IOBuf->BufUsed - rlen;
4739 if ((IOBuf->BufUsed > 0) &&
4741 (pos < IOBuf->buf + IOBuf->BufUsed))
4743 if (rlen < nBytes) {
4744 memcpy(Blob->buf + Blob->BufUsed, pos, rlen);
4745 Blob->BufUsed += rlen;
4746 Blob->buf[Blob->BufUsed] = '\0';
4747 nAlreadyRead = nRead = rlen;
4750 if (rlen >= nBytes) {
4751 memcpy(Blob->buf + Blob->BufUsed, pos, nBytes);
4752 Blob->BufUsed += nBytes;
4753 Blob->buf[Blob->BufUsed] = '\0';
4754 if (rlen == nBytes) {
4766 if (IOBuf->BufSize < nBytes - nRead)
4767 IncreaseBuf(IOBuf, 0, nBytes - nRead);
4770 fdflags = fcntl(*fd, F_GETFL);
4771 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
4779 while ((nSuccessLess < MaxTries) &&
4789 if (select(*fd + 1, &rfds, NULL, NULL, &tv) == -1) {
4790 *Error = strerror(errno);
4794 *Error = ErrRBLF_SelectFailed;
4797 if (! FD_ISSET(*fd, &rfds) != 0) {
4804 IOBuf->BufSize - (ptr - IOBuf->buf));
4808 *Error = strerror(errno);
4811 else if (rlen == 0){
4812 if ((check == NNN_TERM) &&
4814 (strncmp(IOBuf->buf + IOBuf->BufUsed - 5, "\n000\n", 5) == 0))
4816 StrBufPlain(Blob, HKEY("\n000\n"));
4817 StrBufCutRight(Blob, 5);
4818 return Blob->BufUsed;
4820 else if (!IsNonBlock)
4822 else if (nSuccessLess > MaxTries) {
4824 *Error = ErrRBB_too_many_selects;
4828 else if (rlen > 0) {
4832 IOBuf->BufUsed += rlen;
4835 if (nSuccessLess >= MaxTries) {
4837 *Error = ErrRBB_too_many_selects;
4841 if (nRead > nBytes) {
4842 *Pos = IOBuf->buf + nBytes;
4844 Blob->buf[Blob->BufUsed] = '\0';
4845 StrBufAppendBufPlain(Blob, IOBuf->buf, nBytes, 0);
4849 return nRead + nAlreadyRead;
4853 * @ingroup StrBuf_IO
4854 * @brief extract a "next line" from Buf; Ptr to persist across several iterations
4855 * @param LineBuf your line will be copied here.
4856 * @param Buf BLOB with lines of text...
4857 * @param Ptr moved arround to keep the next-line across several iterations
4858 * has to be &NULL on start; will be &NotNULL on end of buffer
4859 * @returns size of remaining buffer
4861 int StrBufSipLine(StrBuf *LineBuf, const StrBuf *Buf, const char **Ptr)
4863 const char *aptr, *ptr, *eptr;
4866 if ((Buf == NULL) ||
4867 (*Ptr == StrBufNOTNULL) ||
4869 (LineBuf->buf == NULL))
4871 *Ptr = StrBufNOTNULL;
4875 FlushStrBuf(LineBuf);
4877 ptr = aptr = Buf->buf;
4881 optr = LineBuf->buf;
4882 eptr = Buf->buf + Buf->BufUsed;
4883 xptr = LineBuf->buf + LineBuf->BufSize - 1;
4885 while ((ptr <= eptr) &&
4892 LineBuf->BufUsed = optr - LineBuf->buf;
4893 IncreaseBuf(LineBuf, 1, LineBuf->BufUsed + 1);
4894 optr = LineBuf->buf + LineBuf->BufUsed;
4895 xptr = LineBuf->buf + LineBuf->BufSize - 1;
4899 if ((ptr >= eptr) && (optr > LineBuf->buf))
4901 LineBuf->BufUsed = optr - LineBuf->buf;
4903 if ((ptr <= eptr) && (*ptr == '\r'))
4905 if ((ptr <= eptr) && (*ptr == '\n'))
4912 *Ptr = StrBufNOTNULL;
4915 return Buf->BufUsed - (ptr - Buf->buf);
4920 * @ingroup StrBuf_IO
4921 * @brief removes double slashes from pathnames
4922 * @param Dir directory string to filter
4923 * @param RemoveTrailingSlash allows / disallows trailing slashes
4925 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash)
4931 while (!IsEmptyStr(a)) {
4943 if ((RemoveTrailingSlash) &&
4949 Dir->BufUsed = b - Dir->buf;