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"
35 #include "b64/cencode.h"
36 #include "b64/cdecode.h"
52 int ZEXPORT compress_gzip(Bytef * dest, size_t * destLen,
53 const Bytef * source, uLong sourceLen, int level);
55 int BaseStrBufSize = 64;
57 int ZLibCompressionRatio = -1; /* defaults to 6 */
59 #define DEF_MEM_LEVEL 8 /*< memlevel??? */
60 #define OS_CODE 0x03 /*< unix */
61 const int gz_magic[2] = { 0x1f, 0x8b }; /* gzip magic header */
64 const char *StrBufNOTNULL = ((char*) NULL) - 1;
66 const char HexList[256][3] = {
67 "00","01","02","03","04","05","06","07","08","09","0A","0B","0C","0D","0E","0F",
68 "10","11","12","13","14","15","16","17","18","19","1A","1B","1C","1D","1E","1F",
69 "20","21","22","23","24","25","26","27","28","29","2A","2B","2C","2D","2E","2F",
70 "30","31","32","33","34","35","36","37","38","39","3A","3B","3C","3D","3E","3F",
71 "40","41","42","43","44","45","46","47","48","49","4A","4B","4C","4D","4E","4F",
72 "50","51","52","53","54","55","56","57","58","59","5A","5B","5C","5D","5E","5F",
73 "60","61","62","63","64","65","66","67","68","69","6A","6B","6C","6D","6E","6F",
74 "70","71","72","73","74","75","76","77","78","79","7A","7B","7C","7D","7E","7F",
75 "80","81","82","83","84","85","86","87","88","89","8A","8B","8C","8D","8E","8F",
76 "90","91","92","93","94","95","96","97","98","99","9A","9B","9C","9D","9E","9F",
77 "A0","A1","A2","A3","A4","A5","A6","A7","A8","A9","AA","AB","AC","AD","AE","AF",
78 "B0","B1","B2","B3","B4","B5","B6","B7","B8","B9","BA","BB","BC","BD","BE","BF",
79 "C0","C1","C2","C3","C4","C5","C6","C7","C8","C9","CA","CB","CC","CD","CE","CF",
80 "D0","D1","D2","D3","D4","D5","D6","D7","D8","D9","DA","DB","DC","DD","DE","DF",
81 "E0","E1","E2","E3","E4","E5","E6","E7","E8","E9","EA","EB","EC","ED","EE","EF",
82 "F0","F1","F2","F3","F4","F5","F6","F7","F8","F9","FA","FB","FC","FD","FE","FF"};
85 * @defgroup StrBuf Stringbuffer, A class for manipulating strings with dynamic buffers
86 * StrBuf is a versatile class, aiding the handling of dynamic strings
87 * * reduce de/reallocations
88 * * reduce the need to remeasure it
89 * * reduce scanning over the string (in @ref StrBuf_NextTokenizer "Tokenizers")
90 * * allow asyncroneous IO for line and Blob based operations
91 * * reduce the use of memove in those
92 * * Quick filling in several operations with append functions
96 * @defgroup StrBuf_DeConstructors Create/Destroy StrBufs
101 * @defgroup StrBuf_Cast Cast operators to interact with char* based code
103 * use these operators to interfere with code demanding char*;
104 * if you need to own the content, smash me. Avoid, since we loose the length information.
108 * @defgroup StrBuf_Filler Create/Replace/Append Content into a StrBuf
110 * operations to get your Strings into a StrBuf, manipulating them, or appending
113 * @defgroup StrBuf_NextTokenizer Fast tokenizer to pull tokens in sequence
115 * Quick tokenizer; demands of the user to pull its tokens in sequence
119 * @defgroup StrBuf_Tokenizer tokenizer Functions; Slow ones.
121 * versatile tokenizer; random access to tokens, but slower; Prefer the @ref StrBuf_NextTokenizer "Next Tokenizer"
125 * @defgroup StrBuf_BufferedIO Buffered IO with Asynchroneous reads and no unneeded memmoves (the fast ones)
127 * File IO to fill StrBufs; Works with work-buffer shared across several calls;
128 * External Cursor to maintain the current read position inside of the buffer
129 * the non-fast ones will use memove to keep the start of the buffer the read buffer (which is slower)
133 * @defgroup StrBuf_IO FileIO; Prefer @ref StrBuf_BufferedIO
139 * @defgroup StrBuf_DeEnCoder functions to translate the contents of a buffer
141 * these functions translate the content of a buffer into another representation;
142 * some are combined Fillers and encoders
146 * Private Structure for the Stringbuffer
149 char *buf; /**< the pointer to the dynamic buffer */
150 long BufSize; /**< how many spcae do we optain */
151 long BufUsed; /**< StNumber of Chars used excluding the trailing \\0 */
152 int ConstBuf; /**< are we just a wrapper arround a static buffer and musn't we be changed? */
154 long nIncreases; /**< for profiling; cound how many times we needed more */
155 char bt [SIZ]; /**< Stacktrace of last increase */
156 char bt_lastinc [SIZ]; /**< How much did we increase last time? */
161 static inline int Ctdl_GetUtf8SequenceLength(const char *CharS, const char *CharE);
162 static inline int Ctdl_IsUtf8SequenceStart(const char Char);
165 #ifdef HAVE_BACKTRACE
166 static void StrBufBacktrace(StrBuf *Buf, int which)
170 void *stack_frames[50];
175 pstart = pch = Buf->bt;
177 pstart = pch = Buf->bt_lastinc;
178 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
179 strings = backtrace_symbols(stack_frames, size);
180 for (i = 0; i < size; i++) {
182 n = snprintf(pch, SIZ - (pch - pstart), "%s\\n", strings[i]);
184 n = snprintf(pch, SIZ - (pch - pstart), "%p\\n", stack_frames[i]);
193 void dbg_FreeStrBuf(StrBuf *FreeMe, char *FromWhere)
195 if (hFreeDbglog == -1){
196 pid_t pid = getpid();
198 snprintf(path, SIZ, "/tmp/libcitadel_strbuf_realloc.log.%d", pid);
199 hFreeDbglog = open(path, O_APPEND|O_CREAT|O_WRONLY);
201 if ((*FreeMe)->nIncreases > 0)
205 n = snprintf(buf, SIZ * 3, "%c+|%ld|%ld|%ld|%s|%s|\n",
207 (*FreeMe)->nIncreases,
211 (*FreeMe)->bt_lastinc);
212 n = write(hFreeDbglog, buf, n);
218 n = snprintf(buf, 128, "%c_|0|%ld%ld|\n",
222 n = write(hFreeDbglog, buf, n);
226 void dbg_IncreaseBuf(StrBuf *IncMe)
229 #ifdef HAVE_BACKTRACE
230 StrBufBacktrace(Buf, 1);
234 void dbg_Init(StrBuf *Buf)
238 Buf->bt_lastinc[0] = '\0';
239 #ifdef HAVE_BACKTRACE
240 StrBufBacktrace(Buf, 0);
246 #define dbg_FreeStrBuf(a, b)
247 #define dbg_IncreaseBuf(a)
254 * @brief swaps the contents of two StrBufs
255 * this is to be used to have cheap switched between a work-buffer and a target buffer
257 * @param B second one
259 static inline void SwapBuffers(StrBuf *A, StrBuf *B)
263 memcpy(&C, A, sizeof(*A));
264 memcpy(A, B, sizeof(*B));
265 memcpy(B, &C, sizeof(C));
270 * @ingroup StrBuf_Cast
271 * @brief Cast operator to Plain String
272 * @note if the buffer is altered by StrBuf operations, this pointer may become
273 * invalid. So don't lean on it after altering the buffer!
274 * Since this operation is considered cheap, rather call it often than risking
275 * your pointer to become invalid!
276 * @param Str the string we want to get the c-string representation for
277 * @returns the Pointer to the Content. Don't mess with it!
279 inline const char *ChrPtr(const StrBuf *Str)
287 * @ingroup StrBuf_Cast
288 * @brief since we know strlen()'s result, provide it here.
289 * @param Str the string to return the length to
290 * @returns contentlength of the buffer
292 inline int StrLength(const StrBuf *Str)
294 return (Str != NULL) ? Str->BufUsed : 0;
298 * @ingroup StrBuf_DeConstructors
299 * @brief local utility function to resize the buffer
300 * @param Buf the buffer whichs storage we should increase
301 * @param KeepOriginal should we copy the original buffer or just start over with a new one
302 * @param DestSize what should fit in after?
304 static int IncreaseBuf(StrBuf *Buf, int KeepOriginal, int DestSize)
307 size_t NewSize = Buf->BufSize * 2;
313 while ((NewSize <= DestSize) && (NewSize != 0))
319 NewBuf= (char*) malloc(NewSize);
323 if (KeepOriginal && (Buf->BufUsed > 0))
325 memcpy(NewBuf, Buf->buf, Buf->BufUsed);
334 Buf->BufSize = NewSize;
336 dbg_IncreaseBuf(Buf);
342 * @ingroup StrBuf_DeConstructors
343 * @brief shrink / increase an _EMPTY_ buffer to NewSize. Buffercontent is thoroughly ignored and flushed.
344 * @param Buf Buffer to shrink (has to be empty)
345 * @param ThreshHold if the buffer is bigger then this, its readjusted
346 * @param NewSize if we Shrink it, how big are we going to be afterwards?
348 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize)
351 (Buf->BufUsed == 0) &&
352 (Buf->BufSize < ThreshHold)) {
354 Buf->buf = (char*) malloc(NewSize);
356 Buf->BufSize = NewSize;
361 * @ingroup StrBuf_DeConstructors
362 * @brief shrink long term buffers to their real size so they don't waste memory
363 * @param Buf buffer to shrink
364 * @param Force if not set, will just executed if the buffer is much to big; set for lifetime strings
365 * @returns physical size of the buffer
367 long StrBufShrinkToFit(StrBuf *Buf, int Force)
372 (Buf->BufUsed + (Buf->BufUsed / 3) > Buf->BufSize))
376 TmpBuf = (char*) malloc(Buf->BufUsed + 1);
380 memcpy (TmpBuf, Buf->buf, Buf->BufUsed + 1);
381 Buf->BufSize = Buf->BufUsed + 1;
389 * @ingroup StrBuf_DeConstructors
390 * @brief Allocate a new buffer with default buffer size
391 * @returns the new stringbuffer
393 StrBuf* NewStrBuf(void)
397 NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
401 NewBuf->buf = (char*) malloc(BaseStrBufSize);
402 if (NewBuf->buf == NULL)
407 NewBuf->buf[0] = '\0';
408 NewBuf->BufSize = BaseStrBufSize;
410 NewBuf->ConstBuf = 0;
418 * @ingroup StrBuf_DeConstructors
419 * @brief Copy Constructor; returns a duplicate of CopyMe
420 * @param CopyMe Buffer to faxmilate
421 * @returns the new stringbuffer
423 StrBuf* NewStrBufDup(const StrBuf *CopyMe)
430 NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
434 NewBuf->buf = (char*) malloc(CopyMe->BufSize);
435 if (NewBuf->buf == NULL)
441 memcpy(NewBuf->buf, CopyMe->buf, CopyMe->BufUsed + 1);
442 NewBuf->BufUsed = CopyMe->BufUsed;
443 NewBuf->BufSize = CopyMe->BufSize;
444 NewBuf->ConstBuf = 0;
452 * @ingroup StrBuf_DeConstructors
453 * @brief Copy Constructor; CreateRelpaceMe will contain CopyFlushMe afterwards.
454 * @param NoMe if non-NULL, we will use that buffer as value; KeepOriginal will abused as len.
455 * @param CopyFlushMe Buffer to faxmilate if KeepOriginal, or to move into CreateRelpaceMe if !KeepOriginal.
456 * @param CreateRelpaceMe If NULL, will be created, else Flushed and filled CopyFlushMe
457 * @param KeepOriginal should CopyFlushMe remain intact? or may we Steal its buffer?
458 * @returns the new stringbuffer
460 void NewStrBufDupAppendFlush(StrBuf **CreateRelpaceMe, StrBuf *CopyFlushMe, const char *NoMe, int KeepOriginal)
464 if (CreateRelpaceMe == NULL)
469 if (*CreateRelpaceMe != NULL)
470 StrBufPlain(*CreateRelpaceMe, NoMe, KeepOriginal);
472 *CreateRelpaceMe = NewStrBufPlain(NoMe, KeepOriginal);
476 if (CopyFlushMe == NULL)
478 if (*CreateRelpaceMe != NULL)
479 FlushStrBuf(*CreateRelpaceMe);
481 *CreateRelpaceMe = NewStrBuf();
486 * Randomly Chosen: bigger than 64 chars is cheaper to swap the buffers instead of copying.
487 * else *CreateRelpaceMe may use more memory than needed in a longer term, CopyFlushMe might
488 * be a big IO-Buffer...
490 if (KeepOriginal || (StrLength(CopyFlushMe) < 256))
492 if (*CreateRelpaceMe == NULL)
494 *CreateRelpaceMe = NewBuf = NewStrBufPlain(NULL, CopyFlushMe->BufUsed);
499 NewBuf = *CreateRelpaceMe;
502 StrBufAppendBuf(NewBuf, CopyFlushMe, 0);
506 if (*CreateRelpaceMe == NULL)
508 *CreateRelpaceMe = NewBuf = NewStrBufPlain(NULL, CopyFlushMe->BufUsed);
512 NewBuf = *CreateRelpaceMe;
513 SwapBuffers (NewBuf, CopyFlushMe);
516 FlushStrBuf(CopyFlushMe);
521 * @ingroup StrBuf_DeConstructors
522 * @brief create a new Buffer using an existing c-string
523 * this function should also be used if you want to pre-suggest
524 * the buffer size to allocate in conjunction with ptr == NULL
525 * @param ptr the c-string to copy; may be NULL to create a blank instance
526 * @param nChars How many chars should we copy; -1 if we should measure the length ourselves
527 * @returns the new stringbuffer
529 StrBuf* NewStrBufPlain(const char* ptr, int nChars)
532 size_t Siz = BaseStrBufSize;
535 NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
540 CopySize = strlen((ptr != NULL)?ptr:"");
544 while ((Siz <= CopySize) && (Siz != 0))
553 NewBuf->buf = (char*) malloc(Siz);
554 if (NewBuf->buf == NULL)
559 NewBuf->BufSize = Siz;
561 memcpy(NewBuf->buf, ptr, CopySize);
562 NewBuf->buf[CopySize] = '\0';
563 NewBuf->BufUsed = CopySize;
566 NewBuf->buf[0] = '\0';
569 NewBuf->ConstBuf = 0;
577 * @ingroup StrBuf_DeConstructors
578 * @brief Set an existing buffer from a c-string
579 * @param Buf buffer to load
580 * @param ptr c-string to put into
581 * @param nChars set to -1 if we should work 0-terminated
582 * @returns the new length of the string
584 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars)
599 CopySize = strlen(ptr);
603 while ((Siz <= CopySize) && (Siz != 0))
611 if (Siz != Buf->BufSize)
612 IncreaseBuf(Buf, 0, Siz);
613 memcpy(Buf->buf, ptr, CopySize);
614 Buf->buf[CopySize] = '\0';
615 Buf->BufUsed = CopySize;
622 * @ingroup StrBuf_DeConstructors
623 * @brief use strbuf as wrapper for a string constant for easy handling
624 * @param StringConstant a string to wrap
625 * @param SizeOfStrConstant should be sizeof(StringConstant)-1
627 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant)
631 NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
634 NewBuf->buf = (char*) StringConstant;
635 NewBuf->BufSize = SizeOfStrConstant;
636 NewBuf->BufUsed = SizeOfStrConstant;
637 NewBuf->ConstBuf = 1;
646 * @ingroup StrBuf_DeConstructors
647 * @brief flush the content of a Buf; keep its struct
648 * @param buf Buffer to flush
650 int FlushStrBuf(StrBuf *buf)
652 if ((buf == NULL) || (buf->buf == NULL))
662 * @ingroup StrBuf_DeConstructors
663 * @brief wipe the content of a Buf thoroughly (overwrite it -> expensive); keep its struct
664 * @param buf Buffer to wipe
666 int FLUSHStrBuf(StrBuf *buf)
672 if (buf->BufUsed > 0) {
673 memset(buf->buf, 0, buf->BufUsed);
680 int hFreeDbglog = -1;
683 * @ingroup StrBuf_DeConstructors
684 * @brief Release a Buffer
685 * Its a double pointer, so it can NULL your pointer
686 * so fancy SIG11 appear instead of random results
687 * @param FreeMe Pointer Pointer to the buffer to free
689 void FreeStrBuf (StrBuf **FreeMe)
694 dbg_FreeStrBuf(FreeMe, 'F');
696 if (!(*FreeMe)->ConstBuf)
697 free((*FreeMe)->buf);
703 * @ingroup StrBuf_DeConstructors
704 * @brief flatten a Buffer to the Char * we return
705 * Its a double pointer, so it can NULL your pointer
706 * so fancy SIG11 appear instead of random results
707 * The Callee then owns the buffer and is responsible for freeing it.
708 * @param SmashMe Pointer Pointer to the buffer to release Buf from and free
709 * @returns the pointer of the buffer; Callee owns the memory thereafter.
711 char *SmashStrBuf (StrBuf **SmashMe)
715 if ((SmashMe == NULL) || (*SmashMe == NULL))
718 dbg_FreeStrBuf(SmashMe, 'S');
720 Ret = (*SmashMe)->buf;
727 * @ingroup StrBuf_DeConstructors
728 * @brief Release the buffer
729 * If you want put your StrBuf into a Hash, use this as Destructor.
730 * @param VFreeMe untyped pointer to a StrBuf. be shure to do the right thing [TM]
732 void HFreeStrBuf (void *VFreeMe)
734 StrBuf *FreeMe = (StrBuf*)VFreeMe;
738 dbg_FreeStrBuf(SmashMe, 'H');
740 if (!FreeMe->ConstBuf)
746 /*******************************************************************************
747 * Simple string transformations *
748 *******************************************************************************/
752 * @brief Wrapper around atol
754 long StrTol(const StrBuf *Buf)
759 return atol(Buf->buf);
766 * @brief Wrapper around atoi
768 int StrToi(const StrBuf *Buf)
772 if (Buf->BufUsed > 0)
773 return atoi(Buf->buf);
780 * @brief Checks to see if the string is a pure number
781 * @param Buf The buffer to inspect
782 * @returns 1 if its a pure number, 0, if not.
784 int StrBufIsNumber(const StrBuf *Buf) {
786 if ((Buf == NULL) || (Buf->BufUsed == 0)) {
789 strtoll(Buf->buf, &pEnd, 10);
790 if (pEnd == Buf->buf)
792 if ((pEnd != NULL) && (pEnd == Buf->buf + Buf->BufUsed))
794 if (Buf->buf == pEnd)
800 * @ingroup StrBuf_Filler
801 * @brief modifies a Single char of the Buf
802 * You can point to it via char* or a zero-based integer
803 * @param Buf The buffer to manipulate
804 * @param ptr char* to zero; use NULL if unused
805 * @param nThChar zero based pointer into the string; use -1 if unused
806 * @param PeekValue The Character to place into the position
808 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue)
813 nThChar = ptr - Buf->buf;
814 if ((nThChar < 0) || (nThChar > Buf->BufUsed))
816 Buf->buf[nThChar] = PeekValue;
821 * @ingroup StrBuf_Filler
822 * @brief modifies a range of chars of the Buf
823 * You can point to it via char* or a zero-based integer
824 * @param Buf The buffer to manipulate
825 * @param ptr char* to zero; use NULL if unused
826 * @param nThChar zero based pointer into the string; use -1 if unused
827 * @param nChars how many chars are to be flushed?
828 * @param PookValue The Character to place into that area
830 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue)
835 nThChar = ptr - Buf->buf;
836 if ((nThChar < 0) || (nThChar > Buf->BufUsed))
838 if (nThChar + nChars > Buf->BufUsed)
839 nChars = Buf->BufUsed - nThChar;
841 memset(Buf->buf + nThChar, PookValue, nChars);
842 /* just to be shure... */
843 Buf->buf[Buf->BufUsed] = 0;
848 * @ingroup StrBuf_Filler
849 * @brief Append a StringBuffer to the buffer
850 * @param Buf Buffer to modify
851 * @param AppendBuf Buffer to copy at the end of our buffer
852 * @param Offset Should we start copying from an offset?
854 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset)
856 if ((AppendBuf == NULL) || (AppendBuf->buf == NULL) ||
857 (Buf == NULL) || (Buf->buf == NULL))
860 if (Buf->BufSize - Offset < AppendBuf->BufUsed + Buf->BufUsed + 1)
863 AppendBuf->BufUsed + Buf->BufUsed);
865 memcpy(Buf->buf + Buf->BufUsed,
866 AppendBuf->buf + Offset,
867 AppendBuf->BufUsed - Offset);
868 Buf->BufUsed += AppendBuf->BufUsed - Offset;
869 Buf->buf[Buf->BufUsed] = '\0';
874 * @ingroup StrBuf_Filler
875 * @brief Append a C-String to the buffer
876 * @param Buf Buffer to modify
877 * @param AppendBuf Buffer to copy at the end of our buffer
878 * @param AppendSize number of bytes to copy; set to -1 if we should count it in advance
879 * @param Offset Should we start copying from an offset?
881 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset)
884 long BufSizeRequired;
886 if ((AppendBuf == NULL) || (Buf == NULL))
890 aps = strlen(AppendBuf + Offset);
892 aps = AppendSize - Offset;
894 BufSizeRequired = Buf->BufUsed + aps + 1;
895 if (Buf->BufSize <= BufSizeRequired)
896 IncreaseBuf(Buf, (Buf->BufUsed > 0), BufSizeRequired);
898 memcpy(Buf->buf + Buf->BufUsed,
902 Buf->buf[Buf->BufUsed] = '\0';
906 * @ingroup StrBuf_Filler
907 * @brief sprintf like function appending the formated string to the buffer
908 * vsnprintf version to wrap into own calls
909 * @param Buf Buffer to extend by format and Params
910 * @param format printf alike format to add
911 * @param ap va_list containing the items for format
913 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap)
921 if ((Buf == NULL) || (format == NULL))
924 BufSize = Buf->BufSize;
925 nWritten = Buf->BufSize + 1;
926 Offset = Buf->BufUsed;
927 newused = Offset + nWritten;
929 while (newused >= BufSize) {
931 nWritten = vsnprintf(Buf->buf + Offset,
932 Buf->BufSize - Offset,
935 newused = Offset + nWritten;
936 if (newused >= Buf->BufSize) {
937 if (IncreaseBuf(Buf, 1, newused) == -1)
938 return; /* TODO: error handling? */
939 newused = Buf->BufSize + 1;
942 Buf->BufUsed = Offset + nWritten;
943 BufSize = Buf->BufSize;
950 * @ingroup StrBuf_Filler
951 * @brief sprintf like function appending the formated string to the buffer
952 * @param Buf Buffer to extend by format and Params
953 * @param format printf alike format to add
955 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...)
963 if ((Buf == NULL) || (format == NULL))
966 BufSize = Buf->BufSize;
967 nWritten = Buf->BufSize + 1;
968 Offset = Buf->BufUsed;
969 newused = Offset + nWritten;
971 while (newused >= BufSize) {
972 va_start(arg_ptr, format);
973 nWritten = vsnprintf(Buf->buf + Buf->BufUsed,
974 Buf->BufSize - Buf->BufUsed,
977 newused = Buf->BufUsed + nWritten;
978 if (newused >= Buf->BufSize) {
979 if (IncreaseBuf(Buf, 1, newused) == -1)
980 return; /* TODO: error handling? */
981 newused = Buf->BufSize + 1;
984 Buf->BufUsed += nWritten;
985 BufSize = Buf->BufSize;
992 * @ingroup StrBuf_Filler
993 * @brief sprintf like function putting the formated string into the buffer
994 * @param Buf Buffer to extend by format and Parameters
995 * @param format printf alike format to add
997 void StrBufPrintf(StrBuf *Buf, const char *format, ...)
1002 if ((Buf == NULL) || (format == NULL))
1005 nWritten = Buf->BufSize + 1;
1006 while (nWritten >= Buf->BufSize) {
1007 va_start(arg_ptr, format);
1008 nWritten = vsnprintf(Buf->buf, Buf->BufSize, format, arg_ptr);
1010 if (nWritten >= Buf->BufSize) {
1011 if (IncreaseBuf(Buf, 0, 0) == -1)
1012 return; /* TODO: error handling? */
1013 nWritten = Buf->BufSize + 1;
1016 Buf->BufUsed = nWritten ;
1021 * @ingroup StrBuf_Filler
1022 * @brief Callback for cURL to append the webserver reply to a buffer
1023 * @param ptr pre-defined by the cURL API; see man 3 curl for mre info
1024 * @param size pre-defined by the cURL API; see man 3 curl for mre info
1025 * @param nmemb pre-defined by the cURL API; see man 3 curl for mre info
1026 * @param stream pre-defined by the cURL API; see man 3 curl for mre info
1028 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream)
1037 StrBufAppendBufPlain(Target, ptr, size * nmemb, 0);
1038 return size * nmemb;
1044 * @brief extracts a substring from Source into dest
1045 * @param dest buffer to place substring into
1046 * @param Source string to copy substring from
1047 * @param Offset chars to skip from start
1048 * @param nChars number of chars to copy
1049 * @returns the number of chars copied; may be different from nChars due to the size of Source
1051 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars)
1053 size_t NCharsRemain;
1054 if (Offset > Source->BufUsed)
1060 if (Offset + nChars < Source->BufUsed)
1062 if ((nChars >= dest->BufSize) &&
1063 (IncreaseBuf(dest, 0, nChars + 1) == -1))
1065 memcpy(dest->buf, Source->buf + Offset, nChars);
1066 dest->BufUsed = nChars;
1067 dest->buf[dest->BufUsed] = '\0';
1070 NCharsRemain = Source->BufUsed - Offset;
1071 if ((NCharsRemain >= dest->BufSize) &&
1072 (IncreaseBuf(dest, 0, NCharsRemain + 1) == -1))
1074 memcpy(dest->buf, Source->buf + Offset, NCharsRemain);
1075 dest->BufUsed = NCharsRemain;
1076 dest->buf[dest->BufUsed] = '\0';
1077 return NCharsRemain;
1082 * @brief Cut nChars from the start of the string
1083 * @param Buf Buffer to modify
1084 * @param nChars how many chars should be skipped?
1086 void StrBufCutLeft(StrBuf *Buf, int nChars)
1088 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1089 if (nChars >= Buf->BufUsed) {
1093 memmove(Buf->buf, Buf->buf + nChars, Buf->BufUsed - nChars);
1094 Buf->BufUsed -= nChars;
1095 Buf->buf[Buf->BufUsed] = '\0';
1100 * @brief Cut the trailing n Chars from the string
1101 * @param Buf Buffer to modify
1102 * @param nChars how many chars should be trunkated?
1104 void StrBufCutRight(StrBuf *Buf, int nChars)
1106 if ((Buf == NULL) || (Buf->BufUsed == 0) || (Buf->buf == NULL))
1109 if (nChars >= Buf->BufUsed) {
1113 Buf->BufUsed -= nChars;
1114 Buf->buf[Buf->BufUsed] = '\0';
1119 * @brief Cut the string after n Chars
1120 * @param Buf Buffer to modify
1121 * @param AfternChars after how many chars should we trunkate the string?
1122 * @param At if non-null and points inside of our string, cut it there.
1124 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At)
1126 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1128 AfternChars = At - Buf->buf;
1131 if ((AfternChars < 0) || (AfternChars >= Buf->BufUsed))
1133 Buf->BufUsed = AfternChars;
1134 Buf->buf[Buf->BufUsed] = '\0';
1140 * @brief Strip leading and trailing spaces from a string; with premeasured and adjusted length.
1141 * @param Buf the string to modify
1143 void StrBufTrim(StrBuf *Buf)
1146 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1148 while ((Buf->BufUsed > 0) &&
1149 isspace(Buf->buf[Buf->BufUsed - 1]))
1153 Buf->buf[Buf->BufUsed] = '\0';
1155 if (Buf->BufUsed == 0) return;
1157 while ((Buf->BufUsed > delta) && (isspace(Buf->buf[delta]))){
1160 if (delta > 0) StrBufCutLeft(Buf, delta);
1164 * @brief changes all spaces in the string (tab, linefeed...) to Blank (0x20)
1165 * @param Buf the string to modify
1167 void StrBufSpaceToBlank(StrBuf *Buf)
1171 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1174 pche = pch + Buf->BufUsed;
1183 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary)
1188 if ((Buf == NULL) || (Buf->buf == NULL)) {
1192 pRight = strchr(Buf->buf, rightboundary);
1193 if (pRight != NULL) {
1194 StrBufCutAt(Buf, 0, pRight);
1197 pLeft = strrchr(ChrPtr(Buf), leftboundary);
1198 if (pLeft != NULL) {
1199 StrBufCutLeft(Buf, pLeft - Buf->buf + 1);
1205 * @ingroup StrBuf_Filler
1206 * @brief uppercase the contents of a buffer
1207 * @param Buf the buffer to translate
1209 void StrBufUpCase(StrBuf *Buf)
1213 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1216 pche = pch + Buf->BufUsed;
1217 while (pch < pche) {
1218 *pch = toupper(*pch);
1225 * @ingroup StrBuf_Filler
1226 * @brief lowercase the contents of a buffer
1227 * @param Buf the buffer to translate
1229 void StrBufLowerCase(StrBuf *Buf)
1233 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1236 pche = pch + Buf->BufUsed;
1237 while (pch < pche) {
1238 *pch = tolower(*pch);
1244 /*******************************************************************************
1245 * a tokenizer that kills, maims, and destroys *
1246 *******************************************************************************/
1249 * @ingroup StrBuf_Tokenizer
1250 * @brief Replace a token at a given place with a given length by another token with given length
1251 * @param Buf String where to work on
1252 * @param where where inside of the Buf is the search-token
1253 * @param HowLong How long is the token to be replaced
1254 * @param Repl Token to insert at 'where'
1255 * @param ReplLen Length of repl
1256 * @returns -1 if fail else length of resulting Buf
1258 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong,
1259 const char *Repl, long ReplLen)
1262 if ((Buf == NULL) ||
1263 (where > Buf->BufUsed) ||
1264 (where + HowLong > Buf->BufUsed))
1267 if (where + ReplLen - HowLong > Buf->BufSize)
1268 if (IncreaseBuf(Buf, 1, Buf->BufUsed + ReplLen) < 0)
1271 memmove(Buf->buf + where + ReplLen,
1272 Buf->buf + where + HowLong,
1273 Buf->BufUsed - where - HowLong);
1275 memcpy(Buf->buf + where,
1278 Buf->BufUsed += ReplLen - HowLong;
1280 return Buf->BufUsed;
1284 * @ingroup StrBuf_Tokenizer
1285 * @brief Counts the numbmer of tokens in a buffer
1286 * @param source String to count tokens in
1287 * @param tok Tokenizer char to count
1288 * @returns numbers of tokenizer chars found
1290 int StrBufNum_tokens(const StrBuf *source, char tok)
1294 if ((source == NULL) || (source->BufUsed == 0))
1296 if ((source->BufUsed == 1) && (*source->buf == tok))
1300 pche = pch + source->BufUsed;
1311 * @ingroup StrBuf_Tokenizer
1312 * @brief a string tokenizer
1313 * @param Source StringBuffer to read into
1314 * @param parmnum n'th Parameter to remove
1315 * @param separator tokenizer character
1316 * @returns -1 if not found, else length of token.
1318 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator)
1321 char *d, *s, *end; /* dest, source */
1324 /* Find desired @parameter */
1325 end = Source->buf + Source->BufUsed;
1327 while ((d <= end) &&
1330 /* End of string, bail! */
1335 if (*d == separator) {
1340 if ((d == NULL) || (d >= end))
1341 return 0; /* @Parameter not found */
1343 /* Find next @parameter */
1345 while ((s <= end) &&
1346 (*s && *s != separator))
1350 if (*s == separator)
1354 /* Hack and slash */
1359 memmove(d, s, Source->BufUsed - (s - Source->buf));
1360 Source->BufUsed += ReducedBy;
1361 Source->buf[Source->BufUsed] = '\0';
1363 else if (d == Source->buf) {
1365 Source->BufUsed = 0;
1369 Source->BufUsed += ReducedBy;
1380 int StrBufExtract_tokenFromStr(StrBuf *dest, const char *Source, long SourceLen, int parmnum, char separator)
1382 const StrBuf Temp = {
1395 return StrBufExtract_token(dest, &Temp, parmnum, separator);
1399 * @ingroup StrBuf_Tokenizer
1400 * @brief a string tokenizer
1401 * @param dest Destination StringBuffer
1402 * @param Source StringBuffer to read into
1403 * @param parmnum n'th Parameter to extract
1404 * @param separator tokenizer character
1405 * @returns -1 if not found, else length of token.
1407 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator)
1409 const char *s, *e; //* source * /
1410 int len = 0; //* running total length of extracted string * /
1411 int current_token = 0; //* token currently being processed * /
1414 dest->buf[0] = '\0';
1420 if ((Source == NULL) || (Source->BufUsed ==0)) {
1424 e = s + Source->BufUsed;
1427 //lprintf (CTDL_DEBUG, "test >: n: %d sep: %c source: %s \n willi \n", parmnum, separator, source);
1429 while ((s < e) && !IsEmptyStr(s)) {
1430 if (*s == separator) {
1433 if (len >= dest->BufSize) {
1434 dest->BufUsed = len;
1435 if (IncreaseBuf(dest, 1, -1) < 0) {
1440 if ( (current_token == parmnum) &&
1441 (*s != separator)) {
1442 dest->buf[len] = *s;
1445 else if (current_token > parmnum) {
1451 dest->buf[len] = '\0';
1452 dest->BufUsed = len;
1454 if (current_token < parmnum) {
1455 //lprintf (CTDL_DEBUG,"test <!: %s\n", dest);
1458 //lprintf (CTDL_DEBUG,"test <: %d; %s\n", len, dest);
1467 * @ingroup StrBuf_Tokenizer
1468 * @brief a string tokenizer to fetch an integer
1469 * @param Source String containing tokens
1470 * @param parmnum n'th Parameter to extract
1471 * @param separator tokenizer character
1472 * @returns 0 if not found, else integer representation of the token
1474 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator)
1484 if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0)
1491 * @ingroup StrBuf_Tokenizer
1492 * @brief a string tokenizer to fetch a long integer
1493 * @param Source String containing tokens
1494 * @param parmnum n'th Parameter to extract
1495 * @param separator tokenizer character
1496 * @returns 0 if not found, else long integer representation of the token
1498 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator)
1508 if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0)
1516 * @ingroup StrBuf_Tokenizer
1517 * @brief a string tokenizer to fetch an unsigned long
1518 * @param Source String containing tokens
1519 * @param parmnum n'th Parameter to extract
1520 * @param separator tokenizer character
1521 * @returns 0 if not found, else unsigned long representation of the token
1523 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator)
1534 if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0) {
1538 return (unsigned long) atol(pnum);
1547 * @ingroup StrBuf_NextTokenizer
1548 * @brief a string tokenizer; Bounds checker
1549 * function to make shure whether StrBufExtract_NextToken and friends have reached the end of the string.
1550 * @param Source our tokenbuffer
1551 * @param pStart the token iterator pointer to inspect
1552 * @returns whether the revolving pointer is inside of the search range
1554 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart)
1556 if ((Source == NULL) ||
1557 (*pStart == StrBufNOTNULL) ||
1558 (Source->BufUsed == 0))
1562 if (*pStart == NULL)
1566 else if (*pStart > Source->buf + Source->BufUsed)
1570 else if (*pStart <= Source->buf)
1579 * @ingroup StrBuf_NextTokenizer
1580 * @brief a string tokenizer
1581 * @param dest Destination StringBuffer
1582 * @param Source StringBuffer to read into
1583 * @param pStart pointer to the end of the last token. Feed with NULL on start.
1584 * @param separator tokenizer
1585 * @returns -1 if not found, else length of token.
1587 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator)
1589 const char *s; /* source */
1590 const char *EndBuffer; /* end stop of source buffer */
1591 int current_token = 0; /* token currently being processed */
1592 int len = 0; /* running total length of extracted string */
1594 if ((Source == NULL) ||
1595 (Source->BufUsed == 0) )
1597 *pStart = StrBufNOTNULL;
1603 EndBuffer = Source->buf + Source->BufUsed;
1607 dest->buf[0] = '\0';
1612 *pStart = EndBuffer + 1;
1616 if (*pStart == NULL)
1618 *pStart = Source->buf; /* we're starting to examine this buffer. */
1620 else if ((*pStart < Source->buf) ||
1621 (*pStart > EndBuffer ) )
1623 return -1; /* no more tokens to find. */
1627 /* start to find the next token */
1628 while ((s <= EndBuffer) &&
1629 (current_token == 0) )
1631 if (*s == separator)
1633 /* we found the next token */
1637 if (len >= dest->BufSize)
1639 /* our Dest-buffer isn't big enough, increase it. */
1640 dest->BufUsed = len;
1642 if (IncreaseBuf(dest, 1, -1) < 0) {
1643 /* WHUT? no more mem? bail out. */
1650 if ( (current_token == 0 ) && /* are we in our target token? */
1651 (!IsEmptyStr(s) ) &&
1652 (separator != *s) ) /* don't copy the token itself */
1654 dest->buf[len] = *s; /* Copy the payload */
1655 ++len; /* remember the bigger size. */
1661 /* did we reach the end? */
1662 if ((s > EndBuffer)) {
1663 EndBuffer = StrBufNOTNULL;
1664 *pStart = EndBuffer;
1667 *pStart = s; /* remember the position for the next run */
1670 /* sanitize our extracted token */
1671 dest->buf[len] = '\0';
1672 dest->BufUsed = len;
1679 * @ingroup StrBuf_NextTokenizer
1680 * @brief a string tokenizer
1681 * @param Source StringBuffer to read from
1682 * @param pStart pointer to the end of the last token. Feed with NULL.
1683 * @param separator tokenizer character
1684 * @param nTokens number of tokens to fastforward over
1685 * @returns -1 if not found, else length of token.
1687 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens)
1689 const char *s, *EndBuffer; //* source * /
1690 int len = 0; //* running total length of extracted string * /
1691 int current_token = 0; //* token currently being processed * /
1693 if ((Source == NULL) ||
1694 (Source->BufUsed ==0)) {
1698 return Source->BufUsed;
1700 if (*pStart == NULL)
1701 *pStart = Source->buf;
1703 EndBuffer = Source->buf + Source->BufUsed;
1705 if ((*pStart < Source->buf) ||
1706 (*pStart > EndBuffer)) {
1714 //lprintf (CTDL_DEBUG, "test >: n: %d sep: %c source: %s \n willi \n", parmnum, separator, source);
1716 while ((s < EndBuffer) && !IsEmptyStr(s)) {
1717 if (*s == separator) {
1720 if (current_token >= nTokens) {
1732 * @ingroup StrBuf_NextTokenizer
1733 * @brief a string tokenizer to fetch an integer
1734 * @param Source StringBuffer to read from
1735 * @param pStart Cursor on the tokenstring
1736 * @param separator tokenizer character
1737 * @returns 0 if not found, else integer representation of the token
1739 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator)
1749 if (StrBufExtract_NextToken(&tmp, Source, pStart, separator) > 0)
1756 * @ingroup StrBuf_NextTokenizer
1757 * @brief a string tokenizer to fetch a long integer
1758 * @param Source StringBuffer to read from
1759 * @param pStart Cursor on the tokenstring
1760 * @param separator tokenizer character
1761 * @returns 0 if not found, else long integer representation of the token
1763 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator)
1773 if (StrBufExtract_NextToken(&tmp, Source, pStart, separator) > 0)
1781 * @ingroup StrBuf_NextTokenizer
1782 * @brief a string tokenizer to fetch an unsigned long
1783 * @param Source StringBuffer to read from
1784 * @param pStart Cursor on the tokenstring
1785 * @param separator tokenizer character
1786 * @returns 0 if not found, else unsigned long representation of the token
1788 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator)
1799 if (StrBufExtract_NextToken(&tmp, Source, pStart, separator) > 0) {
1803 return (unsigned long) atol(pnum);
1813 /*******************************************************************************
1814 * Escape Appending *
1815 *******************************************************************************/
1818 * @ingroup StrBuf_DeEnCoder
1819 * @brief Escape a string for feeding out as a URL while appending it to a Buffer
1820 * @param OutBuf the output buffer
1821 * @param In Buffer to encode
1822 * @param PlainIn way in from plain old c strings
1824 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn)
1826 const char *pch, *pche;
1830 if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
1832 if (PlainIn != NULL) {
1833 len = strlen(PlainIn);
1839 pche = pch + In->BufUsed;
1846 pt = OutBuf->buf + OutBuf->BufUsed;
1847 pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
1849 while (pch < pche) {
1851 IncreaseBuf(OutBuf, 1, -1);
1852 pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
1853 pt = OutBuf->buf + OutBuf->BufUsed;
1856 if((*pch >= 'a' && *pch <= 'z') ||
1857 (*pch >= '@' && *pch <= 'Z') || /* @ A-Z */
1858 (*pch >= '0' && *pch <= ':') || /* 0-9 : */
1859 (*pch == '!') || (*pch == '_') ||
1860 (*pch == ',') || (*pch == '.'))
1867 *(pt + 1) = HexList[(unsigned char)*pch][0];
1868 *(pt + 2) = HexList[(unsigned char)*pch][1];
1870 OutBuf->BufUsed += 3;
1878 * @ingroup StrBuf_DeEnCoder
1879 * @brief Escape a string for feeding out as a the username/password part of an URL while appending it to a Buffer
1880 * @param OutBuf the output buffer
1881 * @param In Buffer to encode
1882 * @param PlainIn way in from plain old c strings
1884 void StrBufUrlescUPAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn)
1886 const char *pch, *pche;
1890 if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
1892 if (PlainIn != NULL) {
1893 len = strlen(PlainIn);
1899 pche = pch + In->BufUsed;
1906 pt = OutBuf->buf + OutBuf->BufUsed;
1907 pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
1909 while (pch < pche) {
1911 IncreaseBuf(OutBuf, 1, -1);
1912 pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
1913 pt = OutBuf->buf + OutBuf->BufUsed;
1916 if((*pch >= 'a' && *pch <= 'z') ||
1917 (*pch >= 'A' && *pch <= 'Z') || /* A-Z */
1918 (*pch >= '0' && *pch <= ':') || /* 0-9 : */
1919 (*pch == '!') || (*pch == '_') ||
1920 (*pch == ',') || (*pch == '.'))
1927 *(pt + 1) = HexList[(unsigned char)*pch][0];
1928 *(pt + 2) = HexList[(unsigned char)*pch][1];
1930 OutBuf->BufUsed += 3;
1938 * @ingroup StrBuf_DeEnCoder
1939 * @brief append a string with characters having a special meaning in xml encoded to the buffer
1940 * @param OutBuf the output buffer
1941 * @param In Buffer to encode
1942 * @param PlainIn way in from plain old c strings
1943 * @param PlainInLen way in from plain old c strings; maybe you've got binary data or know the length?
1944 * @param OverrideLowChars should chars < 0x20 be replaced by _ or escaped as xml entity?
1946 void StrBufXMLEscAppend(StrBuf *OutBuf,
1948 const char *PlainIn,
1950 int OverrideLowChars)
1952 const char *pch, *pche;
1957 if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
1959 if (PlainIn != NULL) {
1961 len = strlen((const char*)PlainIn);
1968 pch = (const char*)In->buf;
1969 pche = pch + In->BufUsed;
1976 pt = OutBuf->buf + OutBuf->BufUsed;
1977 /**< we max append 6 chars at once plus the \0 */
1978 pte = OutBuf->buf + OutBuf->BufSize - 6;
1980 while (pch < pche) {
1982 OutBuf->BufUsed = pt - OutBuf->buf;
1983 IncreaseBuf(OutBuf, 1, -1);
1984 pte = OutBuf->buf + OutBuf->BufSize - 6;
1985 /**< we max append 3 chars at once plus the \0 */
1987 pt = OutBuf->buf + OutBuf->BufUsed;
1991 memcpy(pt, HKEY("<"));
1995 else if (*pch == '>') {
1996 memcpy(pt, HKEY(">"));
2000 else if (*pch == '&') {
2001 memcpy(pt, HKEY("&"));
2005 else if ((*pch >= 0x20) && (*pch <= 0x7F)) {
2009 else if (*pch < 0x20) {
2010 /* we probably shouldn't be doing this */
2011 if (OverrideLowChars)
2021 *pt = HexList[*(unsigned char*)pch][0];
2023 *pt = HexList[*(unsigned char*)pch][1];
2031 IsUtf8Sequence = Ctdl_GetUtf8SequenceLength(pch, pche);
2034 while (IsUtf8Sequence > 0){
2045 *pt = HexList[*(unsigned char*)pch][0];
2047 *pt = HexList[*(unsigned char*)pch][1];
2056 OutBuf->BufUsed = pt - OutBuf->buf;
2061 * @ingroup StrBuf_DeEnCoder
2062 * @brief append a string in hex encoding to the buffer
2063 * @param OutBuf the output buffer
2064 * @param In Buffer to encode
2065 * @param PlainIn way in from plain old c strings
2066 * @param PlainInLen way in from plain old c strings; maybe you've got binary data or know the length?
2068 void StrBufHexEscAppend(StrBuf *OutBuf, const StrBuf *In, const unsigned char *PlainIn, long PlainInLen)
2070 const unsigned char *pch, *pche;
2074 if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
2076 if (PlainIn != NULL) {
2078 len = strlen((const char*)PlainIn);
2085 pch = (const unsigned char*)In->buf;
2086 pche = pch + In->BufUsed;
2093 pt = OutBuf->buf + OutBuf->BufUsed;
2094 pte = OutBuf->buf + OutBuf->BufSize - 3; /**< we max append 3 chars at once plus the \0 */
2096 while (pch < pche) {
2098 IncreaseBuf(OutBuf, 1, -1);
2099 pte = OutBuf->buf + OutBuf->BufSize - 3; /**< we max append 3 chars at once plus the \0 */
2100 pt = OutBuf->buf + OutBuf->BufUsed;
2103 *pt = HexList[*pch][0];
2105 *pt = HexList[*pch][1];
2106 pt ++; pch ++; OutBuf->BufUsed += 2;
2111 void StrBufBase64Append(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn, long PlainInLen, int linebreaks)
2118 if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
2120 if (PlainIn != NULL) {
2122 len = strlen(PlainIn);
2135 ExpectLen = ((len * 134) / 100) + OutBuf->BufUsed;
2137 if (ExpectLen > OutBuf->BufSize)
2138 if (IncreaseBuf(OutBuf, 1, ExpectLen) < ExpectLen)
2141 pt = OutBuf->buf + OutBuf->BufUsed;
2143 len = CtdlEncodeBase64(pt, pch, len, linebreaks);
2146 OutBuf->BufUsed += len;
2151 * @ingroup StrBuf_DeEnCoder
2152 * @brief append a string in hex encoding to the buffer
2153 * @param OutBuf the output buffer
2154 * @param In Buffer to encode
2155 * @param PlainIn way in from plain old c strings
2157 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn)
2159 StrBufHexEscAppend(OutBuf, In, (const unsigned char*) PlainIn, -1);
2163 * @ingroup StrBuf_DeEnCoder
2164 * @brief Append a string, escaping characters which have meaning in HTML.
2166 * @param Target target buffer
2167 * @param Source source buffer; set to NULL if you just have a C-String
2168 * @param PlainIn Plain-C string to append; set to NULL if unused
2169 * @param nbsp If nonzero, spaces are converted to non-breaking spaces.
2170 * @param nolinebreaks if set to 1, linebreaks are removed from the string.
2171 * if set to 2, linebreaks are replaced by <br/>
2173 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks)
2175 const char *aptr, *eiptr;
2179 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2182 if (PlainIn != NULL) {
2184 len = strlen(PlainIn);
2189 eiptr = aptr + Source->BufUsed;
2190 len = Source->BufUsed;
2196 bptr = Target->buf + Target->BufUsed;
2197 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
2199 while (aptr < eiptr){
2201 IncreaseBuf(Target, 1, -1);
2202 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
2203 bptr = Target->buf + Target->BufUsed;
2206 memcpy(bptr, "<", 4);
2208 Target->BufUsed += 4;
2210 else if (*aptr == '>') {
2211 memcpy(bptr, ">", 4);
2213 Target->BufUsed += 4;
2215 else if (*aptr == '&') {
2216 memcpy(bptr, "&", 5);
2218 Target->BufUsed += 5;
2220 else if (*aptr == '"') {
2221 memcpy(bptr, """, 6);
2223 Target->BufUsed += 6;
2225 else if (*aptr == '\'') {
2226 memcpy(bptr, "'", 5);
2228 Target->BufUsed += 5;
2230 else if (*aptr == LB) {
2235 else if (*aptr == RB) {
2240 else if (*aptr == QU) {
2245 else if ((*aptr == 32) && (nbsp == 1)) {
2246 memcpy(bptr, " ", 6);
2248 Target->BufUsed += 6;
2250 else if ((*aptr == '\n') && (nolinebreaks == 1)) {
2251 *bptr='\0'; /* nothing */
2253 else if ((*aptr == '\n') && (nolinebreaks == 2)) {
2254 memcpy(bptr, "<br/>", 11);
2256 Target->BufUsed += 11;
2260 else if ((*aptr == '\r') && (nolinebreaks != 0)) {
2261 *bptr='\0'; /* nothing */
2271 if ((bptr = eptr - 1 ) && !IsEmptyStr(aptr) )
2273 return Target->BufUsed;
2277 * @ingroup StrBuf_DeEnCoder
2278 * @brief Append a string, escaping characters which have meaning in HTML.
2279 * Converts linebreaks into blanks; escapes single quotes
2280 * @param Target target buffer
2281 * @param Source source buffer; set to NULL if you just have a C-String
2282 * @param PlainIn Plain-C string to append; set to NULL if unused
2284 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn)
2286 const char *aptr, *eiptr;
2290 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2293 if (PlainIn != NULL) {
2295 len = strlen(PlainIn);
2300 eiptr = aptr + Source->BufUsed;
2301 len = Source->BufUsed;
2307 eptr = Target->buf + Target->BufSize - 8;
2308 tptr = Target->buf + Target->BufUsed;
2310 while (aptr < eiptr){
2312 IncreaseBuf(Target, 1, -1);
2313 eptr = Target->buf + Target->BufSize - 8;
2314 tptr = Target->buf + Target->BufUsed;
2317 if (*aptr == '\n') {
2321 else if (*aptr == '\r') {
2325 else if (*aptr == '\'') {
2331 Target->BufUsed += 5;
2344 * @ingroup StrBuf_DeEnCoder
2345 * @brief Append a string, escaping characters which have meaning in ICAL.
2347 * @param Target target buffer
2348 * @param Source source buffer; set to NULL if you just have a C-String
2349 * @param PlainIn Plain-C string to append; set to NULL if unused
2351 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn)
2353 const char *aptr, *eiptr;
2357 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2360 if (PlainIn != NULL) {
2362 len = strlen(PlainIn);
2367 eiptr = aptr + Source->BufUsed;
2368 len = Source->BufUsed;
2374 eptr = Target->buf + Target->BufSize - 8;
2375 tptr = Target->buf + Target->BufUsed;
2377 while (aptr < eiptr){
2378 if(tptr + 3 >= eptr) {
2379 IncreaseBuf(Target, 1, -1);
2380 eptr = Target->buf + Target->BufSize - 8;
2381 tptr = Target->buf + Target->BufUsed;
2384 if (*aptr == '\n') {
2391 else if (*aptr == '\r') {
2398 else if (*aptr == ',') {
2414 * @ingroup StrBuf_DeEnCoder
2415 * @brief Append a string, escaping characters which have meaning in JavaScript strings .
2417 * @param Target target buffer
2418 * @param Source source buffer; set to NULL if you just have a C-String
2419 * @param PlainIn Plain-C string to append; set to NULL if unused
2420 * @returns size of result or -1
2422 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn)
2424 const char *aptr, *eiptr;
2429 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2432 if (PlainIn != NULL) {
2434 len = strlen(PlainIn);
2439 eiptr = aptr + Source->BufUsed;
2440 len = Source->BufUsed;
2446 bptr = Target->buf + Target->BufUsed;
2447 eptr = Target->buf + Target->BufSize - 7; /* our biggest unit to put in... */
2449 while (aptr < eiptr){
2451 IncreaseBuf(Target, 1, -1);
2452 eptr = Target->buf + Target->BufSize - 7; /* our biggest unit to put in... */
2453 bptr = Target->buf + Target->BufUsed;
2457 memcpy(bptr, HKEY("\\n"));
2459 Target->BufUsed += 2;
2462 memcpy(bptr, HKEY("\\r"));
2464 Target->BufUsed += 2;
2471 Target->BufUsed += 2;
2474 if ((*(aptr + 1) == 'u') &&
2475 isxdigit(*(aptr + 2)) &&
2476 isxdigit(*(aptr + 3)) &&
2477 isxdigit(*(aptr + 4)) &&
2478 isxdigit(*(aptr + 5)))
2479 { /* oh, a unicode escaper. let it pass through. */
2480 memcpy(bptr, aptr, 6);
2483 Target->BufUsed += 6;
2491 Target->BufUsed += 2;
2499 Target->BufUsed += 2;
2506 Target->BufUsed += 2;
2513 Target->BufUsed += 2;
2516 IsUtf8Sequence = Ctdl_GetUtf8SequenceLength(aptr, eiptr);
2517 while (IsUtf8Sequence > 0){
2520 if (--IsUtf8Sequence)
2528 if ((bptr == eptr - 1 ) && !IsEmptyStr(aptr) )
2530 return Target->BufUsed;
2534 * @ingroup StrBuf_DeEnCoder
2535 * @brief Append a string, escaping characters which have meaning in HTML + json.
2537 * @param Target target buffer
2538 * @param Source source buffer; set to NULL if you just have a C-String
2539 * @param PlainIn Plain-C string to append; set to NULL if unused
2540 * @param nbsp If nonzero, spaces are converted to non-breaking spaces.
2541 * @param nolinebreaks if set to 1, linebreaks are removed from the string.
2542 * if set to 2, linebreaks are replaced by <br/>
2544 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks)
2546 const char *aptr, *eiptr;
2549 int IsUtf8Sequence = 0;
2551 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2554 if (PlainIn != NULL) {
2556 len = strlen(PlainIn);
2561 eiptr = aptr + Source->BufUsed;
2562 len = Source->BufUsed;
2568 bptr = Target->buf + Target->BufUsed;
2569 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
2571 while (aptr < eiptr){
2573 IncreaseBuf(Target, 1, -1);
2574 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
2575 bptr = Target->buf + Target->BufUsed;
2579 memcpy(bptr, HKEY("<"));
2581 Target->BufUsed += 4;
2584 memcpy(bptr, HKEY(">"));
2586 Target->BufUsed += 4;
2589 memcpy(bptr, HKEY("&"));
2591 Target->BufUsed += 5;
2604 switch (nolinebreaks) {
2606 *bptr='\0'; /* nothing */
2609 memcpy(bptr, HKEY("<br/>"));
2611 Target->BufUsed += 11;
2614 memcpy(bptr, HKEY("\\n"));
2616 Target->BufUsed += 2;
2620 switch (nolinebreaks) {
2623 *bptr='\0'; /* nothing */
2626 memcpy(bptr, HKEY("\\r"));
2628 Target->BufUsed += 2;
2638 Target->BufUsed += 2;
2641 if ((*(aptr + 1) == 'u') &&
2642 isxdigit(*(aptr + 2)) &&
2643 isxdigit(*(aptr + 3)) &&
2644 isxdigit(*(aptr + 4)) &&
2645 isxdigit(*(aptr + 5)))
2646 { /* oh, a unicode escaper. let it pass through. */
2647 memcpy(bptr, aptr, 6);
2650 Target->BufUsed += 6;
2658 Target->BufUsed += 2;
2666 Target->BufUsed += 2;
2673 Target->BufUsed += 2;
2680 Target->BufUsed += 2;
2684 memcpy(bptr, HKEY(" "));
2686 Target->BufUsed += 6;
2690 IsUtf8Sequence = Ctdl_GetUtf8SequenceLength(aptr, eiptr);
2691 while (IsUtf8Sequence > 0){
2694 if (--IsUtf8Sequence)
2702 if ((bptr = eptr - 1 ) && !IsEmptyStr(aptr) )
2704 return Target->BufUsed;
2709 * @ingroup StrBuf_DeEnCoder
2710 * @brief replace all non-Ascii characters by another
2711 * @param Buf buffer to inspect
2712 * @param repl charater to stamp over non ascii chars
2714 void StrBufAsciify(StrBuf *Buf, const char repl)
2718 for (offset = 0; offset < Buf->BufUsed; offset ++)
2719 if (!isascii(Buf->buf[offset]))
2720 Buf->buf[offset] = repl;
2725 * @ingroup StrBuf_DeEnCoder
2726 * @brief unhide special chars hidden to the HTML escaper
2727 * @param target buffer to put the unescaped string in
2728 * @param source buffer to unescape
2730 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source)
2735 if ((source == NULL) || (target == NULL) || (target->buf == NULL))
2741 FlushStrBuf(target);
2743 len = source->BufUsed;
2744 for (a = 0; a < len; ++a) {
2745 if (target->BufUsed >= target->BufSize)
2746 IncreaseBuf(target, 1, -1);
2748 if (source->buf[a] == '=') {
2749 hex[0] = source->buf[a + 1];
2750 hex[1] = source->buf[a + 2];
2753 sscanf(hex, "%02x", &b);
2754 target->buf[target->BufUsed] = b;
2755 target->buf[++target->BufUsed] = 0;
2759 target->buf[target->BufUsed] = source->buf[a];
2760 target->buf[++target->BufUsed] = 0;
2767 * @ingroup StrBuf_DeEnCoder
2768 * @brief hide special chars from the HTML escapers and friends
2769 * @param target buffer to put the escaped string in
2770 * @param source buffer to escape
2772 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source)
2777 FlushStrBuf(target);
2779 if ((source == NULL) || (target == NULL) || (target->buf == NULL))
2784 len = source->BufUsed;
2785 for (i=0; i<len; ++i) {
2786 if (target->BufUsed + 4 >= target->BufSize)
2787 IncreaseBuf(target, 1, -1);
2788 if ( (isalnum(source->buf[i])) ||
2789 (source->buf[i]=='-') ||
2790 (source->buf[i]=='_') ) {
2791 target->buf[target->BufUsed++] = source->buf[i];
2794 sprintf(&target->buf[target->BufUsed],
2796 (0xFF &source->buf[i]));
2797 target->BufUsed += 3;
2800 target->buf[target->BufUsed + 1] = '\0';
2804 /*******************************************************************************
2805 * Quoted Printable de/encoding *
2806 *******************************************************************************/
2809 * @ingroup StrBuf_DeEnCoder
2810 * @brief decode a buffer from base 64 encoding; destroys original
2811 * @param Buf Buffor to transform
2813 int StrBufDecodeBase64(StrBuf *Buf)
2821 xferbuf = (char*) malloc(Buf->BufSize);
2822 if (xferbuf == NULL)
2826 siz = CtdlDecodeBase64(xferbuf,
2833 Buf->buf[Buf->BufUsed] = '\0';
2838 * @ingroup StrBuf_DeEnCoder
2839 * @brief decode a buffer from base 64 encoding; expects targetbuffer
2840 * @param BufIn Buffor to transform
2841 * @param BufOut Buffer to put result into
2843 int StrBufDecodeBase64To(const StrBuf *BufIn, StrBuf *BufOut)
2845 if ((BufIn == NULL) || (BufOut == NULL))
2848 if (BufOut->BufSize < BufIn->BufUsed)
2849 IncreaseBuf(BufOut, BufIn->BufUsed, 0);
2851 BufOut->BufUsed = CtdlDecodeBase64(BufOut->buf,
2854 return BufOut->BufUsed;
2857 typedef struct __z_enc_stream {
2862 void *StrBufNewStreamContext(eStreamType type)
2864 base64_decodestate *state;;
2870 state = (base64_decodestate*) malloc(sizeof(base64_decodestate));
2871 base64_init_decodestate(state);
2877 z_enc_stream *stream;
2880 stream = (z_enc_stream *) malloc(sizeof(z_enc_stream));
2881 memset(stream, 0, sizeof(z_enc_stream));
2882 stream->OutBuf.BufSize = 4*SIZ; /// TODO 64
2883 stream->OutBuf.buf = (char*)malloc(stream->OutBuf.BufSize);
2885 err = inflateInit(&stream->zstream);
2888 StrBufDestroyStreamContext(type, (void**)&stream);
2896 z_enc_stream *stream;
2899 stream = (z_enc_stream *) malloc(sizeof(z_enc_stream));
2900 memset(stream, 0, sizeof(z_enc_stream));
2901 stream->OutBuf.BufSize = 4*SIZ; /// todo 64
2902 stream->OutBuf.buf = (char*)malloc(stream->OutBuf.BufSize);
2903 /* write gzip header */
2904 stream->OutBuf.BufUsed = snprintf
2905 (stream->OutBuf.buf,
2906 stream->OutBuf.BufSize,
2907 "%c%c%c%c%c%c%c%c%c%c",
2908 gz_magic[0], gz_magic[1], Z_DEFLATED,
2909 0 /*flags */ , 0, 0, 0, 0 /*time */ , 0 /* xflags */ ,
2912 err = deflateInit2(&stream->zstream,
2913 ZLibCompressionRatio,
2917 Z_DEFAULT_STRATEGY);
2919 StrBufDestroyStreamContext(type, (void**) &stream);
2932 void StrBufDestroyStreamContext(eStreamType type, void **vStream)
2934 if ((vStream == NULL) || (*vStream==NULL)) {
2946 z_enc_stream *stream = (z_enc_stream *)*vStream;
2947 (void)inflateEnd(&stream->zstream);
2948 free(stream->OutBuf.buf);
2953 z_enc_stream *stream = (z_enc_stream *)*vStream;
2954 free(stream->OutBuf.buf);
2965 int StrBufStreamTranscode(eStreamType type, IOBuffer *Target, IOBuffer *In, const char* pIn, long pInLen, void *vStream, int LastChunk)
2974 // base64_decodestate *state = (base64_decodestate*)vStream;
2980 pInLen = In->BufUsed;
2982 if ((In == NULL) || (vStream == NULL))
2985 ExpectLen = (pInLen / 4) * 3;
2987 if (Target->BufSize - Target->BufUsed < ExpectLen)
2989 IncreaseBuf(Target, 1, Target->BufUsed + ExpectLen + 1);
2992 //// ExpectLen = base64_encode_block(pIn, pInLen, Target->buf + Target->BufUsed, state);
2993 Target->BufUsed += ExpectLen;
2994 Target->buf[Target->BufUsed] = '\0';
3001 base64_decodestate *state = (base64_decodestate *)vStream;
3007 pInLen = In->BufUsed;
3009 if ((pIn == NULL) || (vStream == NULL))
3012 ExpectLen = (pInLen / 4) * 3;
3014 if (Target->BufSize - Target->BufUsed < ExpectLen)
3016 IncreaseBuf(Target, 1, Target->BufUsed + ExpectLen + 1);
3019 ExpectLen = base64_decode_block(pIn, pInLen, Target->buf + Target->BufUsed, state);
3020 Target->BufUsed += ExpectLen;
3021 Target->buf[Target->BufUsed] = '\0';
3027 z_enc_stream *stream = (z_enc_stream *)vStream;
3028 int org_outbuf_len = stream->zstream.total_out;
3030 unsigned int chunkavail;
3032 if (In->ReadWritePointer != NULL)
3034 stream->zstream.next_in = (Bytef *) In->ReadWritePointer;
3035 stream->zstream.avail_in = (uInt) In->Buf->BufUsed -
3036 (In->ReadWritePointer - In->Buf->buf);
3040 stream->zstream.next_in = (Bytef *) In->Buf->buf;
3041 stream->zstream.avail_in = (uInt) In->Buf->BufUsed;
3044 stream->zstream.next_out = (unsigned char*)stream->OutBuf.buf + stream->OutBuf.BufUsed;
3045 stream->zstream.avail_out = chunkavail = (uInt) stream->OutBuf.BufSize - stream->OutBuf.BufUsed;
3047 err = deflate(&stream->zstream, (LastChunk) ? Z_FINISH : Z_NO_FLUSH);
3049 stream->OutBuf.BufUsed += (chunkavail - stream->zstream.avail_out);
3050 /// todo + org_outbuf_len;
3052 if (Target) SwapBuffers(Target->Buf, &stream->OutBuf);
3054 if (stream->zstream.avail_in == 0)
3056 FlushStrBuf(In->Buf);
3057 In->ReadWritePointer = NULL;
3061 if (stream->zstream.avail_in < 64)
3063 memmove(In->Buf->buf,
3064 In->Buf->buf + In->Buf->BufUsed - stream->zstream.avail_in,
3065 stream->zstream.avail_in);
3067 In->Buf->BufUsed = stream->zstream.avail_in;
3068 In->Buf->buf[In->Buf->BufUsed] = '\0';
3073 In->ReadWritePointer = In->Buf->buf +
3074 (In->Buf->BufUsed - stream->zstream.avail_in);
3077 return (LastChunk && (err != Z_FINISH));
3082 z_enc_stream *stream = (z_enc_stream *)vStream;
3083 int org_outbuf_len = stream->zstream.total_out;
3086 if ((stream->zstream.avail_out != 0) && (stream->zstream.next_in != NULL)) {
3087 if (In->ReadWritePointer != NULL)
3089 stream->zstream.next_in = (Bytef *) In->ReadWritePointer;
3090 stream->zstream.avail_in = (uInt) In->Buf->BufUsed -
3091 (In->ReadWritePointer - In->Buf->buf);
3095 stream->zstream.next_in = (Bytef *) In->Buf->buf;
3096 stream->zstream.avail_in = (uInt) In->Buf->BufUsed;
3100 stream->zstream.next_out = (unsigned char*)stream->OutBuf.buf + stream->OutBuf.BufUsed;
3101 stream->zstream.avail_out = (uInt) stream->OutBuf.BufSize - stream->OutBuf.BufUsed;
3103 err = inflate(&stream->zstream, Z_NO_FLUSH);
3105 ///assert(ret != Z_STREAM_ERROR); /* state not clobbered * /
3108 err = Z_DATA_ERROR; /* and fall through */
3111 fprintf(stderr, "sanoteuh\n");
3113 (void)inflateEnd(&stream->zstream);
3117 stream->OutBuf.BufUsed += stream->zstream.total_out + org_outbuf_len;
3119 if (Target) SwapBuffers(Target->Buf, &stream->OutBuf);
3121 if (stream->zstream.avail_in == 0)
3123 FlushStrBuf(In->Buf);
3124 In->ReadWritePointer = NULL;
3128 if (stream->zstream.avail_in < 64)
3130 memmove(In->Buf->buf,
3131 In->Buf->buf + In->Buf->BufUsed - stream->zstream.avail_in,
3132 stream->zstream.avail_in);
3134 In->Buf->BufUsed = stream->zstream.avail_in;
3135 In->Buf->buf[In->Buf->BufUsed] = '\0';
3140 In->ReadWritePointer = In->Buf->buf +
3141 (In->Buf->BufUsed - stream->zstream.avail_in);
3155 * @ingroup StrBuf_DeEnCoder
3156 * @brief decode a buffer from base 64 encoding; destroys original
3157 * @param Buf Buffor to transform
3159 int StrBufDecodeHex(StrBuf *Buf)
3162 char *pch, *pche, *pchi;
3164 if (Buf == NULL) return -1;
3166 pch = pchi = Buf->buf;
3167 pche = pch + Buf->BufUsed;
3169 while (pchi < pche){
3170 ch = decode_hex(pchi);
3177 Buf->BufUsed = pch - Buf->buf;
3178 return Buf->BufUsed;
3182 * @ingroup StrBuf_DeEnCoder
3183 * @brief replace all chars >0x20 && < 0x7F with Mute
3184 * @param Mute char to put over invalid chars
3185 * @param Buf Buffor to transform
3187 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute)
3191 if (Buf == NULL) return -1;
3192 pch = (unsigned char *)Buf->buf;
3193 while (pch < (unsigned char *)Buf->buf + Buf->BufUsed) {
3194 if ((*pch < 0x20) || (*pch > 0x7F))
3198 return Buf->BufUsed;
3203 * @ingroup StrBuf_DeEnCoder
3204 * @brief remove escaped strings from i.e. the url string (like %20 for blanks)
3205 * @param Buf Buffer to translate
3206 * @param StripBlanks Reduce several blanks to one?
3208 long StrBufUnescape(StrBuf *Buf, int StripBlanks)
3217 while ((Buf->BufUsed > 0) && (isspace(Buf->buf[Buf->BufUsed - 1]))){
3218 Buf->buf[Buf->BufUsed - 1] = '\0';
3223 while (a < Buf->BufUsed) {
3224 if (Buf->buf[a] == '+')
3226 else if (Buf->buf[a] == '%') {
3227 /* don't let % chars through, rather truncate the input. */
3228 if (a + 2 > Buf->BufUsed) {
3233 hex[0] = Buf->buf[a + 1];
3234 hex[1] = Buf->buf[a + 2];
3237 sscanf(hex, "%02x", &b);
3238 Buf->buf[a] = (char) b;
3239 len = Buf->BufUsed - a - 2;
3241 memmove(&Buf->buf[a + 1], &Buf->buf[a + 3], len);
3253 * @ingroup StrBuf_DeEnCoder
3254 * @brief RFC2047-encode a header field if necessary.
3255 * If no non-ASCII characters are found, the string
3256 * will be copied verbatim without encoding.
3258 * @param target Target buffer.
3259 * @param source Source string to be encoded.
3260 * @returns encoded length; -1 if non success.
3262 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source)
3264 const char headerStr[] = "=?UTF-8?Q?";
3265 int need_to_encode = 0;
3269 if ((source == NULL) ||
3273 while ((i < source->BufUsed) &&
3274 (!IsEmptyStr (&source->buf[i])) &&
3275 (need_to_encode == 0)) {
3276 if (((unsigned char) source->buf[i] < 32) ||
3277 ((unsigned char) source->buf[i] > 126)) {
3283 if (!need_to_encode) {
3284 if (*target == NULL) {
3285 *target = NewStrBufPlain(source->buf, source->BufUsed);
3288 FlushStrBuf(*target);
3289 StrBufAppendBuf(*target, source, 0);
3292 return (*target)->BufUsed;
3296 if (*target == NULL)
3297 *target = NewStrBufPlain(NULL, sizeof(headerStr) + source->BufUsed * 2);
3298 else if (sizeof(headerStr) + source->BufUsed >= (*target)->BufSize)
3299 IncreaseBuf(*target, sizeof(headerStr) + source->BufUsed, 0);
3300 memcpy ((*target)->buf, headerStr, sizeof(headerStr) - 1);
3301 (*target)->BufUsed = sizeof(headerStr) - 1;
3302 for (i=0; (i < source->BufUsed); ++i) {
3303 if ((*target)->BufUsed + 4 >= (*target)->BufSize)
3304 IncreaseBuf(*target, 1, 0);
3305 ch = (unsigned char) source->buf[i];
3314 sprintf(&(*target)->buf[(*target)->BufUsed], "=%02X", ch);
3315 (*target)->BufUsed += 3;
3319 (*target)->buf[(*target)->BufUsed] = '_';
3321 (*target)->buf[(*target)->BufUsed] = ch;
3322 (*target)->BufUsed++;
3326 if ((*target)->BufUsed + 4 >= (*target)->BufSize)
3327 IncreaseBuf(*target, 1, 0);
3329 (*target)->buf[(*target)->BufUsed++] = '?';
3330 (*target)->buf[(*target)->BufUsed++] = '=';
3331 (*target)->buf[(*target)->BufUsed] = '\0';
3332 return (*target)->BufUsed;;
3336 * @ingroup StrBuf_DeEnCoder
3337 * @brief Quoted-Printable encode a message; make it < 80 columns width.
3338 * @param source Source string to be encoded.
3339 * @returns buffer with encoded message.
3341 StrBuf *StrBufRFC2047encodeMessage(const StrBuf *EncodeMe)
3345 const char *ptr, *eptr;
3349 OutBuf = NewStrBufPlain(NULL, StrLength(EncodeMe) * 4);
3351 OEptr = OutBuf->buf + OutBuf->BufSize;
3352 ptr = EncodeMe->buf;
3353 eptr = EncodeMe->buf + EncodeMe->BufUsed;
3358 if (Optr + 4 >= OEptr)
3361 Offset = Optr - OutBuf->buf;
3362 OutBuf->BufUsed = Optr - OutBuf->buf;
3363 IncreaseBuf(OutBuf, 1, 0);
3364 Optr = OutBuf->buf + Offset;
3365 OEptr = OutBuf->buf + OutBuf->BufSize;
3369 /* ignore carriage returns */
3372 else if (*ptr == '\n') {
3373 /* hard line break */
3374 memcpy(Optr, HKEY("=0A"));
3379 else if (( (*ptr >= 32) && (*ptr <= 60) ) ||
3380 ( (*ptr >= 62) && (*ptr <= 126) ))
3391 *Optr = HexList[ch][0];
3393 *Optr = HexList[ch][1];
3400 /* soft line break */
3401 if (isspace(*(Optr - 1))) {
3406 *Optr = HexList[ch][0];
3408 *Optr = HexList[ch][1];
3420 OutBuf->BufUsed = Optr - OutBuf->buf;
3426 static void AddRecipient(StrBuf *Target,
3428 StrBuf *EmailAddress,
3433 if (StrLength(Target) > 0) StrBufAppendBufPlain(Target, HKEY(", "), 0);
3434 if (strchr(ChrPtr(UserName), ',') != NULL) QuoteMe = 1;
3436 if (QuoteMe) StrBufAppendBufPlain(Target, HKEY("\""), 0);
3437 StrBufRFC2047encode(&EncBuf, UserName);
3438 StrBufAppendBuf(Target, EncBuf, 0);
3439 if (QuoteMe) StrBufAppendBufPlain(Target, HKEY("\" "), 0);
3440 else StrBufAppendBufPlain(Target, HKEY(" "), 0);
3442 if (StrLength(EmailAddress) > 0){
3443 StrBufAppendBufPlain(Target, HKEY("<"), 0);
3444 StrBufAppendBuf(Target, EmailAddress, 0); /* TODO: what about IDN???? */
3445 StrBufAppendBufPlain(Target, HKEY(">"), 0);
3451 * \brief QP encode parts of an email TO/CC/BCC vector, and strip/filter invalid parts
3452 * \param Recp Source list of email recipients
3453 * \param UserName Temporary buffer for internal use; Please provide valid buffer.
3454 * \param EmailAddress Temporary buffer for internal use; Please provide valid buffer.
3455 * \param EncBuf Temporary buffer for internal use; Please provide valid buffer.
3456 * \returns encoded & sanitized buffer with the contents of Recp; Caller owns this memory.
3458 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
3460 StrBuf *EmailAddress,
3464 const char *pch, *pche;
3465 const char *UserStart, *UserEnd, *EmailStart, *EmailEnd, *At;
3467 if ((Recp == NULL) || (StrLength(Recp) == 0))
3471 pche = pch + StrLength(Recp);
3473 if (!CheckEncode(pch, -1, pche))
3474 return NewStrBufDup(Recp);
3476 Target = NewStrBufPlain(NULL, StrLength(Recp));
3478 while ((pch != NULL) && (pch < pche))
3480 while (isspace(*pch)) pch++;
3481 UserEnd = EmailStart = EmailEnd = NULL;
3483 if ((*pch == '"') || (*pch == '\'')) {
3484 UserStart = pch + 1;
3486 UserEnd = strchr(UserStart, *pch);
3487 if (UserEnd == NULL)
3488 break; ///TODO: Userfeedback??
3489 EmailStart = UserEnd + 1;
3490 while (isspace(*EmailStart))
3492 if (UserEnd == UserStart) {
3493 UserStart = UserEnd = NULL;
3496 if (*EmailStart == '<') {
3498 EmailEnd = strchr(EmailStart, '>');
3499 if (EmailEnd == NULL)
3500 EmailEnd = strchr(EmailStart, ',');
3504 EmailEnd = strchr(EmailStart, ',');
3506 if (EmailEnd == NULL)
3513 EmailEnd = strchr(UserStart, ',');
3514 if (EmailEnd == NULL) {
3515 EmailEnd = strchr(pch, '>');
3517 if (EmailEnd != NULL) {
3527 while ((EmailEnd > UserStart) && !gt &&
3528 ((*EmailEnd == ',') ||
3529 (*EmailEnd == '>') ||
3530 (isspace(*EmailEnd))))
3532 if (*EmailEnd == '>')
3537 if (EmailEnd == UserStart)
3541 EmailStart = strchr(UserStart, '<');
3542 if ((EmailStart == NULL) || (EmailStart > EmailEnd))
3544 UserEnd = EmailStart;
3546 while ((UserEnd > UserStart) &&
3547 isspace (*(UserEnd - 1)))
3550 if (UserStart >= UserEnd)
3551 UserStart = UserEnd = NULL;
3553 else { /* this is a local recipient... no domain, just a realname */
3554 EmailStart = UserStart;
3555 At = strchr(EmailStart, '@');
3561 EmailStart = UserStart;
3567 if ((UserStart != NULL) && (UserEnd != NULL))
3568 StrBufPlain(UserName, UserStart, UserEnd - UserStart);
3569 else if ((UserStart != NULL) && (UserEnd == NULL))
3570 StrBufPlain(UserName, UserStart, UserEnd - UserStart);
3572 FlushStrBuf(UserName);
3574 if ((EmailStart != NULL) && (EmailEnd != NULL))
3575 StrBufPlain(EmailAddress, EmailStart, EmailEnd - EmailStart);
3576 else if ((EmailStart != NULL) && (EmailEnd == NULL))
3577 StrBufPlain(EmailAddress, EmailStart, EmailEnd - pche);
3579 FlushStrBuf(EmailAddress);
3581 AddRecipient(Target, UserName, EmailAddress, EncBuf);
3586 if ((pch != NULL) && (*pch == ','))
3588 if (pch != NULL) while (isspace(*pch))
3597 * @brief replaces all occurances of 'search' by 'replace'
3598 * @param buf Buffer to modify
3599 * @param search character to search
3600 * @param replace character to replace search by
3602 void StrBufReplaceChars(StrBuf *buf, char search, char replace)
3607 for (i=0; i<buf->BufUsed; i++)
3608 if (buf->buf[i] == search)
3609 buf->buf[i] = replace;
3615 * @brief removes all \\r s from the string, or replaces them with \n if its not a combination of both.
3616 * @param buf Buffer to modify
3618 void StrBufToUnixLF(StrBuf *buf)
3620 char *pche, *pchS, *pchT;
3624 pche = buf->buf + buf->BufUsed;
3625 pchS = pchT = buf->buf;
3631 if (*pchS != '\n') {
3640 buf->BufUsed = pchT - buf->buf;
3644 /*******************************************************************************
3645 * Iconv Wrapper; RFC822 de/encoding *
3646 *******************************************************************************/
3649 * @ingroup StrBuf_DeEnCoder
3650 * @brief Wrapper around iconv_open()
3651 * Our version adds aliases for non-standard Microsoft charsets
3652 * such as 'MS950', aliasing them to names like 'CP950'
3654 * @param tocode Target encoding
3655 * @param fromcode Source encoding
3656 * @param pic anonimized pointer to iconv struct
3658 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic)
3661 iconv_t ic = (iconv_t)(-1) ;
3662 ic = iconv_open(tocode, fromcode);
3663 if (ic == (iconv_t)(-1) ) {
3664 char alias_fromcode[64];
3665 if ( (strlen(fromcode) == 5) && (!strncasecmp(fromcode, "MS", 2)) ) {
3666 safestrncpy(alias_fromcode, fromcode, sizeof alias_fromcode);
3667 alias_fromcode[0] = 'C';
3668 alias_fromcode[1] = 'P';
3669 ic = iconv_open(tocode, alias_fromcode);
3672 *(iconv_t *)pic = ic;
3678 * @ingroup StrBuf_DeEnCoder
3679 * @brief find one chunk of a RFC822 encoded string
3680 * @param Buffer where to search
3681 * @param bptr where to start searching
3682 * @returns found position, NULL if none.
3684 static inline const char *FindNextEnd (const StrBuf *Buf, const char *bptr)
3687 /* Find the next ?Q? */
3688 if (Buf->BufUsed - (bptr - Buf->buf) < 6)
3691 end = strchr(bptr + 2, '?');
3696 if ((Buf->BufUsed - (end - Buf->buf) > 3) &&
3697 (((*(end + 1) == 'B') || (*(end + 1) == 'Q')) ||
3698 ((*(end + 1) == 'b') || (*(end + 1) == 'q'))) &&
3699 (*(end + 2) == '?')) {
3700 /* skip on to the end of the cluster, the next ?= */
3701 end = strstr(end + 3, "?=");
3704 /* sort of half valid encoding, try to find an end. */
3705 end = strstr(bptr, "?=");
3712 * @ingroup StrBuf_DeEnCoder
3713 * @brief convert one buffer according to the preselected iconv pointer PIC
3714 * @param ConvertBuf buffer we need to translate
3715 * @param TmpBuf To share a workbuffer over several iterations. prepare to have it filled with useless stuff afterwards.
3716 * @param pic Pointer to the iconv-session Object
3718 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic)
3724 char *ibuf; /**< Buffer of characters to be converted */
3725 char *obuf; /**< Buffer for converted characters */
3726 size_t ibuflen; /**< Length of input buffer */
3727 size_t obuflen; /**< Length of output buffer */
3730 if ((ConvertBuf == NULL) || (TmpBuf == NULL))
3733 /* since we're converting to utf-8, one glyph may take up to 6 bytes */
3734 if (ConvertBuf->BufUsed * 6 >= TmpBuf->BufSize)
3735 IncreaseBuf(TmpBuf, 0, ConvertBuf->BufUsed * 6);
3737 ic = *(iconv_t*)pic;
3738 ibuf = ConvertBuf->buf;
3739 ibuflen = ConvertBuf->BufUsed;
3741 obuflen = TmpBuf->BufSize;
3743 siz = iconv(ic, &ibuf, &ibuflen, &obuf, &obuflen);
3746 if (errno == E2BIG) {
3748 IncreaseBuf(TmpBuf, 0, 0);
3753 else if (errno == EILSEQ){
3754 /* hm, invalid utf8 sequence... what to do now? */
3755 /* An invalid multibyte sequence has been encountered in the input */
3757 else if (errno == EINVAL) {
3758 /* An incomplete multibyte sequence has been encountered in the input. */
3761 FlushStrBuf(TmpBuf);
3764 TmpBuf->BufUsed = TmpBuf->BufSize - obuflen;
3765 TmpBuf->buf[TmpBuf->BufUsed] = '\0';
3767 /* little card game: wheres the red lady? */
3768 SwapBuffers(ConvertBuf, TmpBuf);
3769 FlushStrBuf(TmpBuf);
3776 * @ingroup StrBuf_DeEnCoder
3777 * @brief catches one RFC822 encoded segment, and decodes it.
3778 * @param Target buffer to fill with result
3779 * @param DecodeMe buffer with stuff to process
3780 * @param SegmentStart points to our current segment in DecodeMe
3781 * @param SegmentEnd Points to the end of our current segment in DecodeMe
3782 * @param ConvertBuf Workbuffer shared between several iterations. Random content; needs to be valid
3783 * @param ConvertBuf2 Workbuffer shared between several iterations. Random content; needs to be valid
3784 * @param FoundCharset Characterset to default decoding to; if we find another we will overwrite it.
3786 inline static void DecodeSegment(StrBuf *Target,
3787 const StrBuf *DecodeMe,
3788 const char *SegmentStart,
3789 const char *SegmentEnd,
3791 StrBuf *ConvertBuf2,
3792 StrBuf *FoundCharset)
3798 iconv_t ic = (iconv_t)(-1);
3802 /* Now we handle foreign character sets properly encoded
3803 * in RFC2047 format.
3805 StaticBuf.buf = (char*) SegmentStart; /*< it will just be read there... */
3806 StaticBuf.BufUsed = SegmentEnd - SegmentStart;
3807 StaticBuf.BufSize = DecodeMe->BufSize - (SegmentStart - DecodeMe->buf);
3808 extract_token(charset, SegmentStart, 1, '?', sizeof charset);
3809 if (FoundCharset != NULL) {
3810 FlushStrBuf(FoundCharset);
3811 StrBufAppendBufPlain(FoundCharset, charset, -1, 0);
3813 extract_token(encoding, SegmentStart, 2, '?', sizeof encoding);
3814 StrBufExtract_token(ConvertBuf, &StaticBuf, 3, '?');
3816 *encoding = toupper(*encoding);
3817 if (*encoding == 'B') { /**< base64 */
3818 if (ConvertBuf2->BufSize < ConvertBuf->BufUsed)
3819 IncreaseBuf(ConvertBuf2, 0, ConvertBuf->BufUsed);
3820 ConvertBuf2->BufUsed = CtdlDecodeBase64(ConvertBuf2->buf,
3822 ConvertBuf->BufUsed);
3824 else if (*encoding == 'Q') { /**< quoted-printable */
3828 while (pos < ConvertBuf->BufUsed)
3830 if (ConvertBuf->buf[pos] == '_')
3831 ConvertBuf->buf[pos] = ' ';
3835 if (ConvertBuf2->BufSize < ConvertBuf->BufUsed)
3836 IncreaseBuf(ConvertBuf2, 0, ConvertBuf->BufUsed);
3838 ConvertBuf2->BufUsed = CtdlDecodeQuotedPrintable(
3841 ConvertBuf->BufUsed);
3844 StrBufAppendBuf(ConvertBuf2, ConvertBuf, 0);
3847 ctdl_iconv_open("UTF-8", charset, &ic);
3848 if (ic != (iconv_t)(-1) ) {
3850 StrBufConvert(ConvertBuf2, ConvertBuf, &ic);
3851 StrBufAppendBuf(Target, ConvertBuf2, 0);
3856 StrBufAppendBufPlain(Target, HKEY("(unreadable)"), 0);
3862 * @ingroup StrBuf_DeEnCoder
3863 * @brief Handle subjects with RFC2047 encoding such as: [deprecated old syntax!]
3864 * =?koi8-r?B?78bP0s3Mxc7JxSDXz9rE1dvO2c3JINvB0sHNySDP?=
3865 * @param Target where to put the decoded string to
3866 * @param DecodeMe buffer with encoded string
3867 * @param DefaultCharset if we don't find one, which should we use?
3868 * @param FoundCharset overrides DefaultCharset if non-empty; If we find a charset inside of the string,
3869 * put it here for later use where no string might be known.
3871 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset)
3874 StrBuf *ConvertBuf2;
3875 ConvertBuf = NewStrBufPlain(NULL, StrLength(DecodeMe));
3876 ConvertBuf2 = NewStrBufPlain(NULL, StrLength(DecodeMe));
3878 StrBuf_RFC822_2_Utf8(Target,
3884 FreeStrBuf(&ConvertBuf);
3885 FreeStrBuf(&ConvertBuf2);
3889 * @ingroup StrBuf_DeEnCoder
3890 * @brief Handle subjects with RFC2047 encoding such as:
3891 * =?koi8-r?B?78bP0s3Mxc7JxSDXz9rE1dvO2c3JINvB0sHNySDP?=
3892 * @param Target where to put the decoded string to
3893 * @param DecodeMe buffer with encoded string
3894 * @param DefaultCharset if we don't find one, which should we use?
3895 * @param FoundCharset overrides DefaultCharset if non-empty; If we find a charset inside of the string,
3896 * put it here for later use where no string might be known.
3897 * @param ConvertBuf workbuffer. feed in, you shouldn't care about its content.
3898 * @param ConvertBuf2 workbuffer. feed in, you shouldn't care about its content.
3900 void StrBuf_RFC822_2_Utf8(StrBuf *Target,
3901 const StrBuf *DecodeMe,
3902 const StrBuf* DefaultCharset,
3903 StrBuf *FoundCharset,
3905 StrBuf *ConvertBuf2)
3907 StrBuf *DecodedInvalidBuf = NULL;
3908 const StrBuf *DecodeMee = DecodeMe;
3909 const char *start, *end, *next, *nextend, *ptr = NULL;
3911 iconv_t ic = (iconv_t)(-1) ;
3916 int illegal_non_rfc2047_encoding = 0;
3919 if (DecodeMe == NULL)
3921 /* Sometimes, badly formed messages contain strings which were simply
3922 * written out directly in some foreign character set instead of
3923 * using RFC2047 encoding. This is illegal but we will attempt to
3924 * handle it anyway by converting from a user-specified default
3925 * charset to UTF-8 if we see any nonprintable characters.
3928 for (i=0; i<DecodeMe->BufUsed; ++i) {
3929 if ((DecodeMe->buf[i] < 32) || (DecodeMe->buf[i] > 126)) {
3930 illegal_non_rfc2047_encoding = 1;
3935 if ((illegal_non_rfc2047_encoding) &&
3936 (strcasecmp(ChrPtr(DefaultCharset), "UTF-8")) &&
3937 (strcasecmp(ChrPtr(DefaultCharset), "us-ascii")) )
3940 ctdl_iconv_open("UTF-8", ChrPtr(DefaultCharset), &ic);
3941 if (ic != (iconv_t)(-1) ) {
3942 DecodedInvalidBuf = NewStrBufDup(DecodeMe);
3943 StrBufConvert(DecodedInvalidBuf, ConvertBuf, &ic);///TODO: don't void const?
3944 DecodeMee = DecodedInvalidBuf;
3950 /* pre evaluate the first pair */
3952 start = strstr(DecodeMee->buf, "=?");
3953 eptr = DecodeMee->buf + DecodeMee->BufUsed;
3955 end = FindNextEnd (DecodeMee, start + 2);
3957 StrBufAppendBuf(Target, DecodeMee, 0);
3958 FreeStrBuf(&DecodedInvalidBuf);
3963 if (start != DecodeMee->buf) {
3966 nFront = start - DecodeMee->buf;
3967 StrBufAppendBufPlain(Target, DecodeMee->buf, nFront, 0);
3970 * Since spammers will go to all sorts of absurd lengths to get their
3971 * messages through, there are LOTS of corrupt headers out there.
3972 * So, prevent a really badly formed RFC2047 header from throwing
3973 * this function into an infinite loop.
3975 while ((start != NULL) &&
3982 DecodeSegment(Target,
3990 next = strstr(end, "=?");
3992 if ((next != NULL) &&
3994 nextend = FindNextEnd(DecodeMee, next);
3995 if (nextend == NULL)
3998 /* did we find two partitions */
3999 if ((next != NULL) &&
4003 while ((ptr < next) &&
4010 * did we find a gab just filled with blanks?
4011 * if not, copy its stuff over.
4015 StrBufAppendBufPlain(Target,
4021 /* our next-pair is our new first pair now. */
4027 nextend = DecodeMee->buf + DecodeMee->BufUsed;
4028 if ((end != NULL) && (end < nextend)) {
4030 while ( (ptr < nextend) &&
4037 StrBufAppendBufPlain(Target, end, nextend - end, 0);
4039 FreeStrBuf(&DecodedInvalidBuf);
4042 /*******************************************************************************
4043 * Manipulating UTF-8 Strings *
4044 *******************************************************************************/
4048 * @brief evaluate the length of an utf8 special character sequence
4049 * @param Char the character to examine
4050 * @returns width of utf8 chars in bytes; if the sequence is broken 0 is returned; 1 if its simply ASCII.
4052 static inline int Ctdl_GetUtf8SequenceLength(const char *CharS, const char *CharE)
4055 unsigned char test = (1<<7);
4057 if ((*CharS & 0xC0) != 0xC0)
4061 ((test & ((unsigned char)*CharS)) != 0))
4066 if ((n > 6) || ((CharE - CharS) < n))
4073 * @brief detect whether this char starts an utf-8 encoded char
4074 * @param Char character to inspect
4075 * @returns yes or no
4077 static inline int Ctdl_IsUtf8SequenceStart(const char Char)
4079 /** 11??.???? indicates an UTF8 Sequence. */
4080 return ((Char & 0xC0) == 0xC0);
4085 * @brief measure the number of glyphs in an UTF8 string...
4086 * @param Buf string to measure
4087 * @returns the number of glyphs in Buf
4089 long StrBuf_Utf8StrLen(StrBuf *Buf)
4095 if ((Buf == NULL) || (Buf->BufUsed == 0))
4098 eptr = Buf->buf + Buf->BufUsed;
4099 while ((aptr < eptr) && (*aptr != '\0')) {
4100 if (Ctdl_IsUtf8SequenceStart(*aptr)){
4101 m = Ctdl_GetUtf8SequenceLength(aptr, eptr);
4102 while ((aptr < eptr) && (*aptr++ != '\0')&& (m-- > 0) );
4115 * @brief cuts a string after maxlen glyphs
4116 * @param Buf string to cut to maxlen glyphs
4117 * @param maxlen how long may the string become?
4118 * @returns current length of the string
4120 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen)
4126 eptr = Buf->buf + Buf->BufUsed;
4127 while ((aptr < eptr) && (*aptr != '\0')) {
4128 if (Ctdl_IsUtf8SequenceStart(*aptr)){
4129 m = Ctdl_GetUtf8SequenceLength(aptr, eptr);
4130 while ((*aptr++ != '\0') && (m-- > 0));
4139 Buf->BufUsed = aptr - Buf->buf;
4140 return Buf->BufUsed;
4143 return Buf->BufUsed;
4151 /*******************************************************************************
4153 *******************************************************************************/
4156 * @ingroup StrBuf_DeEnCoder
4157 * @brief uses the same calling syntax as compress2(), but it
4158 * creates a stream compatible with HTTP "Content-encoding: gzip"
4159 * @param dest compressed buffer
4160 * @param destLen length of the compresed data
4161 * @param source source to encode
4162 * @param sourceLen length of source to encode
4163 * @param level compression level
4166 int ZEXPORT compress_gzip(Bytef * dest,
4168 const Bytef * source,
4172 /* write gzip header */
4173 snprintf((char *) dest, *destLen,
4174 "%c%c%c%c%c%c%c%c%c%c",
4175 gz_magic[0], gz_magic[1], Z_DEFLATED,
4176 0 /*flags */ , 0, 0, 0, 0 /*time */ , 0 /* xflags */ ,
4179 /* normal deflate */
4182 stream.next_in = (Bytef *) source;
4183 stream.avail_in = (uInt) sourceLen;
4184 stream.next_out = dest + 10L; // after header
4185 stream.avail_out = (uInt) * destLen;
4186 if ((uLong) stream.avail_out != *destLen)
4189 stream.zalloc = (alloc_func) 0;
4190 stream.zfree = (free_func) 0;
4191 stream.opaque = (voidpf) 0;
4193 err = deflateInit2(&stream, level, Z_DEFLATED, -MAX_WBITS,
4194 DEF_MEM_LEVEL, Z_DEFAULT_STRATEGY);
4198 err = deflate(&stream, Z_FINISH);
4199 if (err != Z_STREAM_END) {
4200 deflateEnd(&stream);
4201 return err == Z_OK ? Z_BUF_ERROR : err;
4203 *destLen = stream.total_out + 10L;
4205 /* write CRC and Length */
4206 uLong crc = crc32(0L, source, sourceLen);
4208 for (n = 0; n < 4; ++n, ++*destLen) {
4209 dest[*destLen] = (int) (crc & 0xff);
4212 uLong len = stream.total_in;
4213 for (n = 0; n < 4; ++n, ++*destLen) {
4214 dest[*destLen] = (int) (len & 0xff);
4217 err = deflateEnd(&stream);
4224 * @ingroup StrBuf_DeEnCoder
4225 * @brief compress the buffer with gzip
4226 * Attention! If you feed this a Const String, you must maintain the uncompressed buffer yourself!
4227 * @param Buf buffer whose content is to be gzipped
4229 int CompressBuffer(StrBuf *Buf)
4232 char *compressed_data = NULL;
4233 size_t compressed_len, bufsize;
4236 bufsize = compressed_len = Buf->BufUsed + (Buf->BufUsed / 100) + 100;
4237 compressed_data = malloc(compressed_len);
4239 if (compressed_data == NULL)
4241 /* Flush some space after the used payload so valgrind shuts up... */
4242 while ((i < 10) && (Buf->BufUsed + i < Buf->BufSize))
4243 Buf->buf[Buf->BufUsed + i++] = '\0';
4244 if (compress_gzip((Bytef *) compressed_data,
4247 (uLongf) Buf->BufUsed, Z_BEST_SPEED) == Z_OK) {
4250 Buf->buf = compressed_data;
4251 Buf->BufUsed = compressed_len;
4252 Buf->BufSize = bufsize;
4253 /* Flush some space after the used payload so valgrind shuts up... */
4255 while ((i < 10) && (Buf->BufUsed + i < Buf->BufSize))
4256 Buf->buf[Buf->BufUsed + i++] = '\0';
4259 free(compressed_data);
4261 #endif /* HAVE_ZLIB */
4265 /*******************************************************************************
4266 * File I/O; Callbacks to libevent *
4267 *******************************************************************************/
4269 long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB)
4274 if ((FB == NULL) || (FB->Buf == NULL))
4278 * check whether the read pointer is somewhere in a range
4279 * where a cut left is inexpensive
4282 if (FB->ReadWritePointer != NULL)
4286 already_read = FB->ReadWritePointer - FB->Buf->buf;
4287 bufremain = FB->Buf->BufSize - FB->Buf->BufUsed - 1;
4289 if (already_read != 0) {
4292 unread = FB->Buf->BufUsed - already_read;
4294 /* else nothing to compact... */
4296 FB->ReadWritePointer = FB->Buf->buf;
4297 bufremain = FB->Buf->BufSize;
4299 else if ((unread < 64) ||
4300 (bufremain < already_read))
4303 * if its just a tiny bit remaining, or we run out of space...
4306 FB->Buf->BufUsed = unread;
4307 if (unread < already_read)
4308 memcpy(FB->Buf->buf, FB->ReadWritePointer, unread);
4310 memmove(FB->Buf->buf, FB->ReadWritePointer, unread);
4311 FB->ReadWritePointer = FB->Buf->buf;
4312 bufremain = FB->Buf->BufSize - unread - 1;
4314 else if (bufremain < (FB->Buf->BufSize / 10))
4316 /* get a bigger buffer */
4318 IncreaseBuf(FB->Buf, 0, FB->Buf->BufUsed + 1);
4320 FB->ReadWritePointer = FB->Buf->buf + unread;
4322 bufremain = FB->Buf->BufSize - unread - 1;
4323 /*TODO: special increase function that won't copy the already read! */
4326 else if (bufremain < 10) {
4327 IncreaseBuf(FB->Buf, 1, FB->Buf->BufUsed + 10);
4329 FB->ReadWritePointer = FB->Buf->buf;
4331 bufremain = FB->Buf->BufSize - FB->Buf->BufUsed - 1;
4336 FB->ReadWritePointer = FB->Buf->buf;
4337 bufremain = FB->Buf->BufSize - 1;
4340 n = read(fd, FB->Buf->buf + FB->Buf->BufUsed, bufremain);
4343 FB->Buf->BufUsed += n;
4344 FB->Buf->buf[FB->Buf->BufUsed] = '\0';
4349 int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB)
4354 if ((FB == NULL) || (FB->Buf == NULL))
4357 if (FB->ReadWritePointer != NULL)
4359 WriteRemain = FB->Buf->BufUsed -
4360 (FB->ReadWritePointer -
4364 FB->ReadWritePointer = FB->Buf->buf;
4365 WriteRemain = FB->Buf->BufUsed;
4368 n = write(fd, FB->ReadWritePointer, WriteRemain);
4370 FB->ReadWritePointer += n;
4372 if (FB->ReadWritePointer ==
4373 FB->Buf->buf + FB->Buf->BufUsed)
4375 FlushStrBuf(FB->Buf);
4376 FB->ReadWritePointer = NULL;
4379 // check whether we've got something to write
4380 // get the maximum chunk plus the pointer we can send
4381 // write whats there
4382 // if not all was sent, remember the send pointer for the next time
4383 return FB->ReadWritePointer - FB->Buf->buf + FB->Buf->BufUsed;
4389 * @ingroup StrBuf_IO
4390 * @brief extract a "next line" from Buf; Ptr to persist across several iterations
4391 * @param LineBuf your line will be copied here.
4392 * @param FB BLOB with lines of text...
4393 * @param Ptr moved arround to keep the next-line across several iterations
4394 * has to be &NULL on start; will be &NotNULL on end of buffer
4395 * @returns size of copied buffer
4397 eReadState StrBufChunkSipLine(StrBuf *LineBuf, IOBuffer *FB)
4399 const char *aptr, *ptr, *eptr;
4402 if ((FB == NULL) || (LineBuf == NULL) || (LineBuf->buf == NULL))
4406 if ((FB->Buf == NULL) || (FB->ReadWritePointer == StrBufNOTNULL)) {
4407 FB->ReadWritePointer = StrBufNOTNULL;
4411 FlushStrBuf(LineBuf);
4412 if (FB->ReadWritePointer == NULL)
4413 ptr = aptr = FB->Buf->buf;
4415 ptr = aptr = FB->ReadWritePointer;
4417 optr = LineBuf->buf;
4418 eptr = FB->Buf->buf + FB->Buf->BufUsed;
4419 xptr = LineBuf->buf + LineBuf->BufSize - 1;
4421 while ((ptr <= eptr) &&
4428 LineBuf->BufUsed = optr - LineBuf->buf;
4429 IncreaseBuf(LineBuf, 1, LineBuf->BufUsed + 1);
4430 optr = LineBuf->buf + LineBuf->BufUsed;
4431 xptr = LineBuf->buf + LineBuf->BufSize - 1;
4436 if (optr > LineBuf->buf)
4438 if ((*(ptr - 1) != '\r') && (*(ptr - 1) != '\n')) {
4439 LineBuf->BufUsed = optr - LineBuf->buf;
4441 if ((FB->ReadWritePointer != NULL) &&
4442 (FB->ReadWritePointer != FB->Buf->buf))
4444 /* Ok, the client application read all the data
4445 it was interested in so far. Since there is more to read,
4446 we now shrink the buffer, and move the rest over.
4448 StrBufCutLeft(FB->Buf,
4449 FB->ReadWritePointer - FB->Buf->buf);
4450 FB->ReadWritePointer = FB->Buf->buf;
4452 return eMustReadMore;
4455 LineBuf->BufUsed = optr - LineBuf->buf;
4457 if ((ptr <= eptr) && (*ptr == '\r'))
4459 if ((ptr <= eptr) && (*ptr == '\n'))
4463 FB->ReadWritePointer = ptr;
4466 FlushStrBuf(FB->Buf);
4467 FB->ReadWritePointer = NULL;
4470 return eReadSuccess;
4474 * @ingroup StrBuf_CHUNKED_IO
4475 * @brief check whether the chunk-buffer has more data waiting or not.
4476 * @param FB Chunk-Buffer to inspect
4478 eReadState StrBufCheckBuffer(IOBuffer *FB)
4482 if (FB->Buf->BufUsed == 0)
4483 return eReadSuccess;
4484 if (FB->ReadWritePointer == NULL)
4485 return eBufferNotEmpty;
4486 if (FB->Buf->buf + FB->Buf->BufUsed > FB->ReadWritePointer)
4487 return eBufferNotEmpty;
4488 return eReadSuccess;
4491 long IOBufferStrLength(IOBuffer *FB)
4493 if ((FB == NULL) || (FB->Buf == NULL))
4495 if (FB->ReadWritePointer == NULL)
4496 return StrLength(FB->Buf);
4498 return StrLength(FB->Buf) - (FB->ReadWritePointer - FB->Buf->buf);
4501 inline static void FDIOBufferFlush(FDIOBuffer *FDB)
4503 memset(FDB, 0, sizeof(FDIOBuffer));
4505 FDB->SplicePipe[0] = -1;
4506 FDB->SplicePipe[1] = -1;
4509 void FDIOBufferInit(FDIOBuffer *FDB, IOBuffer *IO, int FD, long TotalSendSize)
4511 FDIOBufferFlush(FDB);
4513 FDB->TotalSendSize = TotalSendSize;
4514 if (TotalSendSize > 0)
4515 FDB->ChunkSize = TotalSendSize;
4518 TotalSendSize = SIZ * 10;
4519 FDB->ChunkSize = TotalSendSize;
4525 pipe(FDB->SplicePipe);
4528 FDB->ChunkBuffer = NewStrBufPlain(NULL, TotalSendSize+ 1);
4533 void FDIOBufferDelete(FDIOBuffer *FDB)
4538 if (FDB->SplicePipe[0] > 0)
4539 close(FDB->SplicePipe[0]);
4540 if (FDB->SplicePipe[1] > 0)
4541 close(FDB->SplicePipe[1]);
4545 FreeStrBuf(&FDB->ChunkBuffer);
4547 if (FDB->OtherFD > 0)
4548 close(FDB->OtherFD);
4549 FDIOBufferFlush(FDB);
4552 int FileSendChunked(FDIOBuffer *FDB, const char **Err)
4554 ssize_t sent, pipesize;
4556 if (FDB->TotalSendSize > 0)
4561 if (FDB->PipeSize == 0)
4563 pipesize = splice(FDB->OtherFD,
4564 &FDB->TotalSentAlready,
4567 FDB->ChunkSendRemain,
4572 *Err = strerror(errno);
4575 FDB->PipeSize = pipesize;
4577 sent = splice(FDB->SplicePipe[0],
4582 SPLICE_F_MORE | SPLICE_F_MOVE | SPLICE_F_NONBLOCK);
4585 *Err = strerror(errno);
4588 FDB->PipeSize -= sent;
4589 FDB->ChunkSendRemain -= sent;
4598 pRead = FDB->ChunkBuffer->buf;
4599 while ((FDB->ChunkBuffer->BufUsed < FDB->TotalSendSize) && (nRead >= 0))
4601 nRead = read(FDB->OtherFD, pRead, FDB->TotalSendSize - FDB->ChunkBuffer->BufUsed);
4603 FDB->ChunkBuffer->BufUsed += nRead;
4604 FDB->ChunkBuffer->buf[FDB->ChunkBuffer->BufUsed] = '\0';
4606 else if (nRead == 0) {}
4610 nRead = write(FDB->IOB->fd,
4611 FDB->ChunkBuffer->buf + FDB->TotalSentAlready,
4612 FDB->ChunkBuffer->BufUsed - FDB->TotalSentAlready);
4615 FDB->TotalSentAlready += nRead;
4616 FDB->ChunkSendRemain -= nRead;
4617 return FDB->ChunkSendRemain;
4629 if (FDB->PipeSize == 0)
4631 pipesize = splice(FDB->OtherFD,
4632 &FDB->TotalSentAlready,
4640 *Err = strerror(errno);
4643 FDB->PipeSize = pipesize;
4647 sent = splice(FDB->SplicePipe[0],
4652 SPLICE_F_MORE | SPLICE_F_MOVE | SPLICE_F_NONBLOCK);
4655 *Err = strerror(errno);
4658 FDB->PipeSize -= sent;
4659 FDB->ChunkSendRemain -= sent;
4668 pRead = FDB->ChunkBuffer->buf;
4669 while ((FDB->ChunkSendRemain == 0) &&
4670 (FDB->ChunkBuffer->BufUsed < FDB->ChunkBuffer->BufSize) &&
4673 FDB->TotalSentAlready = 0;
4674 nRead = read(FDB->OtherFD, pRead, FDB->ChunkBuffer->BufSize - FDB->ChunkBuffer->BufUsed);
4676 FDB->ChunkBuffer->BufUsed += nRead;
4677 FDB->ChunkBuffer->buf[FDB->ChunkBuffer->BufUsed] = '\0';
4678 FDB->ChunkSendRemain += nRead;
4680 else if (nRead == 0)
4686 *Err = strerror(errno);
4691 nRead = write(FDB->IOB->fd,
4692 FDB->ChunkBuffer->buf + FDB->TotalSentAlready,
4693 FDB->ChunkBuffer->BufUsed - FDB->TotalSentAlready);
4696 FDB->TotalSentAlready += nRead;
4697 FDB->ChunkSendRemain -= nRead;
4698 if (FDB->ChunkSendRemain == 0)
4700 FDB->ChunkBuffer->BufUsed = 0;
4701 FDB->TotalSentAlready = 0;
4703 return FDB->ChunkSendRemain;
4712 int FileRecvChunked(FDIOBuffer *FDB, const char **Err)
4714 ssize_t sent, pipesize;
4719 if (FDB->PipeSize == 0)
4721 pipesize = splice(FDB->IOB->fd,
4725 FDB->ChunkSendRemain,
4726 SPLICE_F_MORE | SPLICE_F_MOVE|SPLICE_F_NONBLOCK);
4730 *Err = strerror(errno);
4733 FDB->PipeSize = pipesize;
4736 sent = splice(FDB->SplicePipe[0],
4739 &FDB->TotalSentAlready,
4741 SPLICE_F_MORE | SPLICE_F_MOVE);
4745 *Err = strerror(errno);
4748 FDB->PipeSize -= sent;
4749 FDB->ChunkSendRemain -= sent;
4755 sent = read(FDB->IOB->fd, FDB->ChunkBuffer->buf, FDB->ChunkSendRemain);
4760 FDB->ChunkBuffer->BufUsed = sent;
4762 while (nWritten < FDB->ChunkBuffer->BufUsed) {
4763 rc = write(FDB->OtherFD, FDB->ChunkBuffer->buf + nWritten, FDB->ChunkBuffer->BufUsed - nWritten);
4765 *Err = strerror(errno);
4771 FDB->ChunkBuffer->BufUsed = 0;
4772 FDB->TotalSentAlready += sent;
4773 FDB->ChunkSendRemain -= sent;
4774 return FDB->ChunkSendRemain;
4776 else if (sent < 0) {
4777 *Err = strerror(errno);
4784 int FileMoveChunked(FDIOBuffer *FDB, const char **Err)
4786 ssize_t sent, pipesize;
4791 if (FDB->PipeSize == 0)
4793 pipesize = splice(FDB->IOB->fd,
4794 &FDB->TotalReadAlready,
4797 FDB->ChunkSendRemain,
4798 SPLICE_F_MORE | SPLICE_F_MOVE|SPLICE_F_NONBLOCK);
4802 *Err = strerror(errno);
4805 FDB->PipeSize = pipesize;
4808 sent = splice(FDB->SplicePipe[0],
4811 &FDB->TotalSentAlready,
4813 SPLICE_F_MORE | SPLICE_F_MOVE);
4817 *Err = strerror(errno);
4820 FDB->PipeSize -= sent;
4821 FDB->ChunkSendRemain -= sent;
4827 sent = read(FDB->IOB->fd, FDB->ChunkBuffer->buf, FDB->ChunkSendRemain);
4832 FDB->ChunkBuffer->BufUsed = sent;
4834 while (nWritten < FDB->ChunkBuffer->BufUsed) {
4835 rc = write(FDB->OtherFD, FDB->ChunkBuffer->buf + nWritten, FDB->ChunkBuffer->BufUsed - nWritten);
4837 *Err = strerror(errno);
4843 FDB->ChunkBuffer->BufUsed = 0;
4844 FDB->TotalSentAlready += sent;
4845 FDB->ChunkSendRemain -= sent;
4846 return FDB->ChunkSendRemain;
4848 else if (sent < 0) {
4849 *Err = strerror(errno);
4856 eReadState WriteIOBAlreadyRead(FDIOBuffer *FDB, const char **Error)
4862 int nSuccessLess = 0;
4866 fdflags = fcntl(FDB->OtherFD, F_GETFL);
4867 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
4869 while ((FDB->IOB->ReadWritePointer - FDB->IOB->Buf->buf < FDB->IOB->Buf->BufUsed) &&
4870 (FDB->ChunkSendRemain > 0))
4873 tv.tv_sec = 1; /* selectresolution; */
4877 FD_SET(FDB->OtherFD, &rfds);
4878 if (select(FDB->OtherFD + 1, NULL, &rfds, NULL, &tv) == -1) {
4879 *Error = strerror(errno);
4883 if (IsNonBlock && ! FD_ISSET(FDB->OtherFD, &rfds)) {
4888 should_write = FDB->IOB->Buf->BufUsed -
4889 (FDB->IOB->ReadWritePointer - FDB->IOB->Buf->buf);
4890 if (should_write > FDB->ChunkSendRemain)
4891 should_write = FDB->ChunkSendRemain;
4893 rlen = write(FDB->OtherFD,
4894 FDB->IOB->ReadWritePointer,
4897 *Error = strerror(errno);
4901 FDB->TotalSentAlready += rlen;
4902 FDB->IOB->ReadWritePointer += rlen;
4903 FDB->ChunkSendRemain -= rlen;
4905 if (FDB->IOB->ReadWritePointer >= FDB->IOB->Buf->buf + FDB->IOB->Buf->BufUsed)
4907 FlushStrBuf(FDB->IOB->Buf);
4908 FDB->IOB->ReadWritePointer = NULL;
4911 if (FDB->ChunkSendRemain == 0)
4912 return eReadSuccess;
4914 return eMustReadMore;
4917 /*******************************************************************************
4918 * File I/O; Prefer buffered read since its faster! *
4919 *******************************************************************************/
4922 * @ingroup StrBuf_IO
4923 * @brief Read a line from socket
4924 * flushes and closes the FD on error
4925 * @param buf the buffer to get the input to
4926 * @param fd pointer to the filedescriptor to read
4927 * @param append Append to an existing string or replace?
4928 * @param Error strerror() on error
4929 * @returns numbers of chars read
4931 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error)
4933 int len, rlen, slen;
4935 if ((buf == NULL) || (buf->buf == NULL)) {
4936 *Error = strerror(EINVAL);
4943 slen = len = buf->BufUsed;
4945 rlen = read(*fd, &buf->buf[len], 1);
4947 *Error = strerror(errno);
4954 if (buf->buf[len] == '\n')
4956 if (buf->buf[len] != '\r')
4958 if (len + 2 >= buf->BufSize) {
4960 buf->buf[len+1] = '\0';
4961 IncreaseBuf(buf, 1, -1);
4965 buf->buf[len] = '\0';
4970 * @ingroup StrBuf_BufferedIO
4971 * @brief Read a line from socket
4972 * flushes and closes the FD on error
4973 * @param Line the line to read from the fd / I/O Buffer
4974 * @param buf the buffer to get the input to
4975 * @param fd pointer to the filedescriptor to read
4976 * @param timeout number of successless selects until we bail out
4977 * @param selectresolution how long to wait on each select
4978 * @param Error strerror() on error
4979 * @returns numbers of chars read
4981 int StrBufTCP_read_buffered_line(StrBuf *Line,
4985 int selectresolution,
4989 int nSuccessLess = 0;
4996 if (buf->BufUsed > 0) {
4997 pch = strchr(buf->buf, '\n');
5000 len = pch - buf->buf;
5001 if (len > 0 && (*(pch - 1) == '\r') )
5003 StrBufSub(Line, buf, 0, len - rlen);
5004 StrBufCutLeft(buf, len + 1);
5009 if (buf->BufSize - buf->BufUsed < 10)
5010 IncreaseBuf(buf, 1, -1);
5012 fdflags = fcntl(*fd, F_GETFL);
5013 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
5015 while ((nSuccessLess < timeout) && (pch == NULL)) {
5017 tv.tv_sec = selectresolution;
5022 if (select(*fd + 1, NULL, &rfds, NULL, &tv) == -1) {
5023 *Error = strerror(errno);
5029 if (IsNonBlock && ! FD_ISSET(*fd, &rfds)) {
5034 &buf->buf[buf->BufUsed],
5035 buf->BufSize - buf->BufUsed - 1);
5037 *Error = strerror(errno);
5042 else if (rlen > 0) {
5044 buf->BufUsed += rlen;
5045 buf->buf[buf->BufUsed] = '\0';
5046 pch = strchr(buf->buf, '\n');
5047 if ((pch == NULL) &&
5048 (buf->BufUsed + 10 > buf->BufSize) &&
5049 (IncreaseBuf(buf, 1, -1) == -1))
5057 len = pch - buf->buf;
5058 if (len > 0 && (*(pch - 1) == '\r') )
5060 StrBufSub(Line, buf, 0, len - rlen);
5061 StrBufCutLeft(buf, len + 1);
5068 static const char *ErrRBLF_PreConditionFailed="StrBufTCP_read_buffered_line_fast: Wrong arguments or invalid Filedescriptor";
5069 static const char *ErrRBLF_SelectFailed="StrBufTCP_read_buffered_line_fast: Select failed without reason";
5070 static const char *ErrRBLF_NotEnoughSentFromServer="StrBufTCP_read_buffered_line_fast: No complete line was sent from peer";
5072 * @ingroup StrBuf_BufferedIO
5073 * @brief Read a line from socket
5074 * flushes and closes the FD on error
5075 * @param Line where to append our Line read from the fd / I/O Buffer;
5076 * @param IOBuf the buffer to get the input to; lifetime pair to FD
5077 * @param Pos pointer to the current read position, should be NULL initialized on opening the FD it belongs to.!
5078 * @param fd pointer to the filedescriptor to read
5079 * @param timeout number of successless selects until we bail out
5080 * @param selectresolution how long to wait on each select
5081 * @param Error strerror() on error
5082 * @returns numbers of chars read or -1 in case of error. "\n" will become 0
5084 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
5089 int selectresolution,
5092 const char *pche = NULL;
5093 const char *pos = NULL;
5095 int len, rlen, retlen;
5096 int nSuccessLess = 0;
5098 const char *pch = NULL;
5104 if ((Line == NULL) ||
5111 *Error = ErrRBLF_PreConditionFailed;
5116 if ((IOBuf->BufUsed > 0) &&
5118 (pos < IOBuf->buf + IOBuf->BufUsed))
5122 pche = IOBuf->buf + IOBuf->BufUsed;
5126 while ((pch < pche) && (*pch != '\n'))
5128 if (Line->BufUsed + 10 > Line->BufSize)
5131 apos = pcht - Line->buf;
5133 IncreaseBuf(Line, 1, -1);
5134 pcht = Line->buf + apos;
5142 if (len > 0 && (*(pch - 1) == '\r') )
5151 if ((pch >= pche) || (*pch == '\0'))
5159 if ((pch != NULL) &&
5162 if (pch + 1 >= pche) {
5175 /* If we come here, Pos is Unset since we read everything into Line, and now go for more. */
5177 if (IOBuf->BufSize - IOBuf->BufUsed < 10)
5178 IncreaseBuf(IOBuf, 1, -1);
5180 fdflags = fcntl(*fd, F_GETFL);
5181 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
5184 while ((nSuccessLess < timeout) &&
5194 if (select((*fd) + 1, &rfds, NULL, NULL, &tv) == -1) {
5195 *Error = strerror(errno);
5199 *Error = ErrRBLF_SelectFailed;
5202 if (! FD_ISSET(*fd, &rfds) != 0) {
5208 &IOBuf->buf[IOBuf->BufUsed],
5209 IOBuf->BufSize - IOBuf->BufUsed - 1);
5211 *Error = strerror(errno);
5216 else if (rlen > 0) {
5218 pLF = IOBuf->buf + IOBuf->BufUsed;
5219 IOBuf->BufUsed += rlen;
5220 IOBuf->buf[IOBuf->BufUsed] = '\0';
5222 pche = IOBuf->buf + IOBuf->BufUsed;
5224 while ((pLF < pche) && (*pLF != '\n'))
5226 if ((pLF >= pche) || (*pLF == '\0'))
5229 if (IOBuf->BufUsed + 10 > IOBuf->BufSize)
5233 if (pLF != NULL) apos = pLF - IOBuf->buf;
5234 IncreaseBuf(IOBuf, 1, -1);
5235 if (pLF != NULL) pLF = IOBuf->buf + apos;
5249 if (len > 0 && (*(pLF - 1) == '\r') )
5251 StrBufAppendBufPlain(Line, ChrPtr(IOBuf), len, 0);
5252 if (pLF + 1 >= IOBuf->buf + IOBuf->BufUsed)
5258 return retlen + len;
5260 *Error = ErrRBLF_NotEnoughSentFromServer;
5265 static const char *ErrRBLF_BLOBPreConditionFailed="StrBufReadBLOB: Wrong arguments or invalid Filedescriptor";
5267 * @ingroup StrBuf_IO
5268 * @brief Input binary data from socket
5269 * flushes and closes the FD on error
5270 * @param Buf the buffer to get the input to
5271 * @param fd pointer to the filedescriptor to read
5272 * @param append Append to an existing string or replace?
5273 * @param nBytes the maximal number of bytes to read
5274 * @param Error strerror() on error
5275 * @returns numbers of chars read
5277 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error)
5288 if ((Buf == NULL) || (Buf->buf == NULL) || (*fd == -1))
5290 *Error = ErrRBLF_BLOBPreConditionFailed;
5295 if (Buf->BufUsed + nBytes >= Buf->BufSize)
5296 IncreaseBuf(Buf, 1, Buf->BufUsed + nBytes);
5298 ptr = Buf->buf + Buf->BufUsed;
5300 fdflags = fcntl(*fd, F_GETFL);
5301 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
5303 while ((nRead < nBytes) &&
5313 if (select(*fd + 1, &rfds, NULL, NULL, &tv) == -1) {
5314 *Error = strerror(errno);
5318 *Error = ErrRBLF_SelectFailed;
5321 if (! FD_ISSET(*fd, &rfds) != 0) {
5327 if ((rlen = read(*fd,
5329 nBytes - nRead)) == -1) {
5332 *Error = strerror(errno);
5337 Buf->BufUsed += rlen;
5339 Buf->buf[Buf->BufUsed] = '\0';
5343 const char *ErrRBB_BLOBFPreConditionFailed = "StrBufReadBLOBBuffered: to many selects; aborting.";
5344 const char *ErrRBB_too_many_selects = "StrBufReadBLOBBuffered: to many selects; aborting.";
5346 * @ingroup StrBuf_BufferedIO
5347 * @brief Input binary data from socket
5348 * flushes and closes the FD on error
5349 * @param Blob put binary thing here
5350 * @param IOBuf the buffer to get the input to
5351 * @param Pos offset inside of IOBuf
5352 * @param fd pointer to the filedescriptor to read
5353 * @param append Append to an existing string or replace?
5354 * @param nBytes the maximal number of bytes to read
5355 * @param check whether we should search for '000\n' terminators in case of timeouts
5356 * @param Error strerror() on error
5357 * @returns numbers of chars read
5359 int StrBufReadBLOBBuffered(StrBuf *Blob,
5372 int nAlreadyRead = 0;
5377 int nSuccessLess = 0;
5380 if ((Blob == NULL) ||
5387 *Error = ErrRBB_BLOBFPreConditionFailed;
5393 if (Blob->BufUsed + nBytes >= Blob->BufSize)
5394 IncreaseBuf(Blob, append, Blob->BufUsed + nBytes);
5399 rlen = pos - IOBuf->buf;
5400 rlen = IOBuf->BufUsed - rlen;
5403 if ((IOBuf->BufUsed > 0) &&
5405 (pos < IOBuf->buf + IOBuf->BufUsed))
5407 if (rlen < nBytes) {
5408 memcpy(Blob->buf + Blob->BufUsed, pos, rlen);
5409 Blob->BufUsed += rlen;
5410 Blob->buf[Blob->BufUsed] = '\0';
5411 nAlreadyRead = nRead = rlen;
5414 if (rlen >= nBytes) {
5415 memcpy(Blob->buf + Blob->BufUsed, pos, nBytes);
5416 Blob->BufUsed += nBytes;
5417 Blob->buf[Blob->BufUsed] = '\0';
5418 if (rlen == nBytes) {
5430 if (IOBuf->BufSize < nBytes - nRead)
5431 IncreaseBuf(IOBuf, 0, nBytes - nRead);
5434 fdflags = fcntl(*fd, F_GETFL);
5435 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
5443 while ((nSuccessLess < MaxTries) &&
5453 if (select(*fd + 1, &rfds, NULL, NULL, &tv) == -1) {
5454 *Error = strerror(errno);
5458 *Error = ErrRBLF_SelectFailed;
5461 if (! FD_ISSET(*fd, &rfds) != 0) {
5468 IOBuf->BufSize - (ptr - IOBuf->buf));
5472 *Error = strerror(errno);
5475 else if (rlen == 0){
5476 if ((check == NNN_TERM) &&
5478 (strncmp(IOBuf->buf + IOBuf->BufUsed - 5, "\n000\n", 5) == 0))
5480 StrBufPlain(Blob, HKEY("\n000\n"));
5481 StrBufCutRight(Blob, 5);
5482 return Blob->BufUsed;
5484 else if (!IsNonBlock)
5486 else if (nSuccessLess > MaxTries) {
5488 *Error = ErrRBB_too_many_selects;
5492 else if (rlen > 0) {
5496 IOBuf->BufUsed += rlen;
5499 if (nSuccessLess >= MaxTries) {
5501 *Error = ErrRBB_too_many_selects;
5505 if (nRead > nBytes) {
5506 *Pos = IOBuf->buf + nBytes;
5508 Blob->buf[Blob->BufUsed] = '\0';
5509 StrBufAppendBufPlain(Blob, IOBuf->buf, nBytes, 0);
5513 return nRead + nAlreadyRead;
5517 * @ingroup StrBuf_IO
5518 * @brief extract a "next line" from Buf; Ptr to persist across several iterations
5519 * @param LineBuf your line will be copied here.
5520 * @param Buf BLOB with lines of text...
5521 * @param Ptr moved arround to keep the next-line across several iterations
5522 * has to be &NULL on start; will be &NotNULL on end of buffer
5523 * @returns size of remaining buffer
5525 int StrBufSipLine(StrBuf *LineBuf, const StrBuf *Buf, const char **Ptr)
5527 const char *aptr, *ptr, *eptr;
5530 if ((Buf == NULL) ||
5531 (*Ptr == StrBufNOTNULL) ||
5533 (LineBuf->buf == NULL))
5535 *Ptr = StrBufNOTNULL;
5539 FlushStrBuf(LineBuf);
5541 ptr = aptr = Buf->buf;
5545 optr = LineBuf->buf;
5546 eptr = Buf->buf + Buf->BufUsed;
5547 xptr = LineBuf->buf + LineBuf->BufSize - 1;
5549 while ((ptr <= eptr) &&
5556 LineBuf->BufUsed = optr - LineBuf->buf;
5557 IncreaseBuf(LineBuf, 1, LineBuf->BufUsed + 1);
5558 optr = LineBuf->buf + LineBuf->BufUsed;
5559 xptr = LineBuf->buf + LineBuf->BufSize - 1;
5563 if ((ptr >= eptr) && (optr > LineBuf->buf))
5565 LineBuf->BufUsed = optr - LineBuf->buf;
5567 if ((ptr <= eptr) && (*ptr == '\r'))
5569 if ((ptr <= eptr) && (*ptr == '\n'))
5576 *Ptr = StrBufNOTNULL;
5579 return Buf->BufUsed - (ptr - Buf->buf);
5584 * @ingroup StrBuf_IO
5585 * @brief removes double slashes from pathnames
5586 * @param Dir directory string to filter
5587 * @param RemoveTrailingSlash allows / disallows trailing slashes
5589 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash)
5595 while (!IsEmptyStr(a)) {
5607 if ((RemoveTrailingSlash) &&
5613 Dir->BufUsed = b - Dir->buf;