2 * Copyright (c) 1987-2013 by the citadel.org team
4 * This program is open source software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #include <sys/select.h>
29 #include <sys/types.h>
30 #define SHOW_ME_VAPPEND_PRINTF
33 #include "libcitadel.h"
49 int ZEXPORT compress_gzip(Bytef * dest, size_t * destLen,
50 const Bytef * source, uLong sourceLen, int level);
52 int BaseStrBufSize = 64;
55 const char *StrBufNOTNULL = ((char*) NULL) - 1;
57 const char HexList[256][3] = {
58 "00","01","02","03","04","05","06","07","08","09","0A","0B","0C","0D","0E","0F",
59 "10","11","12","13","14","15","16","17","18","19","1A","1B","1C","1D","1E","1F",
60 "20","21","22","23","24","25","26","27","28","29","2A","2B","2C","2D","2E","2F",
61 "30","31","32","33","34","35","36","37","38","39","3A","3B","3C","3D","3E","3F",
62 "40","41","42","43","44","45","46","47","48","49","4A","4B","4C","4D","4E","4F",
63 "50","51","52","53","54","55","56","57","58","59","5A","5B","5C","5D","5E","5F",
64 "60","61","62","63","64","65","66","67","68","69","6A","6B","6C","6D","6E","6F",
65 "70","71","72","73","74","75","76","77","78","79","7A","7B","7C","7D","7E","7F",
66 "80","81","82","83","84","85","86","87","88","89","8A","8B","8C","8D","8E","8F",
67 "90","91","92","93","94","95","96","97","98","99","9A","9B","9C","9D","9E","9F",
68 "A0","A1","A2","A3","A4","A5","A6","A7","A8","A9","AA","AB","AC","AD","AE","AF",
69 "B0","B1","B2","B3","B4","B5","B6","B7","B8","B9","BA","BB","BC","BD","BE","BF",
70 "C0","C1","C2","C3","C4","C5","C6","C7","C8","C9","CA","CB","CC","CD","CE","CF",
71 "D0","D1","D2","D3","D4","D5","D6","D7","D8","D9","DA","DB","DC","DD","DE","DF",
72 "E0","E1","E2","E3","E4","E5","E6","E7","E8","E9","EA","EB","EC","ED","EE","EF",
73 "F0","F1","F2","F3","F4","F5","F6","F7","F8","F9","FA","FB","FC","FD","FE","FF"};
76 * @defgroup StrBuf Stringbuffer, A class for manipulating strings with dynamic buffers
77 * StrBuf is a versatile class, aiding the handling of dynamic strings
78 * * reduce de/reallocations
79 * * reduce the need to remeasure it
80 * * reduce scanning over the string (in @ref StrBuf_NextTokenizer "Tokenizers")
81 * * allow asyncroneous IO for line and Blob based operations
82 * * reduce the use of memove in those
83 * * Quick filling in several operations with append functions
87 * @defgroup StrBuf_DeConstructors Create/Destroy StrBufs
92 * @defgroup StrBuf_Cast Cast operators to interact with char* based code
94 * use these operators to interfere with code demanding char*;
95 * if you need to own the content, smash me. Avoid, since we loose the length information.
99 * @defgroup StrBuf_Filler Create/Replace/Append Content into a StrBuf
101 * operations to get your Strings into a StrBuf, manipulating them, or appending
104 * @defgroup StrBuf_NextTokenizer Fast tokenizer to pull tokens in sequence
106 * Quick tokenizer; demands of the user to pull its tokens in sequence
110 * @defgroup StrBuf_Tokenizer tokenizer Functions; Slow ones.
112 * versatile tokenizer; random access to tokens, but slower; Prefer the @ref StrBuf_NextTokenizer "Next Tokenizer"
116 * @defgroup StrBuf_BufferedIO Buffered IO with Asynchroneous reads and no unneeded memmoves (the fast ones)
118 * File IO to fill StrBufs; Works with work-buffer shared across several calls;
119 * External Cursor to maintain the current read position inside of the buffer
120 * the non-fast ones will use memove to keep the start of the buffer the read buffer (which is slower)
124 * @defgroup StrBuf_IO FileIO; Prefer @ref StrBuf_BufferedIO
130 * @defgroup StrBuf_DeEnCoder functions to translate the contents of a buffer
132 * these functions translate the content of a buffer into another representation;
133 * some are combined Fillers and encoders
137 * Private Structure for the Stringbuffer
140 char *buf; /**< the pointer to the dynamic buffer */
141 long BufSize; /**< how many spcae do we optain */
142 long BufUsed; /**< StNumber of Chars used excluding the trailing \\0 */
143 int ConstBuf; /**< are we just a wrapper arround a static buffer and musn't we be changed? */
145 long nIncreases; /**< for profiling; cound how many times we needed more */
146 char bt [SIZ]; /**< Stacktrace of last increase */
147 char bt_lastinc [SIZ]; /**< How much did we increase last time? */
152 static inline int Ctdl_GetUtf8SequenceLength(const char *CharS, const char *CharE);
153 static inline int Ctdl_IsUtf8SequenceStart(const char Char);
156 #ifdef HAVE_BACKTRACE
157 static void StrBufBacktrace(StrBuf *Buf, int which)
161 void *stack_frames[50];
166 pstart = pch = Buf->bt;
168 pstart = pch = Buf->bt_lastinc;
169 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
170 strings = backtrace_symbols(stack_frames, size);
171 for (i = 0; i < size; i++) {
173 n = snprintf(pch, SIZ - (pch - pstart), "%s\\n", strings[i]);
175 n = snprintf(pch, SIZ - (pch - pstart), "%p\\n", stack_frames[i]);
184 void dbg_FreeStrBuf(StrBuf *FreeMe, char *FromWhere)
186 if (hFreeDbglog == -1){
187 pid_t pid = getpid();
189 snprintf(path, SIZ, "/tmp/libcitadel_strbuf_realloc.log.%d", pid);
190 hFreeDbglog = open(path, O_APPEND|O_CREAT|O_WRONLY);
192 if ((*FreeMe)->nIncreases > 0)
196 n = snprintf(buf, SIZ * 3, "%c+|%ld|%ld|%ld|%s|%s|\n",
198 (*FreeMe)->nIncreases,
202 (*FreeMe)->bt_lastinc);
203 n = write(hFreeDbglog, buf, n);
209 n = snprintf(buf, 128, "%c_|0|%ld%ld|\n",
213 n = write(hFreeDbglog, buf, n);
217 void dbg_IncreaseBuf(StrBuf *IncMe)
220 #ifdef HAVE_BACKTRACE
221 StrBufBacktrace(Buf, 1);
225 void dbg_Init(StrBuf *Buf)
229 Buf->bt_lastinc[0] = '\0';
230 #ifdef HAVE_BACKTRACE
231 StrBufBacktrace(Buf, 0);
237 #define dbg_FreeStrBuf(a, b)
238 #define dbg_IncreaseBuf(a)
245 * @brief swaps the contents of two StrBufs
246 * this is to be used to have cheap switched between a work-buffer and a target buffer
248 * @param B second one
250 static inline void SwapBuffers(StrBuf *A, StrBuf *B)
254 memcpy(&C, A, sizeof(*A));
255 memcpy(A, B, sizeof(*B));
256 memcpy(B, &C, sizeof(C));
261 * @ingroup StrBuf_Cast
262 * @brief Cast operator to Plain String
263 * @note if the buffer is altered by StrBuf operations, this pointer may become
264 * invalid. So don't lean on it after altering the buffer!
265 * Since this operation is considered cheap, rather call it often than risking
266 * your pointer to become invalid!
267 * @param Str the string we want to get the c-string representation for
268 * @returns the Pointer to the Content. Don't mess with it!
270 inline const char *ChrPtr(const StrBuf *Str)
278 * @ingroup StrBuf_Cast
279 * @brief since we know strlen()'s result, provide it here.
280 * @param Str the string to return the length to
281 * @returns contentlength of the buffer
283 inline int StrLength(const StrBuf *Str)
285 return (Str != NULL) ? Str->BufUsed : 0;
289 * @ingroup StrBuf_DeConstructors
290 * @brief local utility function to resize the buffer
291 * @param Buf the buffer whichs storage we should increase
292 * @param KeepOriginal should we copy the original buffer or just start over with a new one
293 * @param DestSize what should fit in after?
295 static int IncreaseBuf(StrBuf *Buf, int KeepOriginal, int DestSize)
298 size_t NewSize = Buf->BufSize * 2;
304 while ((NewSize <= DestSize) && (NewSize != 0))
310 NewBuf= (char*) malloc(NewSize);
314 if (KeepOriginal && (Buf->BufUsed > 0))
316 memcpy(NewBuf, Buf->buf, Buf->BufUsed);
325 Buf->BufSize = NewSize;
327 dbg_IncreaseBuf(Buf);
333 * @ingroup StrBuf_DeConstructors
334 * @brief shrink / increase an _EMPTY_ buffer to NewSize. Buffercontent is thoroughly ignored and flushed.
335 * @param Buf Buffer to shrink (has to be empty)
336 * @param ThreshHold if the buffer is bigger then this, its readjusted
337 * @param NewSize if we Shrink it, how big are we going to be afterwards?
339 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize)
342 (Buf->BufUsed == 0) &&
343 (Buf->BufSize < ThreshHold)) {
345 Buf->buf = (char*) malloc(NewSize);
347 Buf->BufSize = NewSize;
352 * @ingroup StrBuf_DeConstructors
353 * @brief shrink long term buffers to their real size so they don't waste memory
354 * @param Buf buffer to shrink
355 * @param Force if not set, will just executed if the buffer is much to big; set for lifetime strings
356 * @returns physical size of the buffer
358 long StrBufShrinkToFit(StrBuf *Buf, int Force)
363 (Buf->BufUsed + (Buf->BufUsed / 3) > Buf->BufSize))
367 TmpBuf = (char*) malloc(Buf->BufUsed + 1);
371 memcpy (TmpBuf, Buf->buf, Buf->BufUsed + 1);
372 Buf->BufSize = Buf->BufUsed + 1;
380 * @ingroup StrBuf_DeConstructors
381 * @brief Allocate a new buffer with default buffer size
382 * @returns the new stringbuffer
384 StrBuf* NewStrBuf(void)
388 NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
392 NewBuf->buf = (char*) malloc(BaseStrBufSize);
393 if (NewBuf->buf == NULL)
398 NewBuf->buf[0] = '\0';
399 NewBuf->BufSize = BaseStrBufSize;
401 NewBuf->ConstBuf = 0;
409 * @ingroup StrBuf_DeConstructors
410 * @brief Copy Constructor; returns a duplicate of CopyMe
411 * @param CopyMe Buffer to faxmilate
412 * @returns the new stringbuffer
414 StrBuf* NewStrBufDup(const StrBuf *CopyMe)
421 NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
425 NewBuf->buf = (char*) malloc(CopyMe->BufSize);
426 if (NewBuf->buf == NULL)
432 memcpy(NewBuf->buf, CopyMe->buf, CopyMe->BufUsed + 1);
433 NewBuf->BufUsed = CopyMe->BufUsed;
434 NewBuf->BufSize = CopyMe->BufSize;
435 NewBuf->ConstBuf = 0;
443 * @ingroup StrBuf_DeConstructors
444 * @brief Copy Constructor; CreateRelpaceMe will contain CopyFlushMe afterwards.
445 * @param NoMe if non-NULL, we will use that buffer as value; KeepOriginal will abused as len.
446 * @param CopyFlushMe Buffer to faxmilate if KeepOriginal, or to move into CreateRelpaceMe if !KeepOriginal.
447 * @param CreateRelpaceMe If NULL, will be created, else Flushed and filled CopyFlushMe
448 * @param KeepOriginal should CopyFlushMe remain intact? or may we Steal its buffer?
449 * @returns the new stringbuffer
451 void NewStrBufDupAppendFlush(StrBuf **CreateRelpaceMe, StrBuf *CopyFlushMe, const char *NoMe, int KeepOriginal)
455 if (CreateRelpaceMe == NULL)
460 if (*CreateRelpaceMe != NULL)
461 StrBufPlain(*CreateRelpaceMe, NoMe, KeepOriginal);
463 *CreateRelpaceMe = NewStrBufPlain(NoMe, KeepOriginal);
467 if (CopyFlushMe == NULL)
469 if (*CreateRelpaceMe != NULL)
470 FlushStrBuf(*CreateRelpaceMe);
472 *CreateRelpaceMe = NewStrBuf();
477 * Randomly Chosen: bigger than 64 chars is cheaper to swap the buffers instead of copying.
478 * else *CreateRelpaceMe may use more memory than needed in a longer term, CopyFlushMe might
479 * be a big IO-Buffer...
481 if (KeepOriginal || (StrLength(CopyFlushMe) < 256))
483 if (*CreateRelpaceMe == NULL)
485 *CreateRelpaceMe = NewBuf = NewStrBufPlain(NULL, CopyFlushMe->BufUsed);
490 NewBuf = *CreateRelpaceMe;
493 StrBufAppendBuf(NewBuf, CopyFlushMe, 0);
497 if (*CreateRelpaceMe == NULL)
499 *CreateRelpaceMe = NewBuf = NewStrBufPlain(NULL, CopyFlushMe->BufUsed);
503 NewBuf = *CreateRelpaceMe;
504 SwapBuffers (NewBuf, CopyFlushMe);
507 FlushStrBuf(CopyFlushMe);
512 * @ingroup StrBuf_DeConstructors
513 * @brief create a new Buffer using an existing c-string
514 * this function should also be used if you want to pre-suggest
515 * the buffer size to allocate in conjunction with ptr == NULL
516 * @param ptr the c-string to copy; may be NULL to create a blank instance
517 * @param nChars How many chars should we copy; -1 if we should measure the length ourselves
518 * @returns the new stringbuffer
520 StrBuf* NewStrBufPlain(const char* ptr, int nChars)
523 size_t Siz = BaseStrBufSize;
526 NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
531 CopySize = strlen((ptr != NULL)?ptr:"");
535 while ((Siz <= CopySize) && (Siz != 0))
544 NewBuf->buf = (char*) malloc(Siz);
545 if (NewBuf->buf == NULL)
550 NewBuf->BufSize = Siz;
552 memcpy(NewBuf->buf, ptr, CopySize);
553 NewBuf->buf[CopySize] = '\0';
554 NewBuf->BufUsed = CopySize;
557 NewBuf->buf[0] = '\0';
560 NewBuf->ConstBuf = 0;
568 * @ingroup StrBuf_DeConstructors
569 * @brief Set an existing buffer from a c-string
570 * @param Buf buffer to load
571 * @param ptr c-string to put into
572 * @param nChars set to -1 if we should work 0-terminated
573 * @returns the new length of the string
575 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars)
590 CopySize = strlen(ptr);
594 while ((Siz <= CopySize) && (Siz != 0))
602 if (Siz != Buf->BufSize)
603 IncreaseBuf(Buf, 0, Siz);
604 memcpy(Buf->buf, ptr, CopySize);
605 Buf->buf[CopySize] = '\0';
606 Buf->BufUsed = CopySize;
613 * @ingroup StrBuf_DeConstructors
614 * @brief use strbuf as wrapper for a string constant for easy handling
615 * @param StringConstant a string to wrap
616 * @param SizeOfStrConstant should be sizeof(StringConstant)-1
618 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant)
622 NewBuf = (StrBuf*) malloc(sizeof(StrBuf));
625 NewBuf->buf = (char*) StringConstant;
626 NewBuf->BufSize = SizeOfStrConstant;
627 NewBuf->BufUsed = SizeOfStrConstant;
628 NewBuf->ConstBuf = 1;
637 * @ingroup StrBuf_DeConstructors
638 * @brief flush the content of a Buf; keep its struct
639 * @param buf Buffer to flush
641 int FlushStrBuf(StrBuf *buf)
643 if ((buf == NULL) || (buf->buf == NULL))
653 * @ingroup StrBuf_DeConstructors
654 * @brief wipe the content of a Buf thoroughly (overwrite it -> expensive); keep its struct
655 * @param buf Buffer to wipe
657 int FLUSHStrBuf(StrBuf *buf)
663 if (buf->BufUsed > 0) {
664 memset(buf->buf, 0, buf->BufUsed);
671 int hFreeDbglog = -1;
674 * @ingroup StrBuf_DeConstructors
675 * @brief Release a Buffer
676 * Its a double pointer, so it can NULL your pointer
677 * so fancy SIG11 appear instead of random results
678 * @param FreeMe Pointer Pointer to the buffer to free
680 void FreeStrBuf (StrBuf **FreeMe)
685 dbg_FreeStrBuf(FreeMe, 'F');
687 if (!(*FreeMe)->ConstBuf)
688 free((*FreeMe)->buf);
694 * @ingroup StrBuf_DeConstructors
695 * @brief flatten a Buffer to the Char * we return
696 * Its a double pointer, so it can NULL your pointer
697 * so fancy SIG11 appear instead of random results
698 * The Callee then owns the buffer and is responsible for freeing it.
699 * @param SmashMe Pointer Pointer to the buffer to release Buf from and free
700 * @returns the pointer of the buffer; Callee owns the memory thereafter.
702 char *SmashStrBuf (StrBuf **SmashMe)
706 if ((SmashMe == NULL) || (*SmashMe == NULL))
709 dbg_FreeStrBuf(SmashMe, 'S');
711 Ret = (*SmashMe)->buf;
718 * @ingroup StrBuf_DeConstructors
719 * @brief Release the buffer
720 * If you want put your StrBuf into a Hash, use this as Destructor.
721 * @param VFreeMe untyped pointer to a StrBuf. be shure to do the right thing [TM]
723 void HFreeStrBuf (void *VFreeMe)
725 StrBuf *FreeMe = (StrBuf*)VFreeMe;
729 dbg_FreeStrBuf(SmashMe, 'H');
731 if (!FreeMe->ConstBuf)
737 /*******************************************************************************
738 * Simple string transformations *
739 *******************************************************************************/
743 * @brief Wrapper around atol
745 long StrTol(const StrBuf *Buf)
750 return atol(Buf->buf);
757 * @brief Wrapper around atoi
759 int StrToi(const StrBuf *Buf)
763 if (Buf->BufUsed > 0)
764 return atoi(Buf->buf);
771 * @brief Checks to see if the string is a pure number
772 * @param Buf The buffer to inspect
773 * @returns 1 if its a pure number, 0, if not.
775 int StrBufIsNumber(const StrBuf *Buf) {
777 if ((Buf == NULL) || (Buf->BufUsed == 0)) {
780 strtoll(Buf->buf, &pEnd, 10);
781 if (pEnd == Buf->buf)
783 if ((pEnd != NULL) && (pEnd == Buf->buf + Buf->BufUsed))
785 if (Buf->buf == pEnd)
791 * @ingroup StrBuf_Filler
792 * @brief modifies a Single char of the Buf
793 * You can point to it via char* or a zero-based integer
794 * @param Buf The buffer to manipulate
795 * @param ptr char* to zero; use NULL if unused
796 * @param nThChar zero based pointer into the string; use -1 if unused
797 * @param PeekValue The Character to place into the position
799 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue)
804 nThChar = ptr - Buf->buf;
805 if ((nThChar < 0) || (nThChar > Buf->BufUsed))
807 Buf->buf[nThChar] = PeekValue;
812 * @ingroup StrBuf_Filler
813 * @brief modifies a range of chars of the Buf
814 * You can point to it via char* or a zero-based integer
815 * @param Buf The buffer to manipulate
816 * @param ptr char* to zero; use NULL if unused
817 * @param nThChar zero based pointer into the string; use -1 if unused
818 * @param nChars how many chars are to be flushed?
819 * @param PookValue The Character to place into that area
821 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue)
826 nThChar = ptr - Buf->buf;
827 if ((nThChar < 0) || (nThChar > Buf->BufUsed))
829 if (nThChar + nChars > Buf->BufUsed)
830 nChars = Buf->BufUsed - nThChar;
832 memset(Buf->buf + nThChar, PookValue, nChars);
833 /* just to be shure... */
834 Buf->buf[Buf->BufUsed] = 0;
839 * @ingroup StrBuf_Filler
840 * @brief Append a StringBuffer to the buffer
841 * @param Buf Buffer to modify
842 * @param AppendBuf Buffer to copy at the end of our buffer
843 * @param Offset Should we start copying from an offset?
845 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset)
847 if ((AppendBuf == NULL) || (AppendBuf->buf == NULL) ||
848 (Buf == NULL) || (Buf->buf == NULL))
851 if (Buf->BufSize - Offset < AppendBuf->BufUsed + Buf->BufUsed + 1)
854 AppendBuf->BufUsed + Buf->BufUsed);
856 memcpy(Buf->buf + Buf->BufUsed,
857 AppendBuf->buf + Offset,
858 AppendBuf->BufUsed - Offset);
859 Buf->BufUsed += AppendBuf->BufUsed - Offset;
860 Buf->buf[Buf->BufUsed] = '\0';
865 * @ingroup StrBuf_Filler
866 * @brief Append a C-String to the buffer
867 * @param Buf Buffer to modify
868 * @param AppendBuf Buffer to copy at the end of our buffer
869 * @param AppendSize number of bytes to copy; set to -1 if we should count it in advance
870 * @param Offset Should we start copying from an offset?
872 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset)
875 long BufSizeRequired;
877 if ((AppendBuf == NULL) || (Buf == NULL))
881 aps = strlen(AppendBuf + Offset);
883 aps = AppendSize - Offset;
885 BufSizeRequired = Buf->BufUsed + aps + 1;
886 if (Buf->BufSize <= BufSizeRequired)
887 IncreaseBuf(Buf, (Buf->BufUsed > 0), BufSizeRequired);
889 memcpy(Buf->buf + Buf->BufUsed,
893 Buf->buf[Buf->BufUsed] = '\0';
897 * @ingroup StrBuf_Filler
898 * @brief sprintf like function appending the formated string to the buffer
899 * vsnprintf version to wrap into own calls
900 * @param Buf Buffer to extend by format and Params
901 * @param format printf alike format to add
902 * @param ap va_list containing the items for format
904 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap)
912 if ((Buf == NULL) || (format == NULL))
915 BufSize = Buf->BufSize;
916 nWritten = Buf->BufSize + 1;
917 Offset = Buf->BufUsed;
918 newused = Offset + nWritten;
920 while (newused >= BufSize) {
922 nWritten = vsnprintf(Buf->buf + Offset,
923 Buf->BufSize - Offset,
926 newused = Offset + nWritten;
927 if (newused >= Buf->BufSize) {
928 if (IncreaseBuf(Buf, 1, newused) == -1)
929 return; /* TODO: error handling? */
930 newused = Buf->BufSize + 1;
933 Buf->BufUsed = Offset + nWritten;
934 BufSize = Buf->BufSize;
941 * @ingroup StrBuf_Filler
942 * @brief sprintf like function appending the formated string to the buffer
943 * @param Buf Buffer to extend by format and Params
944 * @param format printf alike format to add
946 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...)
954 if ((Buf == NULL) || (format == NULL))
957 BufSize = Buf->BufSize;
958 nWritten = Buf->BufSize + 1;
959 Offset = Buf->BufUsed;
960 newused = Offset + nWritten;
962 while (newused >= BufSize) {
963 va_start(arg_ptr, format);
964 nWritten = vsnprintf(Buf->buf + Buf->BufUsed,
965 Buf->BufSize - Buf->BufUsed,
968 newused = Buf->BufUsed + nWritten;
969 if (newused >= Buf->BufSize) {
970 if (IncreaseBuf(Buf, 1, newused) == -1)
971 return; /* TODO: error handling? */
972 newused = Buf->BufSize + 1;
975 Buf->BufUsed += nWritten;
976 BufSize = Buf->BufSize;
983 * @ingroup StrBuf_Filler
984 * @brief sprintf like function putting the formated string into the buffer
985 * @param Buf Buffer to extend by format and Parameters
986 * @param format printf alike format to add
988 void StrBufPrintf(StrBuf *Buf, const char *format, ...)
993 if ((Buf == NULL) || (format == NULL))
996 nWritten = Buf->BufSize + 1;
997 while (nWritten >= Buf->BufSize) {
998 va_start(arg_ptr, format);
999 nWritten = vsnprintf(Buf->buf, Buf->BufSize, format, arg_ptr);
1001 if (nWritten >= Buf->BufSize) {
1002 if (IncreaseBuf(Buf, 0, 0) == -1)
1003 return; /* TODO: error handling? */
1004 nWritten = Buf->BufSize + 1;
1007 Buf->BufUsed = nWritten ;
1012 * @ingroup StrBuf_Filler
1013 * @brief Callback for cURL to append the webserver reply to a buffer
1014 * @param ptr pre-defined by the cURL API; see man 3 curl for mre info
1015 * @param size pre-defined by the cURL API; see man 3 curl for mre info
1016 * @param nmemb pre-defined by the cURL API; see man 3 curl for mre info
1017 * @param stream pre-defined by the cURL API; see man 3 curl for mre info
1019 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream)
1028 StrBufAppendBufPlain(Target, ptr, size * nmemb, 0);
1029 return size * nmemb;
1035 * @brief extracts a substring from Source into dest
1036 * @param dest buffer to place substring into
1037 * @param Source string to copy substring from
1038 * @param Offset chars to skip from start
1039 * @param nChars number of chars to copy
1040 * @returns the number of chars copied; may be different from nChars due to the size of Source
1042 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars)
1044 size_t NCharsRemain;
1045 if (Offset > Source->BufUsed)
1051 if (Offset + nChars < Source->BufUsed)
1053 if ((nChars >= dest->BufSize) &&
1054 (IncreaseBuf(dest, 0, nChars + 1) == -1))
1056 memcpy(dest->buf, Source->buf + Offset, nChars);
1057 dest->BufUsed = nChars;
1058 dest->buf[dest->BufUsed] = '\0';
1061 NCharsRemain = Source->BufUsed - Offset;
1062 if ((NCharsRemain >= dest->BufSize) &&
1063 (IncreaseBuf(dest, 0, NCharsRemain + 1) == -1))
1065 memcpy(dest->buf, Source->buf + Offset, NCharsRemain);
1066 dest->BufUsed = NCharsRemain;
1067 dest->buf[dest->BufUsed] = '\0';
1068 return NCharsRemain;
1073 * @brief Cut nChars from the start of the string
1074 * @param Buf Buffer to modify
1075 * @param nChars how many chars should be skipped?
1077 void StrBufCutLeft(StrBuf *Buf, int nChars)
1079 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1080 if (nChars >= Buf->BufUsed) {
1084 memmove(Buf->buf, Buf->buf + nChars, Buf->BufUsed - nChars);
1085 Buf->BufUsed -= nChars;
1086 Buf->buf[Buf->BufUsed] = '\0';
1091 * @brief Cut the trailing n Chars from the string
1092 * @param Buf Buffer to modify
1093 * @param nChars how many chars should be trunkated?
1095 void StrBufCutRight(StrBuf *Buf, int nChars)
1097 if ((Buf == NULL) || (Buf->BufUsed == 0) || (Buf->buf == NULL))
1100 if (nChars >= Buf->BufUsed) {
1104 Buf->BufUsed -= nChars;
1105 Buf->buf[Buf->BufUsed] = '\0';
1110 * @brief Cut the string after n Chars
1111 * @param Buf Buffer to modify
1112 * @param AfternChars after how many chars should we trunkate the string?
1113 * @param At if non-null and points inside of our string, cut it there.
1115 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At)
1117 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1119 AfternChars = At - Buf->buf;
1122 if ((AfternChars < 0) || (AfternChars >= Buf->BufUsed))
1124 Buf->BufUsed = AfternChars;
1125 Buf->buf[Buf->BufUsed] = '\0';
1131 * @brief Strip leading and trailing spaces from a string; with premeasured and adjusted length.
1132 * @param Buf the string to modify
1134 void StrBufTrim(StrBuf *Buf)
1137 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1139 while ((Buf->BufUsed > 0) &&
1140 isspace(Buf->buf[Buf->BufUsed - 1]))
1144 Buf->buf[Buf->BufUsed] = '\0';
1146 if (Buf->BufUsed == 0) return;
1148 while ((Buf->BufUsed > delta) && (isspace(Buf->buf[delta]))){
1151 if (delta > 0) StrBufCutLeft(Buf, delta);
1155 * @brief changes all spaces in the string (tab, linefeed...) to Blank (0x20)
1156 * @param Buf the string to modify
1158 void StrBufSpaceToBlank(StrBuf *Buf)
1162 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1165 pche = pch + Buf->BufUsed;
1174 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary)
1179 if ((Buf == NULL) || (Buf->buf == NULL)) {
1183 pRight = strchr(Buf->buf, rightboundary);
1184 if (pRight != NULL) {
1185 StrBufCutAt(Buf, 0, pRight);
1188 pLeft = strrchr(ChrPtr(Buf), leftboundary);
1189 if (pLeft != NULL) {
1190 StrBufCutLeft(Buf, pLeft - Buf->buf + 1);
1196 * @ingroup StrBuf_Filler
1197 * @brief uppercase the contents of a buffer
1198 * @param Buf the buffer to translate
1200 void StrBufUpCase(StrBuf *Buf)
1204 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1207 pche = pch + Buf->BufUsed;
1208 while (pch < pche) {
1209 *pch = toupper(*pch);
1216 * @ingroup StrBuf_Filler
1217 * @brief lowercase the contents of a buffer
1218 * @param Buf the buffer to translate
1220 void StrBufLowerCase(StrBuf *Buf)
1224 if ((Buf == NULL) || (Buf->BufUsed == 0)) return;
1227 pche = pch + Buf->BufUsed;
1228 while (pch < pche) {
1229 *pch = tolower(*pch);
1235 /*******************************************************************************
1236 * a tokenizer that kills, maims, and destroys *
1237 *******************************************************************************/
1240 * @ingroup StrBuf_Tokenizer
1241 * @brief Replace a token at a given place with a given length by another token with given length
1242 * @param Buf String where to work on
1243 * @param where where inside of the Buf is the search-token
1244 * @param HowLong How long is the token to be replaced
1245 * @param Repl Token to insert at 'where'
1246 * @param ReplLen Length of repl
1247 * @returns -1 if fail else length of resulting Buf
1249 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong,
1250 const char *Repl, long ReplLen)
1253 if ((Buf == NULL) ||
1254 (where > Buf->BufUsed) ||
1255 (where + HowLong > Buf->BufUsed))
1258 if (where + ReplLen - HowLong > Buf->BufSize)
1259 if (IncreaseBuf(Buf, 1, Buf->BufUsed + ReplLen) < 0)
1262 memmove(Buf->buf + where + ReplLen,
1263 Buf->buf + where + HowLong,
1264 Buf->BufUsed - where - HowLong);
1266 memcpy(Buf->buf + where,
1269 Buf->BufUsed += ReplLen - HowLong;
1271 return Buf->BufUsed;
1275 * @ingroup StrBuf_Tokenizer
1276 * @brief Counts the numbmer of tokens in a buffer
1277 * @param source String to count tokens in
1278 * @param tok Tokenizer char to count
1279 * @returns numbers of tokenizer chars found
1281 int StrBufNum_tokens(const StrBuf *source, char tok)
1285 if ((source == NULL) || (source->BufUsed == 0))
1287 if ((source->BufUsed == 1) && (*source->buf == tok))
1291 pche = pch + source->BufUsed;
1302 * @ingroup StrBuf_Tokenizer
1303 * @brief a string tokenizer
1304 * @param Source StringBuffer to read into
1305 * @param parmnum n'th Parameter to remove
1306 * @param separator tokenizer character
1307 * @returns -1 if not found, else length of token.
1309 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator)
1312 char *d, *s, *end; /* dest, source */
1315 /* Find desired @parameter */
1316 end = Source->buf + Source->BufUsed;
1318 while ((d <= end) &&
1321 /* End of string, bail! */
1326 if (*d == separator) {
1331 if ((d == NULL) || (d >= end))
1332 return 0; /* @Parameter not found */
1334 /* Find next @parameter */
1336 while ((s <= end) &&
1337 (*s && *s != separator))
1341 if (*s == separator)
1345 /* Hack and slash */
1350 memmove(d, s, Source->BufUsed - (s - Source->buf));
1351 Source->BufUsed += ReducedBy;
1352 Source->buf[Source->BufUsed] = '\0';
1354 else if (d == Source->buf) {
1356 Source->BufUsed = 0;
1360 Source->BufUsed += ReducedBy;
1371 int StrBufExtract_tokenFromStr(StrBuf *dest, const char *Source, long SourceLen, int parmnum, char separator)
1373 const StrBuf Temp = {
1386 return StrBufExtract_token(dest, &Temp, parmnum, separator);
1390 * @ingroup StrBuf_Tokenizer
1391 * @brief a string tokenizer
1392 * @param dest Destination StringBuffer
1393 * @param Source StringBuffer to read into
1394 * @param parmnum n'th Parameter to extract
1395 * @param separator tokenizer character
1396 * @returns -1 if not found, else length of token.
1398 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator)
1400 const char *s, *e; //* source * /
1401 int len = 0; //* running total length of extracted string * /
1402 int current_token = 0; //* token currently being processed * /
1405 dest->buf[0] = '\0';
1411 if ((Source == NULL) || (Source->BufUsed ==0)) {
1415 e = s + Source->BufUsed;
1418 //lprintf (CTDL_DEBUG, "test >: n: %d sep: %c source: %s \n willi \n", parmnum, separator, source);
1420 while ((s < e) && !IsEmptyStr(s)) {
1421 if (*s == separator) {
1424 if (len >= dest->BufSize) {
1425 dest->BufUsed = len;
1426 if (IncreaseBuf(dest, 1, -1) < 0) {
1431 if ( (current_token == parmnum) &&
1432 (*s != separator)) {
1433 dest->buf[len] = *s;
1436 else if (current_token > parmnum) {
1442 dest->buf[len] = '\0';
1443 dest->BufUsed = len;
1445 if (current_token < parmnum) {
1446 //lprintf (CTDL_DEBUG,"test <!: %s\n", dest);
1449 //lprintf (CTDL_DEBUG,"test <: %d; %s\n", len, dest);
1458 * @ingroup StrBuf_Tokenizer
1459 * @brief a string tokenizer to fetch an integer
1460 * @param Source String containing tokens
1461 * @param parmnum n'th Parameter to extract
1462 * @param separator tokenizer character
1463 * @returns 0 if not found, else integer representation of the token
1465 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator)
1475 if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0)
1482 * @ingroup StrBuf_Tokenizer
1483 * @brief a string tokenizer to fetch a long integer
1484 * @param Source String containing tokens
1485 * @param parmnum n'th Parameter to extract
1486 * @param separator tokenizer character
1487 * @returns 0 if not found, else long integer representation of the token
1489 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator)
1499 if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0)
1507 * @ingroup StrBuf_Tokenizer
1508 * @brief a string tokenizer to fetch an unsigned long
1509 * @param Source String containing tokens
1510 * @param parmnum n'th Parameter to extract
1511 * @param separator tokenizer character
1512 * @returns 0 if not found, else unsigned long representation of the token
1514 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator)
1525 if (StrBufExtract_token(&tmp, Source, parmnum, separator) > 0) {
1529 return (unsigned long) atol(pnum);
1538 * @ingroup StrBuf_NextTokenizer
1539 * @brief a string tokenizer; Bounds checker
1540 * function to make shure whether StrBufExtract_NextToken and friends have reached the end of the string.
1541 * @param Source our tokenbuffer
1542 * @param pStart the token iterator pointer to inspect
1543 * @returns whether the revolving pointer is inside of the search range
1545 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart)
1547 if ((Source == NULL) ||
1548 (*pStart == StrBufNOTNULL) ||
1549 (Source->BufUsed == 0))
1553 if (*pStart == NULL)
1557 else if (*pStart > Source->buf + Source->BufUsed)
1561 else if (*pStart <= Source->buf)
1570 * @ingroup StrBuf_NextTokenizer
1571 * @brief a string tokenizer
1572 * @param dest Destination StringBuffer
1573 * @param Source StringBuffer to read into
1574 * @param pStart pointer to the end of the last token. Feed with NULL on start.
1575 * @param separator tokenizer
1576 * @returns -1 if not found, else length of token.
1578 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator)
1580 const char *s; /* source */
1581 const char *EndBuffer; /* end stop of source buffer */
1582 int current_token = 0; /* token currently being processed */
1583 int len = 0; /* running total length of extracted string */
1585 if ((Source == NULL) ||
1586 (Source->BufUsed == 0) )
1588 *pStart = StrBufNOTNULL;
1594 EndBuffer = Source->buf + Source->BufUsed;
1598 dest->buf[0] = '\0';
1603 *pStart = EndBuffer + 1;
1607 if (*pStart == NULL)
1609 *pStart = Source->buf; /* we're starting to examine this buffer. */
1611 else if ((*pStart < Source->buf) ||
1612 (*pStart > EndBuffer ) )
1614 return -1; /* no more tokens to find. */
1618 /* start to find the next token */
1619 while ((s <= EndBuffer) &&
1620 (current_token == 0) )
1622 if (*s == separator)
1624 /* we found the next token */
1628 if (len >= dest->BufSize)
1630 /* our Dest-buffer isn't big enough, increase it. */
1631 dest->BufUsed = len;
1633 if (IncreaseBuf(dest, 1, -1) < 0) {
1634 /* WHUT? no more mem? bail out. */
1641 if ( (current_token == 0 ) && /* are we in our target token? */
1642 (!IsEmptyStr(s) ) &&
1643 (separator != *s) ) /* don't copy the token itself */
1645 dest->buf[len] = *s; /* Copy the payload */
1646 ++len; /* remember the bigger size. */
1652 /* did we reach the end? */
1653 if ((s > EndBuffer)) {
1654 EndBuffer = StrBufNOTNULL;
1655 *pStart = EndBuffer;
1658 *pStart = s; /* remember the position for the next run */
1661 /* sanitize our extracted token */
1662 dest->buf[len] = '\0';
1663 dest->BufUsed = len;
1670 * @ingroup StrBuf_NextTokenizer
1671 * @brief a string tokenizer
1672 * @param Source StringBuffer to read from
1673 * @param pStart pointer to the end of the last token. Feed with NULL.
1674 * @param separator tokenizer character
1675 * @param nTokens number of tokens to fastforward over
1676 * @returns -1 if not found, else length of token.
1678 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens)
1680 const char *s, *EndBuffer; //* source * /
1681 int len = 0; //* running total length of extracted string * /
1682 int current_token = 0; //* token currently being processed * /
1684 if ((Source == NULL) ||
1685 (Source->BufUsed ==0)) {
1689 return Source->BufUsed;
1691 if (*pStart == NULL)
1692 *pStart = Source->buf;
1694 EndBuffer = Source->buf + Source->BufUsed;
1696 if ((*pStart < Source->buf) ||
1697 (*pStart > EndBuffer)) {
1705 //lprintf (CTDL_DEBUG, "test >: n: %d sep: %c source: %s \n willi \n", parmnum, separator, source);
1707 while ((s < EndBuffer) && !IsEmptyStr(s)) {
1708 if (*s == separator) {
1711 if (current_token >= nTokens) {
1723 * @ingroup StrBuf_NextTokenizer
1724 * @brief a string tokenizer to fetch an integer
1725 * @param Source StringBuffer to read from
1726 * @param pStart Cursor on the tokenstring
1727 * @param separator tokenizer character
1728 * @returns 0 if not found, else integer representation of the token
1730 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator)
1740 if (StrBufExtract_NextToken(&tmp, Source, pStart, separator) > 0)
1747 * @ingroup StrBuf_NextTokenizer
1748 * @brief a string tokenizer to fetch a long integer
1749 * @param Source StringBuffer to read from
1750 * @param pStart Cursor on the tokenstring
1751 * @param separator tokenizer character
1752 * @returns 0 if not found, else long integer representation of the token
1754 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator)
1764 if (StrBufExtract_NextToken(&tmp, Source, pStart, separator) > 0)
1772 * @ingroup StrBuf_NextTokenizer
1773 * @brief a string tokenizer to fetch an unsigned long
1774 * @param Source StringBuffer to read from
1775 * @param pStart Cursor on the tokenstring
1776 * @param separator tokenizer character
1777 * @returns 0 if not found, else unsigned long representation of the token
1779 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator)
1790 if (StrBufExtract_NextToken(&tmp, Source, pStart, separator) > 0) {
1794 return (unsigned long) atol(pnum);
1804 /*******************************************************************************
1805 * Escape Appending *
1806 *******************************************************************************/
1809 * @ingroup StrBuf_DeEnCoder
1810 * @brief Escape a string for feeding out as a URL while appending it to a Buffer
1811 * @param OutBuf the output buffer
1812 * @param In Buffer to encode
1813 * @param PlainIn way in from plain old c strings
1815 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn)
1817 const char *pch, *pche;
1821 if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
1823 if (PlainIn != NULL) {
1824 len = strlen(PlainIn);
1830 pche = pch + In->BufUsed;
1837 pt = OutBuf->buf + OutBuf->BufUsed;
1838 pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
1840 while (pch < pche) {
1842 IncreaseBuf(OutBuf, 1, -1);
1843 pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
1844 pt = OutBuf->buf + OutBuf->BufUsed;
1847 if((*pch >= 'a' && *pch <= 'z') ||
1848 (*pch >= '@' && *pch <= 'Z') || /* @ A-Z */
1849 (*pch >= '0' && *pch <= ':') || /* 0-9 : */
1850 (*pch == '!') || (*pch == '_') ||
1851 (*pch == ',') || (*pch == '.'))
1858 *(pt + 1) = HexList[(unsigned char)*pch][0];
1859 *(pt + 2) = HexList[(unsigned char)*pch][1];
1861 OutBuf->BufUsed += 3;
1869 * @ingroup StrBuf_DeEnCoder
1870 * @brief Escape a string for feeding out as a the username/password part of an URL while appending it to a Buffer
1871 * @param OutBuf the output buffer
1872 * @param In Buffer to encode
1873 * @param PlainIn way in from plain old c strings
1875 void StrBufUrlescUPAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn)
1877 const char *pch, *pche;
1881 if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
1883 if (PlainIn != NULL) {
1884 len = strlen(PlainIn);
1890 pche = pch + In->BufUsed;
1897 pt = OutBuf->buf + OutBuf->BufUsed;
1898 pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
1900 while (pch < pche) {
1902 IncreaseBuf(OutBuf, 1, -1);
1903 pte = OutBuf->buf + OutBuf->BufSize - 4; /**< we max append 3 chars at once plus the \0 */
1904 pt = OutBuf->buf + OutBuf->BufUsed;
1907 if((*pch >= 'a' && *pch <= 'z') ||
1908 (*pch >= 'A' && *pch <= 'Z') || /* A-Z */
1909 (*pch >= '0' && *pch <= ':') || /* 0-9 : */
1910 (*pch == '!') || (*pch == '_') ||
1911 (*pch == ',') || (*pch == '.'))
1918 *(pt + 1) = HexList[(unsigned char)*pch][0];
1919 *(pt + 2) = HexList[(unsigned char)*pch][1];
1921 OutBuf->BufUsed += 3;
1929 * @ingroup StrBuf_DeEnCoder
1930 * @brief append a string with characters having a special meaning in xml encoded to the buffer
1931 * @param OutBuf the output buffer
1932 * @param In Buffer to encode
1933 * @param PlainIn way in from plain old c strings
1934 * @param PlainInLen way in from plain old c strings; maybe you've got binary data or know the length?
1935 * @param OverrideLowChars should chars < 0x20 be replaced by _ or escaped as xml entity?
1937 void StrBufXMLEscAppend(StrBuf *OutBuf,
1939 const char *PlainIn,
1941 int OverrideLowChars)
1943 const char *pch, *pche;
1948 if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
1950 if (PlainIn != NULL) {
1952 len = strlen((const char*)PlainIn);
1959 pch = (const char*)In->buf;
1960 pche = pch + In->BufUsed;
1967 pt = OutBuf->buf + OutBuf->BufUsed;
1968 /**< we max append 6 chars at once plus the \0 */
1969 pte = OutBuf->buf + OutBuf->BufSize - 6;
1971 while (pch < pche) {
1973 OutBuf->BufUsed = pt - OutBuf->buf;
1974 IncreaseBuf(OutBuf, 1, -1);
1975 pte = OutBuf->buf + OutBuf->BufSize - 6;
1976 /**< we max append 3 chars at once plus the \0 */
1978 pt = OutBuf->buf + OutBuf->BufUsed;
1982 memcpy(pt, HKEY("<"));
1986 else if (*pch == '>') {
1987 memcpy(pt, HKEY(">"));
1991 else if (*pch == '&') {
1992 memcpy(pt, HKEY("&"));
1996 else if ((*pch >= 0x20) && (*pch <= 0x7F)) {
2000 else if (*pch < 0x20) {
2001 /* we probably shouldn't be doing this */
2002 if (OverrideLowChars)
2012 *pt = HexList[*(unsigned char*)pch][0];
2014 *pt = HexList[*(unsigned char*)pch][1];
2022 IsUtf8Sequence = Ctdl_GetUtf8SequenceLength(pch, pche);
2025 while (IsUtf8Sequence > 0){
2036 *pt = HexList[*(unsigned char*)pch][0];
2038 *pt = HexList[*(unsigned char*)pch][1];
2047 OutBuf->BufUsed = pt - OutBuf->buf;
2052 * @ingroup StrBuf_DeEnCoder
2053 * @brief append a string in hex encoding to the buffer
2054 * @param OutBuf the output buffer
2055 * @param In Buffer to encode
2056 * @param PlainIn way in from plain old c strings
2057 * @param PlainInLen way in from plain old c strings; maybe you've got binary data or know the length?
2059 void StrBufHexEscAppend(StrBuf *OutBuf, const StrBuf *In, const unsigned char *PlainIn, long PlainInLen)
2061 const unsigned char *pch, *pche;
2065 if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
2067 if (PlainIn != NULL) {
2069 len = strlen((const char*)PlainIn);
2076 pch = (const unsigned char*)In->buf;
2077 pche = pch + In->BufUsed;
2084 pt = OutBuf->buf + OutBuf->BufUsed;
2085 pte = OutBuf->buf + OutBuf->BufSize - 3; /**< we max append 3 chars at once plus the \0 */
2087 while (pch < pche) {
2089 IncreaseBuf(OutBuf, 1, -1);
2090 pte = OutBuf->buf + OutBuf->BufSize - 3; /**< we max append 3 chars at once plus the \0 */
2091 pt = OutBuf->buf + OutBuf->BufUsed;
2094 *pt = HexList[*pch][0];
2096 *pt = HexList[*pch][1];
2097 pt ++; pch ++; OutBuf->BufUsed += 2;
2102 void StrBufBase64Append(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn, long PlainInLen, int linebreaks)
2109 if (((In == NULL) && (PlainIn == NULL)) || (OutBuf == NULL) )
2111 if (PlainIn != NULL) {
2113 len = strlen(PlainIn);
2126 ExpectLen = ((len * 134) / 100) + OutBuf->BufUsed;
2128 if (ExpectLen > OutBuf->BufSize)
2129 if (IncreaseBuf(OutBuf, 1, ExpectLen) < ExpectLen)
2132 pt = OutBuf->buf + OutBuf->BufUsed;
2134 len = CtdlEncodeBase64(pt, pch, len, linebreaks);
2137 OutBuf->BufUsed += len;
2142 * @ingroup StrBuf_DeEnCoder
2143 * @brief append a string in hex encoding to the buffer
2144 * @param OutBuf the output buffer
2145 * @param In Buffer to encode
2146 * @param PlainIn way in from plain old c strings
2148 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn)
2150 StrBufHexEscAppend(OutBuf, In, (const unsigned char*) PlainIn, -1);
2154 * @ingroup StrBuf_DeEnCoder
2155 * @brief Append a string, escaping characters which have meaning in HTML.
2157 * @param Target target buffer
2158 * @param Source source buffer; set to NULL if you just have a C-String
2159 * @param PlainIn Plain-C string to append; set to NULL if unused
2160 * @param nbsp If nonzero, spaces are converted to non-breaking spaces.
2161 * @param nolinebreaks if set to 1, linebreaks are removed from the string.
2162 * if set to 2, linebreaks are replaced by <br/>
2164 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks)
2166 const char *aptr, *eiptr;
2170 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2173 if (PlainIn != NULL) {
2175 len = strlen(PlainIn);
2180 eiptr = aptr + Source->BufUsed;
2181 len = Source->BufUsed;
2187 bptr = Target->buf + Target->BufUsed;
2188 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
2190 while (aptr < eiptr){
2192 IncreaseBuf(Target, 1, -1);
2193 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
2194 bptr = Target->buf + Target->BufUsed;
2197 memcpy(bptr, "<", 4);
2199 Target->BufUsed += 4;
2201 else if (*aptr == '>') {
2202 memcpy(bptr, ">", 4);
2204 Target->BufUsed += 4;
2206 else if (*aptr == '&') {
2207 memcpy(bptr, "&", 5);
2209 Target->BufUsed += 5;
2211 else if (*aptr == '"') {
2212 memcpy(bptr, """, 6);
2214 Target->BufUsed += 6;
2216 else if (*aptr == '\'') {
2217 memcpy(bptr, "'", 5);
2219 Target->BufUsed += 5;
2221 else if (*aptr == LB) {
2226 else if (*aptr == RB) {
2231 else if (*aptr == QU) {
2236 else if ((*aptr == 32) && (nbsp == 1)) {
2237 memcpy(bptr, " ", 6);
2239 Target->BufUsed += 6;
2241 else if ((*aptr == '\n') && (nolinebreaks == 1)) {
2242 *bptr='\0'; /* nothing */
2244 else if ((*aptr == '\n') && (nolinebreaks == 2)) {
2245 memcpy(bptr, "<br/>", 11);
2247 Target->BufUsed += 11;
2251 else if ((*aptr == '\r') && (nolinebreaks != 0)) {
2252 *bptr='\0'; /* nothing */
2262 if ((bptr = eptr - 1 ) && !IsEmptyStr(aptr) )
2264 return Target->BufUsed;
2268 * @ingroup StrBuf_DeEnCoder
2269 * @brief Append a string, escaping characters which have meaning in HTML.
2270 * Converts linebreaks into blanks; escapes single quotes
2271 * @param Target target buffer
2272 * @param Source source buffer; set to NULL if you just have a C-String
2273 * @param PlainIn Plain-C string to append; set to NULL if unused
2275 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn)
2277 const char *aptr, *eiptr;
2281 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2284 if (PlainIn != NULL) {
2286 len = strlen(PlainIn);
2291 eiptr = aptr + Source->BufUsed;
2292 len = Source->BufUsed;
2298 eptr = Target->buf + Target->BufSize - 8;
2299 tptr = Target->buf + Target->BufUsed;
2301 while (aptr < eiptr){
2303 IncreaseBuf(Target, 1, -1);
2304 eptr = Target->buf + Target->BufSize - 8;
2305 tptr = Target->buf + Target->BufUsed;
2308 if (*aptr == '\n') {
2312 else if (*aptr == '\r') {
2316 else if (*aptr == '\'') {
2322 Target->BufUsed += 5;
2335 * @ingroup StrBuf_DeEnCoder
2336 * @brief Append a string, escaping characters which have meaning in ICAL.
2338 * @param Target target buffer
2339 * @param Source source buffer; set to NULL if you just have a C-String
2340 * @param PlainIn Plain-C string to append; set to NULL if unused
2342 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn)
2344 const char *aptr, *eiptr;
2348 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2351 if (PlainIn != NULL) {
2353 len = strlen(PlainIn);
2358 eiptr = aptr + Source->BufUsed;
2359 len = Source->BufUsed;
2365 eptr = Target->buf + Target->BufSize - 8;
2366 tptr = Target->buf + Target->BufUsed;
2368 while (aptr < eiptr){
2369 if(tptr + 3 >= eptr) {
2370 IncreaseBuf(Target, 1, -1);
2371 eptr = Target->buf + Target->BufSize - 8;
2372 tptr = Target->buf + Target->BufUsed;
2375 if (*aptr == '\n') {
2382 else if (*aptr == '\r') {
2389 else if (*aptr == ',') {
2405 * @ingroup StrBuf_DeEnCoder
2406 * @brief Append a string, escaping characters which have meaning in JavaScript strings .
2408 * @param Target target buffer
2409 * @param Source source buffer; set to NULL if you just have a C-String
2410 * @param PlainIn Plain-C string to append; set to NULL if unused
2411 * @returns size of result or -1
2413 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn)
2415 const char *aptr, *eiptr;
2420 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2423 if (PlainIn != NULL) {
2425 len = strlen(PlainIn);
2430 eiptr = aptr + Source->BufUsed;
2431 len = Source->BufUsed;
2437 bptr = Target->buf + Target->BufUsed;
2438 eptr = Target->buf + Target->BufSize - 7; /* our biggest unit to put in... */
2440 while (aptr < eiptr){
2442 IncreaseBuf(Target, 1, -1);
2443 eptr = Target->buf + Target->BufSize - 7; /* our biggest unit to put in... */
2444 bptr = Target->buf + Target->BufUsed;
2448 memcpy(bptr, HKEY("\\n"));
2450 Target->BufUsed += 2;
2453 memcpy(bptr, HKEY("\\r"));
2455 Target->BufUsed += 2;
2462 Target->BufUsed += 2;
2465 if ((*(aptr + 1) == 'u') &&
2466 isxdigit(*(aptr + 2)) &&
2467 isxdigit(*(aptr + 3)) &&
2468 isxdigit(*(aptr + 4)) &&
2469 isxdigit(*(aptr + 5)))
2470 { /* oh, a unicode escaper. let it pass through. */
2471 memcpy(bptr, aptr, 6);
2474 Target->BufUsed += 6;
2482 Target->BufUsed += 2;
2490 Target->BufUsed += 2;
2497 Target->BufUsed += 2;
2504 Target->BufUsed += 2;
2507 IsUtf8Sequence = Ctdl_GetUtf8SequenceLength(aptr, eiptr);
2508 while (IsUtf8Sequence > 0){
2511 if (--IsUtf8Sequence)
2519 if ((bptr == eptr - 1 ) && !IsEmptyStr(aptr) )
2521 return Target->BufUsed;
2525 * @ingroup StrBuf_DeEnCoder
2526 * @brief Append a string, escaping characters which have meaning in HTML + json.
2528 * @param Target target buffer
2529 * @param Source source buffer; set to NULL if you just have a C-String
2530 * @param PlainIn Plain-C string to append; set to NULL if unused
2531 * @param nbsp If nonzero, spaces are converted to non-breaking spaces.
2532 * @param nolinebreaks if set to 1, linebreaks are removed from the string.
2533 * if set to 2, linebreaks are replaced by <br/>
2535 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks)
2537 const char *aptr, *eiptr;
2540 int IsUtf8Sequence = 0;
2542 if (((Source == NULL) && (PlainIn == NULL)) || (Target == NULL) )
2545 if (PlainIn != NULL) {
2547 len = strlen(PlainIn);
2552 eiptr = aptr + Source->BufUsed;
2553 len = Source->BufUsed;
2559 bptr = Target->buf + Target->BufUsed;
2560 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
2562 while (aptr < eiptr){
2564 IncreaseBuf(Target, 1, -1);
2565 eptr = Target->buf + Target->BufSize - 11; /* our biggest unit to put in... */
2566 bptr = Target->buf + Target->BufUsed;
2570 memcpy(bptr, HKEY("<"));
2572 Target->BufUsed += 4;
2575 memcpy(bptr, HKEY(">"));
2577 Target->BufUsed += 4;
2580 memcpy(bptr, HKEY("&"));
2582 Target->BufUsed += 5;
2595 switch (nolinebreaks) {
2597 *bptr='\0'; /* nothing */
2600 memcpy(bptr, HKEY("<br/>"));
2602 Target->BufUsed += 11;
2605 memcpy(bptr, HKEY("\\n"));
2607 Target->BufUsed += 2;
2611 switch (nolinebreaks) {
2614 *bptr='\0'; /* nothing */
2617 memcpy(bptr, HKEY("\\r"));
2619 Target->BufUsed += 2;
2629 Target->BufUsed += 2;
2632 if ((*(aptr + 1) == 'u') &&
2633 isxdigit(*(aptr + 2)) &&
2634 isxdigit(*(aptr + 3)) &&
2635 isxdigit(*(aptr + 4)) &&
2636 isxdigit(*(aptr + 5)))
2637 { /* oh, a unicode escaper. let it pass through. */
2638 memcpy(bptr, aptr, 6);
2641 Target->BufUsed += 6;
2649 Target->BufUsed += 2;
2657 Target->BufUsed += 2;
2664 Target->BufUsed += 2;
2671 Target->BufUsed += 2;
2675 memcpy(bptr, HKEY(" "));
2677 Target->BufUsed += 6;
2681 IsUtf8Sequence = Ctdl_GetUtf8SequenceLength(aptr, eiptr);
2682 while (IsUtf8Sequence > 0){
2685 if (--IsUtf8Sequence)
2693 if ((bptr = eptr - 1 ) && !IsEmptyStr(aptr) )
2695 return Target->BufUsed;
2700 * @ingroup StrBuf_DeEnCoder
2701 * @brief replace all non-Ascii characters by another
2702 * @param Buf buffer to inspect
2703 * @param repl charater to stamp over non ascii chars
2705 void StrBufAsciify(StrBuf *Buf, const char repl)
2709 for (offset = 0; offset < Buf->BufUsed; offset ++)
2710 if (!isascii(Buf->buf[offset]))
2711 Buf->buf[offset] = repl;
2716 * @ingroup StrBuf_DeEnCoder
2717 * @brief unhide special chars hidden to the HTML escaper
2718 * @param target buffer to put the unescaped string in
2719 * @param source buffer to unescape
2721 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source)
2726 if ((source == NULL) || (target == NULL) || (target->buf == NULL))
2732 FlushStrBuf(target);
2734 len = source->BufUsed;
2735 for (a = 0; a < len; ++a) {
2736 if (target->BufUsed >= target->BufSize)
2737 IncreaseBuf(target, 1, -1);
2739 if (source->buf[a] == '=') {
2740 hex[0] = source->buf[a + 1];
2741 hex[1] = source->buf[a + 2];
2744 sscanf(hex, "%02x", &b);
2745 target->buf[target->BufUsed] = b;
2746 target->buf[++target->BufUsed] = 0;
2750 target->buf[target->BufUsed] = source->buf[a];
2751 target->buf[++target->BufUsed] = 0;
2758 * @ingroup StrBuf_DeEnCoder
2759 * @brief hide special chars from the HTML escapers and friends
2760 * @param target buffer to put the escaped string in
2761 * @param source buffer to escape
2763 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source)
2768 FlushStrBuf(target);
2770 if ((source == NULL) || (target == NULL) || (target->buf == NULL))
2775 len = source->BufUsed;
2776 for (i=0; i<len; ++i) {
2777 if (target->BufUsed + 4 >= target->BufSize)
2778 IncreaseBuf(target, 1, -1);
2779 if ( (isalnum(source->buf[i])) ||
2780 (source->buf[i]=='-') ||
2781 (source->buf[i]=='_') ) {
2782 target->buf[target->BufUsed++] = source->buf[i];
2785 sprintf(&target->buf[target->BufUsed],
2787 (0xFF &source->buf[i]));
2788 target->BufUsed += 3;
2791 target->buf[target->BufUsed + 1] = '\0';
2795 /*******************************************************************************
2796 * Quoted Printable de/encoding *
2797 *******************************************************************************/
2800 * @ingroup StrBuf_DeEnCoder
2801 * @brief decode a buffer from base 64 encoding; destroys original
2802 * @param Buf Buffor to transform
2804 int StrBufDecodeBase64(StrBuf *Buf)
2812 xferbuf = (char*) malloc(Buf->BufSize);
2813 if (xferbuf == NULL)
2817 siz = CtdlDecodeBase64(xferbuf,
2827 * @ingroup StrBuf_DeEnCoder
2828 * @brief decode a buffer from base 64 encoding; destroys original
2829 * @param Buf Buffor to transform
2831 int StrBufDecodeHex(StrBuf *Buf)
2834 char *pch, *pche, *pchi;
2836 if (Buf == NULL) return -1;
2838 pch = pchi = Buf->buf;
2839 pche = pch + Buf->BufUsed;
2841 while (pchi < pche){
2842 ch = decode_hex(pchi);
2849 Buf->BufUsed = pch - Buf->buf;
2850 return Buf->BufUsed;
2854 * @ingroup StrBuf_DeEnCoder
2855 * @brief replace all chars >0x20 && < 0x7F with Mute
2856 * @param Mute char to put over invalid chars
2857 * @param Buf Buffor to transform
2859 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute)
2863 if (Buf == NULL) return -1;
2864 pch = (unsigned char *)Buf->buf;
2865 while (pch < (unsigned char *)Buf->buf + Buf->BufUsed) {
2866 if ((*pch < 0x20) || (*pch > 0x7F))
2870 return Buf->BufUsed;
2875 * @ingroup StrBuf_DeEnCoder
2876 * @brief remove escaped strings from i.e. the url string (like %20 for blanks)
2877 * @param Buf Buffer to translate
2878 * @param StripBlanks Reduce several blanks to one?
2880 long StrBufUnescape(StrBuf *Buf, int StripBlanks)
2889 while ((Buf->BufUsed > 0) && (isspace(Buf->buf[Buf->BufUsed - 1]))){
2890 Buf->buf[Buf->BufUsed - 1] = '\0';
2895 while (a < Buf->BufUsed) {
2896 if (Buf->buf[a] == '+')
2898 else if (Buf->buf[a] == '%') {
2899 /* don't let % chars through, rather truncate the input. */
2900 if (a + 2 > Buf->BufUsed) {
2905 hex[0] = Buf->buf[a + 1];
2906 hex[1] = Buf->buf[a + 2];
2909 sscanf(hex, "%02x", &b);
2910 Buf->buf[a] = (char) b;
2911 len = Buf->BufUsed - a - 2;
2913 memmove(&Buf->buf[a + 1], &Buf->buf[a + 3], len);
2925 * @ingroup StrBuf_DeEnCoder
2926 * @brief RFC2047-encode a header field if necessary.
2927 * If no non-ASCII characters are found, the string
2928 * will be copied verbatim without encoding.
2930 * @param target Target buffer.
2931 * @param source Source string to be encoded.
2932 * @returns encoded length; -1 if non success.
2934 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source)
2936 const char headerStr[] = "=?UTF-8?Q?";
2937 int need_to_encode = 0;
2941 if ((source == NULL) ||
2945 while ((i < source->BufUsed) &&
2946 (!IsEmptyStr (&source->buf[i])) &&
2947 (need_to_encode == 0)) {
2948 if (((unsigned char) source->buf[i] < 32) ||
2949 ((unsigned char) source->buf[i] > 126)) {
2955 if (!need_to_encode) {
2956 if (*target == NULL) {
2957 *target = NewStrBufPlain(source->buf, source->BufUsed);
2960 FlushStrBuf(*target);
2961 StrBufAppendBuf(*target, source, 0);
2964 return (*target)->BufUsed;
2968 if (*target == NULL)
2969 *target = NewStrBufPlain(NULL, sizeof(headerStr) + source->BufUsed * 2);
2970 else if (sizeof(headerStr) + source->BufUsed >= (*target)->BufSize)
2971 IncreaseBuf(*target, sizeof(headerStr) + source->BufUsed, 0);
2972 memcpy ((*target)->buf, headerStr, sizeof(headerStr) - 1);
2973 (*target)->BufUsed = sizeof(headerStr) - 1;
2974 for (i=0; (i < source->BufUsed); ++i) {
2975 if ((*target)->BufUsed + 4 >= (*target)->BufSize)
2976 IncreaseBuf(*target, 1, 0);
2977 ch = (unsigned char) source->buf[i];
2986 sprintf(&(*target)->buf[(*target)->BufUsed], "=%02X", ch);
2987 (*target)->BufUsed += 3;
2991 (*target)->buf[(*target)->BufUsed] = '_';
2993 (*target)->buf[(*target)->BufUsed] = ch;
2994 (*target)->BufUsed++;
2998 if ((*target)->BufUsed + 4 >= (*target)->BufSize)
2999 IncreaseBuf(*target, 1, 0);
3001 (*target)->buf[(*target)->BufUsed++] = '?';
3002 (*target)->buf[(*target)->BufUsed++] = '=';
3003 (*target)->buf[(*target)->BufUsed] = '\0';
3004 return (*target)->BufUsed;;
3008 * @ingroup StrBuf_DeEnCoder
3009 * @brief Quoted-Printable encode a message; make it < 80 columns width.
3010 * @param source Source string to be encoded.
3011 * @returns buffer with encoded message.
3013 StrBuf *StrBufRFC2047encodeMessage(const StrBuf *EncodeMe)
3017 const char *ptr, *eptr;
3021 OutBuf = NewStrBufPlain(NULL, StrLength(EncodeMe) * 4);
3023 OEptr = OutBuf->buf + OutBuf->BufSize;
3024 ptr = EncodeMe->buf;
3025 eptr = EncodeMe->buf + EncodeMe->BufUsed;
3030 if (Optr + 4 >= OEptr)
3033 Offset = Optr - OutBuf->buf;
3034 OutBuf->BufUsed = Optr - OutBuf->buf;
3035 IncreaseBuf(OutBuf, 1, 0);
3036 Optr = OutBuf->buf + Offset;
3037 OEptr = OutBuf->buf + OutBuf->BufSize;
3041 /* ignore carriage returns */
3044 else if (*ptr == '\n') {
3045 /* hard line break */
3046 memcpy(Optr, HKEY("=0A"));
3051 else if (( (*ptr >= 32) && (*ptr <= 60) ) ||
3052 ( (*ptr >= 62) && (*ptr <= 126) ))
3063 *Optr = HexList[ch][0];
3065 *Optr = HexList[ch][1];
3072 /* soft line break */
3073 if (isspace(*(Optr - 1))) {
3078 *Optr = HexList[ch][0];
3080 *Optr = HexList[ch][1];
3092 OutBuf->BufUsed = Optr - OutBuf->buf;
3098 static void AddRecipient(StrBuf *Target,
3100 StrBuf *EmailAddress,
3105 if (StrLength(Target) > 0) StrBufAppendBufPlain(Target, HKEY(", "), 0);
3106 if (strchr(ChrPtr(UserName), ',') != NULL) QuoteMe = 1;
3108 if (QuoteMe) StrBufAppendBufPlain(Target, HKEY("\""), 0);
3109 StrBufRFC2047encode(&EncBuf, UserName);
3110 StrBufAppendBuf(Target, EncBuf, 0);
3111 if (QuoteMe) StrBufAppendBufPlain(Target, HKEY("\" "), 0);
3112 else StrBufAppendBufPlain(Target, HKEY(" "), 0);
3114 if (StrLength(EmailAddress) > 0){
3115 StrBufAppendBufPlain(Target, HKEY("<"), 0);
3116 StrBufAppendBuf(Target, EmailAddress, 0); /* TODO: what about IDN???? */
3117 StrBufAppendBufPlain(Target, HKEY(">"), 0);
3123 * \brief QP encode parts of an email TO/CC/BCC vector, and strip/filter invalid parts
3124 * \param Recp Source list of email recipients
3125 * \param UserName Temporary buffer for internal use; Please provide valid buffer.
3126 * \param EmailAddress Temporary buffer for internal use; Please provide valid buffer.
3127 * \param EncBuf Temporary buffer for internal use; Please provide valid buffer.
3128 * \returns encoded & sanitized buffer with the contents of Recp; Caller owns this memory.
3130 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
3132 StrBuf *EmailAddress,
3136 const char *pch, *pche;
3137 const char *UserStart, *UserEnd, *EmailStart, *EmailEnd, *At;
3139 if ((Recp == NULL) || (StrLength(Recp) == 0))
3143 pche = pch + StrLength(Recp);
3145 if (!CheckEncode(pch, -1, pche))
3146 return NewStrBufDup(Recp);
3148 Target = NewStrBufPlain(NULL, StrLength(Recp));
3150 while ((pch != NULL) && (pch < pche))
3152 while (isspace(*pch)) pch++;
3153 UserEnd = EmailStart = EmailEnd = NULL;
3155 if ((*pch == '"') || (*pch == '\'')) {
3156 UserStart = pch + 1;
3158 UserEnd = strchr(UserStart, *pch);
3159 if (UserEnd == NULL)
3160 break; ///TODO: Userfeedback??
3161 EmailStart = UserEnd + 1;
3162 while (isspace(*EmailStart))
3164 if (UserEnd == UserStart) {
3165 UserStart = UserEnd = NULL;
3168 if (*EmailStart == '<') {
3170 EmailEnd = strchr(EmailStart, '>');
3171 if (EmailEnd == NULL)
3172 EmailEnd = strchr(EmailStart, ',');
3176 EmailEnd = strchr(EmailStart, ',');
3178 if (EmailEnd == NULL)
3185 EmailEnd = strchr(UserStart, ',');
3186 if (EmailEnd == NULL) {
3187 EmailEnd = strchr(pch, '>');
3189 if (EmailEnd != NULL) {
3199 while ((EmailEnd > UserStart) && !gt &&
3200 ((*EmailEnd == ',') ||
3201 (*EmailEnd == '>') ||
3202 (isspace(*EmailEnd))))
3204 if (*EmailEnd == '>')
3209 if (EmailEnd == UserStart)
3213 EmailStart = strchr(UserStart, '<');
3214 if ((EmailStart == NULL) || (EmailStart > EmailEnd))
3216 UserEnd = EmailStart;
3218 while ((UserEnd > UserStart) &&
3219 isspace (*(UserEnd - 1)))
3222 if (UserStart >= UserEnd)
3223 UserStart = UserEnd = NULL;
3225 else { /* this is a local recipient... no domain, just a realname */
3226 EmailStart = UserStart;
3227 At = strchr(EmailStart, '@');
3233 EmailStart = UserStart;
3239 if ((UserStart != NULL) && (UserEnd != NULL))
3240 StrBufPlain(UserName, UserStart, UserEnd - UserStart);
3241 else if ((UserStart != NULL) && (UserEnd == NULL))
3242 StrBufPlain(UserName, UserStart, UserEnd - UserStart);
3244 FlushStrBuf(UserName);
3246 if ((EmailStart != NULL) && (EmailEnd != NULL))
3247 StrBufPlain(EmailAddress, EmailStart, EmailEnd - EmailStart);
3248 else if ((EmailStart != NULL) && (EmailEnd == NULL))
3249 StrBufPlain(EmailAddress, EmailStart, EmailEnd - pche);
3251 FlushStrBuf(EmailAddress);
3253 AddRecipient(Target, UserName, EmailAddress, EncBuf);
3258 if ((pch != NULL) && (*pch == ','))
3260 if (pch != NULL) while (isspace(*pch))
3269 * @brief replaces all occurances of 'search' by 'replace'
3270 * @param buf Buffer to modify
3271 * @param search character to search
3272 * @param replace character to replace search by
3274 void StrBufReplaceChars(StrBuf *buf, char search, char replace)
3279 for (i=0; i<buf->BufUsed; i++)
3280 if (buf->buf[i] == search)
3281 buf->buf[i] = replace;
3287 * @brief removes all \\r s from the string, or replaces them with \n if its not a combination of both.
3288 * @param buf Buffer to modify
3290 void StrBufToUnixLF(StrBuf *buf)
3292 char *pche, *pchS, *pchT;
3296 pche = buf->buf + buf->BufUsed;
3297 pchS = pchT = buf->buf;
3303 if (*pchS != '\n') {
3312 buf->BufUsed = pchT - buf->buf;
3316 /*******************************************************************************
3317 * Iconv Wrapper; RFC822 de/encoding *
3318 *******************************************************************************/
3321 * @ingroup StrBuf_DeEnCoder
3322 * @brief Wrapper around iconv_open()
3323 * Our version adds aliases for non-standard Microsoft charsets
3324 * such as 'MS950', aliasing them to names like 'CP950'
3326 * @param tocode Target encoding
3327 * @param fromcode Source encoding
3328 * @param pic anonimized pointer to iconv struct
3330 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic)
3333 iconv_t ic = (iconv_t)(-1) ;
3334 ic = iconv_open(tocode, fromcode);
3335 if (ic == (iconv_t)(-1) ) {
3336 char alias_fromcode[64];
3337 if ( (strlen(fromcode) == 5) && (!strncasecmp(fromcode, "MS", 2)) ) {
3338 safestrncpy(alias_fromcode, fromcode, sizeof alias_fromcode);
3339 alias_fromcode[0] = 'C';
3340 alias_fromcode[1] = 'P';
3341 ic = iconv_open(tocode, alias_fromcode);
3344 *(iconv_t *)pic = ic;
3350 * @ingroup StrBuf_DeEnCoder
3351 * @brief find one chunk of a RFC822 encoded string
3352 * @param Buffer where to search
3353 * @param bptr where to start searching
3354 * @returns found position, NULL if none.
3356 static inline const char *FindNextEnd (const StrBuf *Buf, const char *bptr)
3359 /* Find the next ?Q? */
3360 if (Buf->BufUsed - (bptr - Buf->buf) < 6)
3363 end = strchr(bptr + 2, '?');
3368 if ((Buf->BufUsed - (end - Buf->buf) > 3) &&
3369 (((*(end + 1) == 'B') || (*(end + 1) == 'Q')) ||
3370 ((*(end + 1) == 'b') || (*(end + 1) == 'q'))) &&
3371 (*(end + 2) == '?')) {
3372 /* skip on to the end of the cluster, the next ?= */
3373 end = strstr(end + 3, "?=");
3376 /* sort of half valid encoding, try to find an end. */
3377 end = strstr(bptr, "?=");
3384 * @ingroup StrBuf_DeEnCoder
3385 * @brief convert one buffer according to the preselected iconv pointer PIC
3386 * @param ConvertBuf buffer we need to translate
3387 * @param TmpBuf To share a workbuffer over several iterations. prepare to have it filled with useless stuff afterwards.
3388 * @param pic Pointer to the iconv-session Object
3390 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic)
3396 char *ibuf; /**< Buffer of characters to be converted */
3397 char *obuf; /**< Buffer for converted characters */
3398 size_t ibuflen; /**< Length of input buffer */
3399 size_t obuflen; /**< Length of output buffer */
3402 if ((ConvertBuf == NULL) || (TmpBuf == NULL))
3405 /* since we're converting to utf-8, one glyph may take up to 6 bytes */
3406 if (ConvertBuf->BufUsed * 6 >= TmpBuf->BufSize)
3407 IncreaseBuf(TmpBuf, 0, ConvertBuf->BufUsed * 6);
3409 ic = *(iconv_t*)pic;
3410 ibuf = ConvertBuf->buf;
3411 ibuflen = ConvertBuf->BufUsed;
3413 obuflen = TmpBuf->BufSize;
3415 siz = iconv(ic, &ibuf, &ibuflen, &obuf, &obuflen);
3418 if (errno == E2BIG) {
3420 IncreaseBuf(TmpBuf, 0, 0);
3425 else if (errno == EILSEQ){
3426 /* hm, invalid utf8 sequence... what to do now? */
3427 /* An invalid multibyte sequence has been encountered in the input */
3429 else if (errno == EINVAL) {
3430 /* An incomplete multibyte sequence has been encountered in the input. */
3433 FlushStrBuf(TmpBuf);
3436 TmpBuf->BufUsed = TmpBuf->BufSize - obuflen;
3437 TmpBuf->buf[TmpBuf->BufUsed] = '\0';
3439 /* little card game: wheres the red lady? */
3440 SwapBuffers(ConvertBuf, TmpBuf);
3441 FlushStrBuf(TmpBuf);
3448 * @ingroup StrBuf_DeEnCoder
3449 * @brief catches one RFC822 encoded segment, and decodes it.
3450 * @param Target buffer to fill with result
3451 * @param DecodeMe buffer with stuff to process
3452 * @param SegmentStart points to our current segment in DecodeMe
3453 * @param SegmentEnd Points to the end of our current segment in DecodeMe
3454 * @param ConvertBuf Workbuffer shared between several iterations. Random content; needs to be valid
3455 * @param ConvertBuf2 Workbuffer shared between several iterations. Random content; needs to be valid
3456 * @param FoundCharset Characterset to default decoding to; if we find another we will overwrite it.
3458 inline static void DecodeSegment(StrBuf *Target,
3459 const StrBuf *DecodeMe,
3460 const char *SegmentStart,
3461 const char *SegmentEnd,
3463 StrBuf *ConvertBuf2,
3464 StrBuf *FoundCharset)
3470 iconv_t ic = (iconv_t)(-1);
3474 /* Now we handle foreign character sets properly encoded
3475 * in RFC2047 format.
3477 StaticBuf.buf = (char*) SegmentStart; /*< it will just be read there... */
3478 StaticBuf.BufUsed = SegmentEnd - SegmentStart;
3479 StaticBuf.BufSize = DecodeMe->BufSize - (SegmentStart - DecodeMe->buf);
3480 extract_token(charset, SegmentStart, 1, '?', sizeof charset);
3481 if (FoundCharset != NULL) {
3482 FlushStrBuf(FoundCharset);
3483 StrBufAppendBufPlain(FoundCharset, charset, -1, 0);
3485 extract_token(encoding, SegmentStart, 2, '?', sizeof encoding);
3486 StrBufExtract_token(ConvertBuf, &StaticBuf, 3, '?');
3488 *encoding = toupper(*encoding);
3489 if (*encoding == 'B') { /**< base64 */
3490 if (ConvertBuf2->BufSize < ConvertBuf->BufUsed)
3491 IncreaseBuf(ConvertBuf2, 0, ConvertBuf->BufUsed);
3492 ConvertBuf2->BufUsed = CtdlDecodeBase64(ConvertBuf2->buf,
3494 ConvertBuf->BufUsed);
3496 else if (*encoding == 'Q') { /**< quoted-printable */
3500 while (pos < ConvertBuf->BufUsed)
3502 if (ConvertBuf->buf[pos] == '_')
3503 ConvertBuf->buf[pos] = ' ';
3507 if (ConvertBuf2->BufSize < ConvertBuf->BufUsed)
3508 IncreaseBuf(ConvertBuf2, 0, ConvertBuf->BufUsed);
3510 ConvertBuf2->BufUsed = CtdlDecodeQuotedPrintable(
3513 ConvertBuf->BufUsed);
3516 StrBufAppendBuf(ConvertBuf2, ConvertBuf, 0);
3519 ctdl_iconv_open("UTF-8", charset, &ic);
3520 if (ic != (iconv_t)(-1) ) {
3522 StrBufConvert(ConvertBuf2, ConvertBuf, &ic);
3523 StrBufAppendBuf(Target, ConvertBuf2, 0);
3528 StrBufAppendBufPlain(Target, HKEY("(unreadable)"), 0);
3534 * @ingroup StrBuf_DeEnCoder
3535 * @brief Handle subjects with RFC2047 encoding such as: [deprecated old syntax!]
3536 * =?koi8-r?B?78bP0s3Mxc7JxSDXz9rE1dvO2c3JINvB0sHNySDP?=
3537 * @param Target where to put the decoded string to
3538 * @param DecodeMe buffer with encoded string
3539 * @param DefaultCharset if we don't find one, which should we use?
3540 * @param FoundCharset overrides DefaultCharset if non-empty; If we find a charset inside of the string,
3541 * put it here for later use where no string might be known.
3543 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset)
3546 StrBuf *ConvertBuf2;
3547 ConvertBuf = NewStrBufPlain(NULL, StrLength(DecodeMe));
3548 ConvertBuf2 = NewStrBufPlain(NULL, StrLength(DecodeMe));
3550 StrBuf_RFC822_2_Utf8(Target,
3556 FreeStrBuf(&ConvertBuf);
3557 FreeStrBuf(&ConvertBuf2);
3561 * @ingroup StrBuf_DeEnCoder
3562 * @brief Handle subjects with RFC2047 encoding such as:
3563 * =?koi8-r?B?78bP0s3Mxc7JxSDXz9rE1dvO2c3JINvB0sHNySDP?=
3564 * @param Target where to put the decoded string to
3565 * @param DecodeMe buffer with encoded string
3566 * @param DefaultCharset if we don't find one, which should we use?
3567 * @param FoundCharset overrides DefaultCharset if non-empty; If we find a charset inside of the string,
3568 * put it here for later use where no string might be known.
3569 * @param ConvertBuf workbuffer. feed in, you shouldn't care about its content.
3570 * @param ConvertBuf2 workbuffer. feed in, you shouldn't care about its content.
3572 void StrBuf_RFC822_2_Utf8(StrBuf *Target,
3573 const StrBuf *DecodeMe,
3574 const StrBuf* DefaultCharset,
3575 StrBuf *FoundCharset,
3577 StrBuf *ConvertBuf2)
3579 StrBuf *DecodedInvalidBuf = NULL;
3580 const StrBuf *DecodeMee = DecodeMe;
3581 const char *start, *end, *next, *nextend, *ptr = NULL;
3583 iconv_t ic = (iconv_t)(-1) ;
3588 int illegal_non_rfc2047_encoding = 0;
3591 if (DecodeMe == NULL)
3593 /* Sometimes, badly formed messages contain strings which were simply
3594 * written out directly in some foreign character set instead of
3595 * using RFC2047 encoding. This is illegal but we will attempt to
3596 * handle it anyway by converting from a user-specified default
3597 * charset to UTF-8 if we see any nonprintable characters.
3600 for (i=0; i<DecodeMe->BufUsed; ++i) {
3601 if ((DecodeMe->buf[i] < 32) || (DecodeMe->buf[i] > 126)) {
3602 illegal_non_rfc2047_encoding = 1;
3607 if ((illegal_non_rfc2047_encoding) &&
3608 (strcasecmp(ChrPtr(DefaultCharset), "UTF-8")) &&
3609 (strcasecmp(ChrPtr(DefaultCharset), "us-ascii")) )
3612 ctdl_iconv_open("UTF-8", ChrPtr(DefaultCharset), &ic);
3613 if (ic != (iconv_t)(-1) ) {
3614 DecodedInvalidBuf = NewStrBufDup(DecodeMe);
3615 StrBufConvert(DecodedInvalidBuf, ConvertBuf, &ic);///TODO: don't void const?
3616 DecodeMee = DecodedInvalidBuf;
3622 /* pre evaluate the first pair */
3624 start = strstr(DecodeMee->buf, "=?");
3625 eptr = DecodeMee->buf + DecodeMee->BufUsed;
3627 end = FindNextEnd (DecodeMee, start + 2);
3629 StrBufAppendBuf(Target, DecodeMee, 0);
3630 FreeStrBuf(&DecodedInvalidBuf);
3635 if (start != DecodeMee->buf) {
3638 nFront = start - DecodeMee->buf;
3639 StrBufAppendBufPlain(Target, DecodeMee->buf, nFront, 0);
3642 * Since spammers will go to all sorts of absurd lengths to get their
3643 * messages through, there are LOTS of corrupt headers out there.
3644 * So, prevent a really badly formed RFC2047 header from throwing
3645 * this function into an infinite loop.
3647 while ((start != NULL) &&
3654 DecodeSegment(Target,
3662 next = strstr(end, "=?");
3664 if ((next != NULL) &&
3666 nextend = FindNextEnd(DecodeMee, next);
3667 if (nextend == NULL)
3670 /* did we find two partitions */
3671 if ((next != NULL) &&
3675 while ((ptr < next) &&
3682 * did we find a gab just filled with blanks?
3683 * if not, copy its stuff over.
3687 StrBufAppendBufPlain(Target,
3693 /* our next-pair is our new first pair now. */
3699 nextend = DecodeMee->buf + DecodeMee->BufUsed;
3700 if ((end != NULL) && (end < nextend)) {
3702 while ( (ptr < nextend) &&
3709 StrBufAppendBufPlain(Target, end, nextend - end, 0);
3711 FreeStrBuf(&DecodedInvalidBuf);
3714 /*******************************************************************************
3715 * Manipulating UTF-8 Strings *
3716 *******************************************************************************/
3720 * @brief evaluate the length of an utf8 special character sequence
3721 * @param Char the character to examine
3722 * @returns width of utf8 chars in bytes; if the sequence is broken 0 is returned; 1 if its simply ASCII.
3724 static inline int Ctdl_GetUtf8SequenceLength(const char *CharS, const char *CharE)
3727 unsigned char test = (1<<7);
3729 if ((*CharS & 0xC0) != 0xC0)
3733 ((test & ((unsigned char)*CharS)) != 0))
3738 if ((n > 6) || ((CharE - CharS) < n))
3745 * @brief detect whether this char starts an utf-8 encoded char
3746 * @param Char character to inspect
3747 * @returns yes or no
3749 static inline int Ctdl_IsUtf8SequenceStart(const char Char)
3751 /** 11??.???? indicates an UTF8 Sequence. */
3752 return ((Char & 0xC0) == 0xC0);
3757 * @brief measure the number of glyphs in an UTF8 string...
3758 * @param Buf string to measure
3759 * @returns the number of glyphs in Buf
3761 long StrBuf_Utf8StrLen(StrBuf *Buf)
3767 if ((Buf == NULL) || (Buf->BufUsed == 0))
3770 eptr = Buf->buf + Buf->BufUsed;
3771 while ((aptr < eptr) && (*aptr != '\0')) {
3772 if (Ctdl_IsUtf8SequenceStart(*aptr)){
3773 m = Ctdl_GetUtf8SequenceLength(aptr, eptr);
3774 while ((aptr < eptr) && (*aptr++ != '\0')&& (m-- > 0) );
3787 * @brief cuts a string after maxlen glyphs
3788 * @param Buf string to cut to maxlen glyphs
3789 * @param maxlen how long may the string become?
3790 * @returns current length of the string
3792 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen)
3798 eptr = Buf->buf + Buf->BufUsed;
3799 while ((aptr < eptr) && (*aptr != '\0')) {
3800 if (Ctdl_IsUtf8SequenceStart(*aptr)){
3801 m = Ctdl_GetUtf8SequenceLength(aptr, eptr);
3802 while ((*aptr++ != '\0') && (m-- > 0));
3811 Buf->BufUsed = aptr - Buf->buf;
3812 return Buf->BufUsed;
3815 return Buf->BufUsed;
3823 /*******************************************************************************
3825 *******************************************************************************/
3828 #define DEF_MEM_LEVEL 8 /*< memlevel??? */
3829 #define OS_CODE 0x03 /*< unix */
3832 * @ingroup StrBuf_DeEnCoder
3833 * @brief uses the same calling syntax as compress2(), but it
3834 * creates a stream compatible with HTTP "Content-encoding: gzip"
3835 * @param dest compressed buffer
3836 * @param destLen length of the compresed data
3837 * @param source source to encode
3838 * @param sourceLen length of source to encode
3839 * @param level compression level
3841 int ZEXPORT compress_gzip(Bytef * dest,
3843 const Bytef * source,
3847 const int gz_magic[2] = { 0x1f, 0x8b }; /* gzip magic header */
3849 /* write gzip header */
3850 snprintf((char *) dest, *destLen,
3851 "%c%c%c%c%c%c%c%c%c%c",
3852 gz_magic[0], gz_magic[1], Z_DEFLATED,
3853 0 /*flags */ , 0, 0, 0, 0 /*time */ , 0 /* xflags */ ,
3856 /* normal deflate */
3859 stream.next_in = (Bytef *) source;
3860 stream.avail_in = (uInt) sourceLen;
3861 stream.next_out = dest + 10L; // after header
3862 stream.avail_out = (uInt) * destLen;
3863 if ((uLong) stream.avail_out != *destLen)
3866 stream.zalloc = (alloc_func) 0;
3867 stream.zfree = (free_func) 0;
3868 stream.opaque = (voidpf) 0;
3870 err = deflateInit2(&stream, level, Z_DEFLATED, -MAX_WBITS,
3871 DEF_MEM_LEVEL, Z_DEFAULT_STRATEGY);
3875 err = deflate(&stream, Z_FINISH);
3876 if (err != Z_STREAM_END) {
3877 deflateEnd(&stream);
3878 return err == Z_OK ? Z_BUF_ERROR : err;
3880 *destLen = stream.total_out + 10L;
3882 /* write CRC and Length */
3883 uLong crc = crc32(0L, source, sourceLen);
3885 for (n = 0; n < 4; ++n, ++*destLen) {
3886 dest[*destLen] = (int) (crc & 0xff);
3889 uLong len = stream.total_in;
3890 for (n = 0; n < 4; ++n, ++*destLen) {
3891 dest[*destLen] = (int) (len & 0xff);
3894 err = deflateEnd(&stream);
3901 * @ingroup StrBuf_DeEnCoder
3902 * @brief compress the buffer with gzip
3903 * Attention! If you feed this a Const String, you must maintain the uncompressed buffer yourself!
3904 * @param Buf buffer whose content is to be gzipped
3906 int CompressBuffer(StrBuf *Buf)
3909 char *compressed_data = NULL;
3910 size_t compressed_len, bufsize;
3913 bufsize = compressed_len = Buf->BufUsed + (Buf->BufUsed / 100) + 100;
3914 compressed_data = malloc(compressed_len);
3916 if (compressed_data == NULL)
3918 /* Flush some space after the used payload so valgrind shuts up... */
3919 while ((i < 10) && (Buf->BufUsed + i < Buf->BufSize))
3920 Buf->buf[Buf->BufUsed + i++] = '\0';
3921 if (compress_gzip((Bytef *) compressed_data,
3924 (uLongf) Buf->BufUsed, Z_BEST_SPEED) == Z_OK) {
3927 Buf->buf = compressed_data;
3928 Buf->BufUsed = compressed_len;
3929 Buf->BufSize = bufsize;
3930 /* Flush some space after the used payload so valgrind shuts up... */
3932 while ((i < 10) && (Buf->BufUsed + i < Buf->BufSize))
3933 Buf->buf[Buf->BufUsed + i++] = '\0';
3936 free(compressed_data);
3938 #endif /* HAVE_ZLIB */
3942 /*******************************************************************************
3943 * File I/O; Callbacks to libevent *
3944 *******************************************************************************/
3946 long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB)
3951 if ((FB == NULL) || (FB->Buf == NULL))
3955 * check whether the read pointer is somewhere in a range
3956 * where a cut left is inexpensive
3959 if (FB->ReadWritePointer != NULL)
3963 already_read = FB->ReadWritePointer - FB->Buf->buf;
3964 bufremain = FB->Buf->BufSize - FB->Buf->BufUsed - 1;
3966 if (already_read != 0) {
3969 unread = FB->Buf->BufUsed - already_read;
3971 /* else nothing to compact... */
3973 FB->ReadWritePointer = FB->Buf->buf;
3974 bufremain = FB->Buf->BufSize;
3976 else if ((unread < 64) ||
3977 (bufremain < already_read))
3980 * if its just a tiny bit remaining, or we run out of space...
3983 FB->Buf->BufUsed = unread;
3984 if (unread < already_read)
3985 memcpy(FB->Buf->buf, FB->ReadWritePointer, unread);
3987 memmove(FB->Buf->buf, FB->ReadWritePointer, unread);
3988 FB->ReadWritePointer = FB->Buf->buf;
3989 bufremain = FB->Buf->BufSize - unread - 1;
3991 else if (bufremain < (FB->Buf->BufSize / 10))
3993 /* get a bigger buffer */
3995 IncreaseBuf(FB->Buf, 0, FB->Buf->BufUsed + 1);
3997 FB->ReadWritePointer = FB->Buf->buf + unread;
3999 bufremain = FB->Buf->BufSize - unread - 1;
4000 /*TODO: special increase function that won't copy the already read! */
4003 else if (bufremain < 10) {
4004 IncreaseBuf(FB->Buf, 1, FB->Buf->BufUsed + 10);
4006 FB->ReadWritePointer = FB->Buf->buf;
4008 bufremain = FB->Buf->BufSize - FB->Buf->BufUsed - 1;
4013 FB->ReadWritePointer = FB->Buf->buf;
4014 bufremain = FB->Buf->BufSize - 1;
4017 n = read(fd, FB->Buf->buf + FB->Buf->BufUsed, bufremain);
4020 FB->Buf->BufUsed += n;
4021 FB->Buf->buf[FB->Buf->BufUsed] = '\0';
4026 int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB)
4031 if ((FB == NULL) || (FB->Buf == NULL))
4034 if (FB->ReadWritePointer != NULL)
4036 WriteRemain = FB->Buf->BufUsed -
4037 (FB->ReadWritePointer -
4041 FB->ReadWritePointer = FB->Buf->buf;
4042 WriteRemain = FB->Buf->BufUsed;
4045 n = write(fd, FB->ReadWritePointer, WriteRemain);
4047 FB->ReadWritePointer += n;
4049 if (FB->ReadWritePointer ==
4050 FB->Buf->buf + FB->Buf->BufUsed)
4052 FlushStrBuf(FB->Buf);
4053 FB->ReadWritePointer = NULL;
4056 // check whether we've got something to write
4057 // get the maximum chunk plus the pointer we can send
4058 // write whats there
4059 // if not all was sent, remember the send pointer for the next time
4060 return FB->ReadWritePointer - FB->Buf->buf + FB->Buf->BufUsed;
4066 * @ingroup StrBuf_IO
4067 * @brief extract a "next line" from Buf; Ptr to persist across several iterations
4068 * @param LineBuf your line will be copied here.
4069 * @param FB BLOB with lines of text...
4070 * @param Ptr moved arround to keep the next-line across several iterations
4071 * has to be &NULL on start; will be &NotNULL on end of buffer
4072 * @returns size of copied buffer
4074 eReadState StrBufChunkSipLine(StrBuf *LineBuf, IOBuffer *FB)
4076 const char *aptr, *ptr, *eptr;
4079 if ((FB == NULL) || (LineBuf == NULL) || (LineBuf->buf == NULL))
4083 if ((FB->Buf == NULL) || (FB->ReadWritePointer == StrBufNOTNULL)) {
4084 FB->ReadWritePointer = StrBufNOTNULL;
4088 FlushStrBuf(LineBuf);
4089 if (FB->ReadWritePointer == NULL)
4090 ptr = aptr = FB->Buf->buf;
4092 ptr = aptr = FB->ReadWritePointer;
4094 optr = LineBuf->buf;
4095 eptr = FB->Buf->buf + FB->Buf->BufUsed;
4096 xptr = LineBuf->buf + LineBuf->BufSize - 1;
4098 while ((ptr <= eptr) &&
4105 LineBuf->BufUsed = optr - LineBuf->buf;
4106 IncreaseBuf(LineBuf, 1, LineBuf->BufUsed + 1);
4107 optr = LineBuf->buf + LineBuf->BufUsed;
4108 xptr = LineBuf->buf + LineBuf->BufSize - 1;
4113 if (optr > LineBuf->buf)
4115 if ((*(ptr - 1) != '\r') && (*(ptr - 1) != '\n')) {
4116 LineBuf->BufUsed = optr - LineBuf->buf;
4118 if ((FB->ReadWritePointer != NULL) &&
4119 (FB->ReadWritePointer != FB->Buf->buf))
4121 /* Ok, the client application read all the data
4122 it was interested in so far. Since there is more to read,
4123 we now shrink the buffer, and move the rest over.
4125 StrBufCutLeft(FB->Buf,
4126 FB->ReadWritePointer - FB->Buf->buf);
4127 FB->ReadWritePointer = FB->Buf->buf;
4129 return eMustReadMore;
4132 LineBuf->BufUsed = optr - LineBuf->buf;
4134 if ((ptr <= eptr) && (*ptr == '\r'))
4136 if ((ptr <= eptr) && (*ptr == '\n'))
4140 FB->ReadWritePointer = ptr;
4143 FlushStrBuf(FB->Buf);
4144 FB->ReadWritePointer = NULL;
4147 return eReadSuccess;
4151 * @ingroup StrBuf_CHUNKED_IO
4152 * @brief check whether the chunk-buffer has more data waiting or not.
4153 * @param FB Chunk-Buffer to inspect
4155 eReadState StrBufCheckBuffer(IOBuffer *FB)
4159 if (FB->Buf->BufUsed == 0)
4160 return eReadSuccess;
4161 if (FB->ReadWritePointer == NULL)
4162 return eBufferNotEmpty;
4163 if (FB->Buf->buf + FB->Buf->BufUsed > FB->ReadWritePointer)
4164 return eBufferNotEmpty;
4165 return eReadSuccess;
4168 long IOBufferStrLength(IOBuffer *FB)
4170 if ((FB == NULL) || (FB->Buf == NULL))
4172 if (FB->ReadWritePointer == NULL)
4173 return StrLength(FB->Buf);
4175 return StrLength(FB->Buf) - (FB->ReadWritePointer - FB->Buf->buf);
4178 inline static void FDIOBufferFlush(FDIOBuffer *FDB)
4180 memset(FDB, 0, sizeof(FDIOBuffer));
4182 FDB->SplicePipe[0] = -1;
4183 FDB->SplicePipe[1] = -1;
4186 void FDIOBufferInit(FDIOBuffer *FDB, IOBuffer *IO, int FD, long TotalSendSize)
4188 FDIOBufferFlush(FDB);
4190 FDB->TotalSendSize = TotalSendSize;
4191 if (TotalSendSize > 0)
4192 FDB->ChunkSize = TotalSendSize;
4195 TotalSendSize = SIZ * 10;
4196 FDB->ChunkSize = TotalSendSize;
4202 pipe(FDB->SplicePipe);
4205 FDB->ChunkBuffer = NewStrBufPlain(NULL, TotalSendSize+ 1);
4210 void FDIOBufferDelete(FDIOBuffer *FDB)
4215 if (FDB->SplicePipe[0] > 0)
4216 close(FDB->SplicePipe[0]);
4217 if (FDB->SplicePipe[1] > 0)
4218 close(FDB->SplicePipe[1]);
4222 FreeStrBuf(&FDB->ChunkBuffer);
4224 if (FDB->OtherFD > 0)
4225 close(FDB->OtherFD);
4226 FDIOBufferFlush(FDB);
4229 int FileSendChunked(FDIOBuffer *FDB, const char **Err)
4231 ssize_t sent, pipesize;
4233 if (FDB->TotalSendSize > 0)
4238 if (FDB->PipeSize == 0)
4240 pipesize = splice(FDB->OtherFD,
4241 &FDB->TotalSentAlready,
4244 FDB->ChunkSendRemain,
4249 *Err = strerror(errno);
4252 FDB->PipeSize = pipesize;
4254 sent = splice(FDB->SplicePipe[0],
4259 SPLICE_F_MORE | SPLICE_F_MOVE | SPLICE_F_NONBLOCK);
4262 *Err = strerror(errno);
4265 FDB->PipeSize -= sent;
4266 FDB->ChunkSendRemain -= sent;
4275 pRead = FDB->ChunkBuffer->buf;
4276 while ((FDB->ChunkBuffer->BufUsed < FDB->TotalSendSize) && (nRead >= 0))
4278 nRead = read(FDB->OtherFD, pRead, FDB->TotalSendSize - FDB->ChunkBuffer->BufUsed);
4280 FDB->ChunkBuffer->BufUsed += nRead;
4281 FDB->ChunkBuffer->buf[FDB->ChunkBuffer->BufUsed] = '\0';
4283 else if (nRead == 0) {}
4287 nRead = write(FDB->IOB->fd,
4288 FDB->ChunkBuffer->buf + FDB->TotalSentAlready,
4289 FDB->ChunkBuffer->BufUsed - FDB->TotalSentAlready);
4292 FDB->TotalSentAlready += nRead;
4293 FDB->ChunkSendRemain -= nRead;
4294 return FDB->ChunkSendRemain;
4306 if (FDB->PipeSize == 0)
4308 pipesize = splice(FDB->OtherFD,
4309 &FDB->TotalSentAlready,
4317 *Err = strerror(errno);
4320 FDB->PipeSize = pipesize;
4324 sent = splice(FDB->SplicePipe[0],
4329 SPLICE_F_MORE | SPLICE_F_MOVE | SPLICE_F_NONBLOCK);
4332 *Err = strerror(errno);
4335 FDB->PipeSize -= sent;
4336 FDB->ChunkSendRemain -= sent;
4345 pRead = FDB->ChunkBuffer->buf;
4346 while ((FDB->ChunkSendRemain == 0) &&
4347 (FDB->ChunkBuffer->BufUsed < FDB->ChunkBuffer->BufSize) &&
4350 FDB->TotalSentAlready = 0;
4351 nRead = read(FDB->OtherFD, pRead, FDB->ChunkBuffer->BufSize - FDB->ChunkBuffer->BufUsed);
4353 FDB->ChunkBuffer->BufUsed += nRead;
4354 FDB->ChunkBuffer->buf[FDB->ChunkBuffer->BufUsed] = '\0';
4355 FDB->ChunkSendRemain += nRead;
4357 else if (nRead == 0)
4363 *Err = strerror(errno);
4368 nRead = write(FDB->IOB->fd,
4369 FDB->ChunkBuffer->buf + FDB->TotalSentAlready,
4370 FDB->ChunkBuffer->BufUsed - FDB->TotalSentAlready);
4373 FDB->TotalSentAlready += nRead;
4374 FDB->ChunkSendRemain -= nRead;
4375 if (FDB->ChunkSendRemain == 0)
4377 FDB->ChunkBuffer->BufUsed = 0;
4378 FDB->TotalSentAlready = 0;
4380 return FDB->ChunkSendRemain;
4389 int FileRecvChunked(FDIOBuffer *FDB, const char **Err)
4391 ssize_t sent, pipesize;
4396 if (FDB->PipeSize == 0)
4398 pipesize = splice(FDB->IOB->fd,
4402 FDB->ChunkSendRemain,
4403 SPLICE_F_MORE | SPLICE_F_MOVE|SPLICE_F_NONBLOCK);
4407 *Err = strerror(errno);
4410 FDB->PipeSize = pipesize;
4413 sent = splice(FDB->SplicePipe[0],
4416 &FDB->TotalSentAlready,
4418 SPLICE_F_MORE | SPLICE_F_MOVE);
4422 *Err = strerror(errno);
4425 FDB->PipeSize -= sent;
4426 FDB->ChunkSendRemain -= sent;
4432 sent = read(FDB->IOB->fd, FDB->ChunkBuffer->buf, FDB->ChunkSendRemain);
4437 FDB->ChunkBuffer->BufUsed = sent;
4439 while (nWritten < FDB->ChunkBuffer->BufUsed) {
4440 rc = write(FDB->OtherFD, FDB->ChunkBuffer->buf + nWritten, FDB->ChunkBuffer->BufUsed - nWritten);
4442 *Err = strerror(errno);
4448 FDB->ChunkBuffer->BufUsed = 0;
4449 FDB->TotalSentAlready += sent;
4450 FDB->ChunkSendRemain -= sent;
4451 return FDB->ChunkSendRemain;
4453 else if (sent < 0) {
4454 *Err = strerror(errno);
4461 int FileMoveChunked(FDIOBuffer *FDB, const char **Err)
4463 ssize_t sent, pipesize;
4468 if (FDB->PipeSize == 0)
4470 pipesize = splice(FDB->IOB->fd,
4471 &FDB->TotalReadAlready,
4474 FDB->ChunkSendRemain,
4475 SPLICE_F_MORE | SPLICE_F_MOVE|SPLICE_F_NONBLOCK);
4479 *Err = strerror(errno);
4482 FDB->PipeSize = pipesize;
4485 sent = splice(FDB->SplicePipe[0],
4488 &FDB->TotalSentAlready,
4490 SPLICE_F_MORE | SPLICE_F_MOVE);
4494 *Err = strerror(errno);
4497 FDB->PipeSize -= sent;
4498 FDB->ChunkSendRemain -= sent;
4504 sent = read(FDB->IOB->fd, FDB->ChunkBuffer->buf, FDB->ChunkSendRemain);
4509 FDB->ChunkBuffer->BufUsed = sent;
4511 while (nWritten < FDB->ChunkBuffer->BufUsed) {
4512 rc = write(FDB->OtherFD, FDB->ChunkBuffer->buf + nWritten, FDB->ChunkBuffer->BufUsed - nWritten);
4514 *Err = strerror(errno);
4520 FDB->ChunkBuffer->BufUsed = 0;
4521 FDB->TotalSentAlready += sent;
4522 FDB->ChunkSendRemain -= sent;
4523 return FDB->ChunkSendRemain;
4525 else if (sent < 0) {
4526 *Err = strerror(errno);
4533 eReadState WriteIOBAlreadyRead(FDIOBuffer *FDB, const char **Error)
4539 int nSuccessLess = 0;
4543 fdflags = fcntl(FDB->OtherFD, F_GETFL);
4544 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
4546 while ((FDB->IOB->ReadWritePointer - FDB->IOB->Buf->buf < FDB->IOB->Buf->BufUsed) &&
4547 (FDB->ChunkSendRemain > 0))
4550 tv.tv_sec = 1; /* selectresolution; */
4554 FD_SET(FDB->OtherFD, &rfds);
4555 if (select(FDB->OtherFD + 1, NULL, &rfds, NULL, &tv) == -1) {
4556 *Error = strerror(errno);
4560 if (IsNonBlock && ! FD_ISSET(FDB->OtherFD, &rfds)) {
4565 should_write = FDB->IOB->Buf->BufUsed -
4566 (FDB->IOB->ReadWritePointer - FDB->IOB->Buf->buf);
4567 if (should_write > FDB->ChunkSendRemain)
4568 should_write = FDB->ChunkSendRemain;
4570 rlen = write(FDB->OtherFD,
4571 FDB->IOB->ReadWritePointer,
4574 *Error = strerror(errno);
4578 FDB->TotalSentAlready += rlen;
4579 FDB->IOB->ReadWritePointer += rlen;
4580 FDB->ChunkSendRemain -= rlen;
4582 if (FDB->IOB->ReadWritePointer >= FDB->IOB->Buf->buf + FDB->IOB->Buf->BufUsed)
4584 FlushStrBuf(FDB->IOB->Buf);
4585 FDB->IOB->ReadWritePointer = NULL;
4588 if (FDB->ChunkSendRemain == 0)
4589 return eReadSuccess;
4591 return eMustReadMore;
4594 /*******************************************************************************
4595 * File I/O; Prefer buffered read since its faster! *
4596 *******************************************************************************/
4599 * @ingroup StrBuf_IO
4600 * @brief Read a line from socket
4601 * flushes and closes the FD on error
4602 * @param buf the buffer to get the input to
4603 * @param fd pointer to the filedescriptor to read
4604 * @param append Append to an existing string or replace?
4605 * @param Error strerror() on error
4606 * @returns numbers of chars read
4608 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error)
4610 int len, rlen, slen;
4612 if ((buf == NULL) || (buf->buf == NULL)) {
4613 *Error = strerror(EINVAL);
4620 slen = len = buf->BufUsed;
4622 rlen = read(*fd, &buf->buf[len], 1);
4624 *Error = strerror(errno);
4631 if (buf->buf[len] == '\n')
4633 if (buf->buf[len] != '\r')
4635 if (len + 2 >= buf->BufSize) {
4637 buf->buf[len+1] = '\0';
4638 IncreaseBuf(buf, 1, -1);
4642 buf->buf[len] = '\0';
4647 * @ingroup StrBuf_BufferedIO
4648 * @brief Read a line from socket
4649 * flushes and closes the FD on error
4650 * @param Line the line to read from the fd / I/O Buffer
4651 * @param buf the buffer to get the input to
4652 * @param fd pointer to the filedescriptor to read
4653 * @param timeout number of successless selects until we bail out
4654 * @param selectresolution how long to wait on each select
4655 * @param Error strerror() on error
4656 * @returns numbers of chars read
4658 int StrBufTCP_read_buffered_line(StrBuf *Line,
4662 int selectresolution,
4666 int nSuccessLess = 0;
4673 if (buf->BufUsed > 0) {
4674 pch = strchr(buf->buf, '\n');
4677 len = pch - buf->buf;
4678 if (len > 0 && (*(pch - 1) == '\r') )
4680 StrBufSub(Line, buf, 0, len - rlen);
4681 StrBufCutLeft(buf, len + 1);
4686 if (buf->BufSize - buf->BufUsed < 10)
4687 IncreaseBuf(buf, 1, -1);
4689 fdflags = fcntl(*fd, F_GETFL);
4690 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
4692 while ((nSuccessLess < timeout) && (pch == NULL)) {
4694 tv.tv_sec = selectresolution;
4699 if (select(*fd + 1, NULL, &rfds, NULL, &tv) == -1) {
4700 *Error = strerror(errno);
4706 if (IsNonBlock && ! FD_ISSET(*fd, &rfds)) {
4711 &buf->buf[buf->BufUsed],
4712 buf->BufSize - buf->BufUsed - 1);
4714 *Error = strerror(errno);
4719 else if (rlen > 0) {
4721 buf->BufUsed += rlen;
4722 buf->buf[buf->BufUsed] = '\0';
4723 pch = strchr(buf->buf, '\n');
4724 if ((pch == NULL) &&
4725 (buf->BufUsed + 10 > buf->BufSize) &&
4726 (IncreaseBuf(buf, 1, -1) == -1))
4734 len = pch - buf->buf;
4735 if (len > 0 && (*(pch - 1) == '\r') )
4737 StrBufSub(Line, buf, 0, len - rlen);
4738 StrBufCutLeft(buf, len + 1);
4745 static const char *ErrRBLF_PreConditionFailed="StrBufTCP_read_buffered_line_fast: Wrong arguments or invalid Filedescriptor";
4746 static const char *ErrRBLF_SelectFailed="StrBufTCP_read_buffered_line_fast: Select failed without reason";
4747 static const char *ErrRBLF_NotEnoughSentFromServer="StrBufTCP_read_buffered_line_fast: No complete line was sent from peer";
4749 * @ingroup StrBuf_BufferedIO
4750 * @brief Read a line from socket
4751 * flushes and closes the FD on error
4752 * @param Line where to append our Line read from the fd / I/O Buffer;
4753 * @param IOBuf the buffer to get the input to; lifetime pair to FD
4754 * @param Pos pointer to the current read position, should be NULL initialized on opening the FD it belongs to.!
4755 * @param fd pointer to the filedescriptor to read
4756 * @param timeout number of successless selects until we bail out
4757 * @param selectresolution how long to wait on each select
4758 * @param Error strerror() on error
4759 * @returns numbers of chars read or -1 in case of error. "\n" will become 0
4761 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
4766 int selectresolution,
4769 const char *pche = NULL;
4770 const char *pos = NULL;
4772 int len, rlen, retlen;
4773 int nSuccessLess = 0;
4775 const char *pch = NULL;
4781 if ((Line == NULL) ||
4788 *Error = ErrRBLF_PreConditionFailed;
4793 if ((IOBuf->BufUsed > 0) &&
4795 (pos < IOBuf->buf + IOBuf->BufUsed))
4799 pche = IOBuf->buf + IOBuf->BufUsed;
4803 while ((pch < pche) && (*pch != '\n'))
4805 if (Line->BufUsed + 10 > Line->BufSize)
4808 apos = pcht - Line->buf;
4810 IncreaseBuf(Line, 1, -1);
4811 pcht = Line->buf + apos;
4819 if (len > 0 && (*(pch - 1) == '\r') )
4828 if ((pch >= pche) || (*pch == '\0'))
4836 if ((pch != NULL) &&
4839 if (pch + 1 >= pche) {
4852 /* If we come here, Pos is Unset since we read everything into Line, and now go for more. */
4854 if (IOBuf->BufSize - IOBuf->BufUsed < 10)
4855 IncreaseBuf(IOBuf, 1, -1);
4857 fdflags = fcntl(*fd, F_GETFL);
4858 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
4861 while ((nSuccessLess < timeout) &&
4871 if (select((*fd) + 1, &rfds, NULL, NULL, &tv) == -1) {
4872 *Error = strerror(errno);
4876 *Error = ErrRBLF_SelectFailed;
4879 if (! FD_ISSET(*fd, &rfds) != 0) {
4885 &IOBuf->buf[IOBuf->BufUsed],
4886 IOBuf->BufSize - IOBuf->BufUsed - 1);
4888 *Error = strerror(errno);
4893 else if (rlen > 0) {
4895 pLF = IOBuf->buf + IOBuf->BufUsed;
4896 IOBuf->BufUsed += rlen;
4897 IOBuf->buf[IOBuf->BufUsed] = '\0';
4899 pche = IOBuf->buf + IOBuf->BufUsed;
4901 while ((pLF < pche) && (*pLF != '\n'))
4903 if ((pLF >= pche) || (*pLF == '\0'))
4906 if (IOBuf->BufUsed + 10 > IOBuf->BufSize)
4910 if (pLF != NULL) apos = pLF - IOBuf->buf;
4911 IncreaseBuf(IOBuf, 1, -1);
4912 if (pLF != NULL) pLF = IOBuf->buf + apos;
4926 if (len > 0 && (*(pLF - 1) == '\r') )
4928 StrBufAppendBufPlain(Line, ChrPtr(IOBuf), len, 0);
4929 if (pLF + 1 >= IOBuf->buf + IOBuf->BufUsed)
4935 return retlen + len;
4937 *Error = ErrRBLF_NotEnoughSentFromServer;
4942 static const char *ErrRBLF_BLOBPreConditionFailed="StrBufReadBLOB: Wrong arguments or invalid Filedescriptor";
4944 * @ingroup StrBuf_IO
4945 * @brief Input binary data from socket
4946 * flushes and closes the FD on error
4947 * @param Buf the buffer to get the input to
4948 * @param fd pointer to the filedescriptor to read
4949 * @param append Append to an existing string or replace?
4950 * @param nBytes the maximal number of bytes to read
4951 * @param Error strerror() on error
4952 * @returns numbers of chars read
4954 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error)
4965 if ((Buf == NULL) || (Buf->buf == NULL) || (*fd == -1))
4967 *Error = ErrRBLF_BLOBPreConditionFailed;
4972 if (Buf->BufUsed + nBytes >= Buf->BufSize)
4973 IncreaseBuf(Buf, 1, Buf->BufUsed + nBytes);
4975 ptr = Buf->buf + Buf->BufUsed;
4977 fdflags = fcntl(*fd, F_GETFL);
4978 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
4980 while ((nRead < nBytes) &&
4990 if (select(*fd + 1, &rfds, NULL, NULL, &tv) == -1) {
4991 *Error = strerror(errno);
4995 *Error = ErrRBLF_SelectFailed;
4998 if (! FD_ISSET(*fd, &rfds) != 0) {
5004 if ((rlen = read(*fd,
5006 nBytes - nRead)) == -1) {
5009 *Error = strerror(errno);
5014 Buf->BufUsed += rlen;
5016 Buf->buf[Buf->BufUsed] = '\0';
5020 const char *ErrRBB_BLOBFPreConditionFailed = "StrBufReadBLOBBuffered: to many selects; aborting.";
5021 const char *ErrRBB_too_many_selects = "StrBufReadBLOBBuffered: to many selects; aborting.";
5023 * @ingroup StrBuf_BufferedIO
5024 * @brief Input binary data from socket
5025 * flushes and closes the FD on error
5026 * @param Blob put binary thing here
5027 * @param IOBuf the buffer to get the input to
5028 * @param Pos offset inside of IOBuf
5029 * @param fd pointer to the filedescriptor to read
5030 * @param append Append to an existing string or replace?
5031 * @param nBytes the maximal number of bytes to read
5032 * @param check whether we should search for '000\n' terminators in case of timeouts
5033 * @param Error strerror() on error
5034 * @returns numbers of chars read
5036 int StrBufReadBLOBBuffered(StrBuf *Blob,
5049 int nAlreadyRead = 0;
5054 int nSuccessLess = 0;
5057 if ((Blob == NULL) ||
5064 *Error = ErrRBB_BLOBFPreConditionFailed;
5070 if (Blob->BufUsed + nBytes >= Blob->BufSize)
5071 IncreaseBuf(Blob, append, Blob->BufUsed + nBytes);
5076 rlen = pos - IOBuf->buf;
5077 rlen = IOBuf->BufUsed - rlen;
5080 if ((IOBuf->BufUsed > 0) &&
5082 (pos < IOBuf->buf + IOBuf->BufUsed))
5084 if (rlen < nBytes) {
5085 memcpy(Blob->buf + Blob->BufUsed, pos, rlen);
5086 Blob->BufUsed += rlen;
5087 Blob->buf[Blob->BufUsed] = '\0';
5088 nAlreadyRead = nRead = rlen;
5091 if (rlen >= nBytes) {
5092 memcpy(Blob->buf + Blob->BufUsed, pos, nBytes);
5093 Blob->BufUsed += nBytes;
5094 Blob->buf[Blob->BufUsed] = '\0';
5095 if (rlen == nBytes) {
5107 if (IOBuf->BufSize < nBytes - nRead)
5108 IncreaseBuf(IOBuf, 0, nBytes - nRead);
5111 fdflags = fcntl(*fd, F_GETFL);
5112 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
5120 while ((nSuccessLess < MaxTries) &&
5130 if (select(*fd + 1, &rfds, NULL, NULL, &tv) == -1) {
5131 *Error = strerror(errno);
5135 *Error = ErrRBLF_SelectFailed;
5138 if (! FD_ISSET(*fd, &rfds) != 0) {
5145 IOBuf->BufSize - (ptr - IOBuf->buf));
5149 *Error = strerror(errno);
5152 else if (rlen == 0){
5153 if ((check == NNN_TERM) &&
5155 (strncmp(IOBuf->buf + IOBuf->BufUsed - 5, "\n000\n", 5) == 0))
5157 StrBufPlain(Blob, HKEY("\n000\n"));
5158 StrBufCutRight(Blob, 5);
5159 return Blob->BufUsed;
5161 else if (!IsNonBlock)
5163 else if (nSuccessLess > MaxTries) {
5165 *Error = ErrRBB_too_many_selects;
5169 else if (rlen > 0) {
5173 IOBuf->BufUsed += rlen;
5176 if (nSuccessLess >= MaxTries) {
5178 *Error = ErrRBB_too_many_selects;
5182 if (nRead > nBytes) {
5183 *Pos = IOBuf->buf + nBytes;
5185 Blob->buf[Blob->BufUsed] = '\0';
5186 StrBufAppendBufPlain(Blob, IOBuf->buf, nBytes, 0);
5190 return nRead + nAlreadyRead;
5194 * @ingroup StrBuf_IO
5195 * @brief extract a "next line" from Buf; Ptr to persist across several iterations
5196 * @param LineBuf your line will be copied here.
5197 * @param Buf BLOB with lines of text...
5198 * @param Ptr moved arround to keep the next-line across several iterations
5199 * has to be &NULL on start; will be &NotNULL on end of buffer
5200 * @returns size of remaining buffer
5202 int StrBufSipLine(StrBuf *LineBuf, const StrBuf *Buf, const char **Ptr)
5204 const char *aptr, *ptr, *eptr;
5207 if ((Buf == NULL) ||
5208 (*Ptr == StrBufNOTNULL) ||
5210 (LineBuf->buf == NULL))
5212 *Ptr = StrBufNOTNULL;
5216 FlushStrBuf(LineBuf);
5218 ptr = aptr = Buf->buf;
5222 optr = LineBuf->buf;
5223 eptr = Buf->buf + Buf->BufUsed;
5224 xptr = LineBuf->buf + LineBuf->BufSize - 1;
5226 while ((ptr <= eptr) &&
5233 LineBuf->BufUsed = optr - LineBuf->buf;
5234 IncreaseBuf(LineBuf, 1, LineBuf->BufUsed + 1);
5235 optr = LineBuf->buf + LineBuf->BufUsed;
5236 xptr = LineBuf->buf + LineBuf->BufSize - 1;
5240 if ((ptr >= eptr) && (optr > LineBuf->buf))
5242 LineBuf->BufUsed = optr - LineBuf->buf;
5244 if ((ptr <= eptr) && (*ptr == '\r'))
5246 if ((ptr <= eptr) && (*ptr == '\n'))
5253 *Ptr = StrBufNOTNULL;
5256 return Buf->BufUsed - (ptr - Buf->buf);
5261 * @ingroup StrBuf_IO
5262 * @brief removes double slashes from pathnames
5263 * @param Dir directory string to filter
5264 * @param RemoveTrailingSlash allows / disallows trailing slashes
5266 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash)
5272 while (!IsEmptyStr(a)) {
5284 if ((RemoveTrailingSlash) &&
5290 Dir->BufUsed = b - Dir->buf;