5 * \defgroup MiscRout Miscellaneous routines
11 #include "webserver.h"
14 typedef unsigned char byte; /**< byte data type */
16 #define FALSE 0 /**< no. */
17 #define TRUE 1 /**< yes. */
19 static byte dtable[256]; /**< base64 encode / decode table */
22 * \brief sanitize strncopy.
23 * \param dest destination string
24 * \param src source string
25 * \param n length of source to copy
26 * \return result string
28 char *safestrncpy(char *dest, const char *src, size_t n)
30 if (dest == NULL || src == NULL) {
33 strncpy(dest, src, n);
41 * \brief discover number of parameters/tokens in a string
42 * \param source string to inspect
43 * \param tok seperation token
44 * \return number of tokenized parts found
46 int num_tokens(char *source, char tok)
55 while (*ptr != '\0') {
65 * extract_token() - a string tokenizer
66 * returns -1 if not found, or length of token.
68 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen)
70 const char *s; //* source * /
71 int len = 0; //* running total length of extracted string * /
72 int current_token = 0; //* token currently being processed * /
81 // lprintf (CTDL_DEBUG, "test >: n: %d sep: %c source: %s \n willi \n", parmnum, separator, source);
89 if (*s == separator) {
92 if ( (current_token == parmnum) &&
98 else if ((current_token > parmnum) || (len >= maxlen)) {
105 if (current_token < parmnum) {
106 // lprintf (CTDL_DEBUG,"test <!: %s\n", dest);
109 // lprintf (CTDL_DEBUG,"test <: %d; %s\n", len, dest);
116 * \brief a tokenizer that kills, maims, and destroys
117 * \param source the string to process
118 * \param parmnum which token to kill
119 * \param separator the tokenizer string
121 void remove_token(char *source, int parmnum, char separator)
133 slen = strlen(source);
139 ( (i < slen) && (end == -1) );
141 if ((start < 0) && (curr_parm == parmnum)) {
145 if ((end < 0) && (curr_parm == (parmnum + 1))) {
149 if (source[i] == separator) {
157 memmove(&source[start], &source[end], slen - end + 1);
164 * \brief extract an int parm w/o supplying a buffer
165 * \param source the string to locate the int in
166 * \param parmnum the n'th token to grab the int from
167 * \return the integer
169 int extract_int(const char *source, int parmnum)
173 extract_token(buf, source, parmnum, '|', sizeof buf);
178 * \brief extract an long parm w/o supplying a buffer
179 * \param source string to examine
180 * \param parmnum n'th token to search long in
181 * \return the found long value
183 long extract_long(const char *source, int parmnum)
187 extract_token(buf, source, parmnum, '|', sizeof buf);
197 * \brief check for the presence of a character within a string (returns count)
198 * \param st the string to examine
199 * \param ch the char to search
200 * \return the position inside of st
202 int haschar(const char *st,char ch)
208 while (!IsEmptyStr(ptr))
216 * \brief Utility function to "readline" from memory
217 * \param start Location in memory from which we are reading.
218 * \param buf the buffer to place the string in.
219 * \param maxlen Size of string buffer
220 * \return Pointer to the source memory right after we stopped reading.
222 char *memreadline(char *start, char *buf, int maxlen)
226 int len = 0; /**< tally our own length to avoid strlen() delays */
231 if ((len + 1 < (maxlen)) && (ch != 13) && (ch != 10)) {
234 if ((ch == 10) || (ch == 0)) {
244 * \brief searches for a paternn within asearch string
245 * \param search the string to search
246 * \param patn the pattern to find in string
247 * \returns position in string
249 int pattern2(char *search, char *patn)
253 len = strlen (search);
254 plen = strlen (patn);
255 for (a = 0; a < len; ++a) {
256 if (!strncasecmp(&search[a], patn, plen))
264 * \brief Strip leading and trailing spaces from a string; with premeasured and adjusted length.
265 * \param buf the string to modify
266 * \param len length of the string.
268 void stripltlen(char *buf, int *len)
271 if (*len == 0) return;
272 while ((*len > delta) && (isspace(buf[delta]))){
275 memmove (buf, &buf[delta], *len - delta + 1);
278 if (*len == 0) return;
279 while (isspace(buf[(*len) - 1])){
280 buf[--(*len)] = '\0';
285 * \brief Strip leading and trailing spaces from a string
286 * \param buf the string to modify
288 void striplt(char *buf)
292 stripltlen(buf, &len);
297 * \brief Determine whether the specified message number is contained within the
300 * \param mset Message set string
301 * \param msgnum Message number we are looking for
303 * \return Nonzero if the specified message number is in the specified message set string.
305 int is_msg_in_mset(char *mset, long msgnum) {
308 char setstr[SIZ], lostr[SIZ], histr[SIZ]; /* was 1024 */
312 * Now set it for all specified messages.
314 num_sets = num_tokens(mset, ',');
315 for (s=0; s<num_sets; ++s) {
316 extract_token(setstr, mset, s, ',', sizeof setstr);
318 extract_token(lostr, setstr, 0, ':', sizeof lostr);
319 if (num_tokens(setstr, ':') >= 2) {
320 extract_token(histr, setstr, 1, ':', sizeof histr);
321 if (!strcmp(histr, "*")) {
322 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
326 strcpy(histr, lostr);
331 if ((msgnum >= lo) && (msgnum <= hi)) return(1);
340 * \brief Strip a boundarized substring out of a string
341 * (for example, remove
342 * parentheses and anything inside them).
344 * This improved version can strip out *multiple* boundarized substrings.
345 * \param str the string to process
346 * \param leftboundary the boundary character on the left side of the target string
347 * \param rightboundary the boundary character on the right side of the target string
349 void stripout(char *str, char leftboundary, char rightboundary)
354 int len = strlen(str);
360 for (a = 0; a < len; ++a) {
361 if (str[a] == leftboundary)
363 if (str[a] == rightboundary)
367 if ((lb > 0) && (rb > lb)) {
368 memmove(&str[lb - 1], &str[rb + 1], len - rb);
369 len -= (rb - lb + 2);
372 } while ((lb > 0) && (rb > lb));
379 * \brief Replacement for sleep() that uses select() in order to avoid SIGALRM
380 * \param seconds how many seconds should we sleep?
382 void sleeeeeeeeeep(int seconds)
388 select(0, NULL, NULL, NULL, &tv);
394 * \brief encode a string into base64 to for example tunnel it through mail transport
395 * CtdlDecodeBase64() and CtdlEncodeBase64() are adaptations of code by
396 * John Walker, copied over from the Citadel server.
397 * \param dest encrypted string
398 * \param source the string to encrypt
399 * \param sourcelen the length of the source data (may contain string terminators)
400 * \return the length of the encoded string.
403 size_t CtdlEncodeBase64(char **pdest, const char *source, size_t sourcelen, size_t *destlen, int linebreaks)
405 int i, hiteof = FALSE;
413 /** Fill dtable with character encodings. */
415 for (i = 0; i < 26; i++) {
417 dtable[26 + i] = 'a' + i;
419 for (i = 0; i < 10; i++) {
420 dtable[52 + i] = '0' + i;
426 byte igroup[3], ogroup[4];
429 igroup[0] = igroup[1] = igroup[2] = 0;
430 for (n = 0; n < 3; n++) {
431 if (spos >= sourcelen) {
436 igroup[n] = (byte) c;
439 ogroup[0] = dtable[igroup[0] >> 2];
441 dtable[((igroup[0] & 3) << 4) |
444 dtable[((igroup[1] & 0xF) << 2) |
446 ogroup[3] = dtable[igroup[2] & 0x3F];
449 * Replace characters in output stream with "=" pad
450 * characters if fewer than three characters were
451 * read from the end of the input stream.
460 for (i = 0; i < 4; i++) {
465 newlen = *destlen + *destlen / 2;
466 newbuf = (char*) malloc(newlen);
467 memcpy(newbuf, dest, *destlen);
468 *pdest = dest = newbuf;
471 dest[dpos++] = ogroup[i];
475 if ( (linebreaks) && (thisline > 70) ) {
476 if (dpos + 3 > *destlen)
480 newlen = *destlen + *destlen / 2;
481 newbuf = (char*) malloc(newlen);
482 memcpy(newbuf, dest, *destlen);
483 *pdest = dest = newbuf;
493 if ( (linebreaks) && (thisline > 70) ) {
494 if (dpos + 3 > *destlen)
498 newlen = *destlen + 5;
499 newbuf = (char*) malloc(newlen);
500 memcpy(newbuf, dest, *destlen);
501 *pdest = dest = newbuf;
514 * \brief Convert base64-encoded to binary.
515 * It will stop after reading 'length' bytes.
517 * \param dest The destination buffer
518 * \param source The base64 data to be decoded.
519 * \param length The number of bytes to decode.
520 * \return The actual length of the decoded data.
522 int CtdlDecodeBase64(char *dest, const char *source, size_t length)
528 for (i = 0; i < 255; i++) {
531 for (i = 'A'; i <= 'Z'; i++) {
532 dtable[i] = 0 + (i - 'A');
534 for (i = 'a'; i <= 'z'; i++) {
535 dtable[i] = 26 + (i - 'a');
537 for (i = '0'; i <= '9'; i++) {
538 dtable[i] = 52 + (i - '0');
544 /**CONSTANTCONDITION*/ while (TRUE) {
545 byte a[4], b[4], o[3];
547 for (i = 0; i < 4; i++) {
548 if (spos >= length) {
559 if (dtable[c] & 0x80) {
560 /** Ignoring errors: discard invalid character */
565 b[i] = (byte) dtable[c];
567 o[0] = (b[0] << 2) | (b[1] >> 4);
568 o[1] = (b[1] << 4) | (b[2] >> 2);
569 o[2] = (b[2] << 6) | b[3];
570 i = a[2] == '=' ? 1 : (a[3] == '=' ? 2 : 3);
587 * \brief Generate a new, globally unique UID parameter for a calendar etc. object
589 * \param buf String buffer into which our newly created UUID should be placed
591 void generate_uuid(char *buf) {
594 sprintf(buf, "%s-%lx-%lx-%x",
595 serv_info.serv_nodename,
604 * \brief Local replacement for controversial C library function that generates
605 * names for temporary files. Included to shut up compiler warnings.
606 * \todo return a fd to the file instead of the name for security reasons
607 * \param name the created filename
608 * \param len the length of the filename
610 void CtdlMakeTempFileName(char *name, int len) {
613 while (i++, i < 100) {
614 snprintf(name, len, "/tmp/ctdl.%04x.%04x",
618 if (!access(name, F_OK)) {
627 * \brief case-insensitive substring search
629 * This uses the Boyer-Moore search algorithm and is therefore quite fast.
630 * The code is roughly based on the strstr() replacement from 'tin' written
633 * \param text String to be searched
634 * \param pattern String to search for
636 char *bmstrcasestr(char *text, char *pattern) {
638 register unsigned char *p, *t;
639 register int i, j, *delta;
645 textlen = strlen (text);
646 patlen = strlen (pattern);
648 /* algorithm fails if pattern is empty */
649 if ((p1 = patlen) == 0)
652 /* code below fails (whenever i is unsigned) if pattern too long */
658 for (i = 0; i <= 255; i++)
660 for (p = (unsigned char *) pattern, i = p1; --i > 0;)
661 delta[tolower(*p++)] = i;
664 * From now on, we want patlen - 1.
665 * In the loop below, p points to the end of the pattern,
666 * t points to the end of the text to be tested against the
667 * pattern, and i counts the amount of text remaining, not
668 * including the part to be tested.
671 p = (unsigned char *) pattern + p1;
672 t = (unsigned char *) text + p1;
673 i = textlen - patlen;
675 if (tolower(p[0]) == tolower(t[0])) {
676 if (strncasecmp ((const char *)(p - p1), (const char *)(t - p1), p1) == 0) {
677 return ((char *)t - p1);
680 j = delta[tolower(t[0])];