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)
65 * brief a string tokenizer
66 * \param dest destination string
67 * \param source the string to grab tokens from
68 * \param parmnum the n'th token to grab
69 * \param separator the tokenizer string
70 * \param maxlen the length of dest
72 void extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen)
75 const char *s; /* source */
81 /* Locate desired parameter */
83 while (count < parmnum) {
84 /* End of string, bail! */
89 if (*s == separator) {
94 if (!s) return; /* Parameter not found */
96 for (d = dest; *s && *s != separator && ++len<maxlen; s++, d++) {
105 * \brief a tokenizer that kills, maims, and destroys
106 * \param source the string to process
107 * \param parmnum which token to kill
108 * \param separator the tokenizer string
110 void remove_token(char *source, int parmnum, char separator)
122 slen = strlen(source);
128 ( (i < slen) && (end == -1) );
130 if ((start < 0) && (curr_parm == parmnum)) {
134 if ((end < 0) && (curr_parm == (parmnum + 1))) {
138 if (source[i] == separator) {
146 memmove(&source[start], &source[end], slen - end + 1);
153 * \brief extract an int parm w/o supplying a buffer
154 * \param source the string to locate the int in
155 * \param parmnum the n'th token to grab the int from
156 * \return the integer
158 int extract_int(const char *source, int parmnum)
162 extract_token(buf, source, parmnum, '|', sizeof buf);
167 * \brief extract an long parm w/o supplying a buffer
168 * \param source string to examine
169 * \param parmnum n'th token to search long in
170 * \return the found long value
172 long extract_long(const char *source, int parmnum)
176 extract_token(buf, source, parmnum, '|', sizeof buf);
186 * \brief check for the presence of a character within a string (returns count)
187 * \param st the string to examine
188 * \param ch the char to search
189 * \return the position inside of st
191 int haschar(char *st,char ch)
196 for (a = 0; a < len; ++a)
204 * \brief Utility function to "readline" from memory
205 * \param start Location in memory from which we are reading.
206 * \param buf the buffer to place the string in.
207 * \param maxlen Size of string buffer
208 * \return Pointer to the source memory right after we stopped reading.
210 char *memreadline(char *start, char *buf, int maxlen)
214 int len = 0; /**< tally our own length to avoid strlen() delays */
217 memset(buf, 0, maxlen);
221 if ((len + 1 < (maxlen)) && (ch != 13) && (ch != 10)) {
225 if ((ch == 10) || (ch == 0)) {
234 * \brief searches for a paternn within asearch string
235 * \param search the string to search
236 * \param patn the pattern to find in string
237 * \returns position in string
239 int pattern2(char *search, char *patn)
243 len = strlen (search);
244 plen = strlen (patn);
245 for (a = 0; a < len; ++a) {
246 if (!strncasecmp(&search[a], patn, plen))
254 * \brief Strip leading and trailing spaces from a string; with premeasured and adjusted length.
255 * \param buf the string to modify
256 * \param len length of the string.
258 void stripltlen(char *buf, int *len)
261 if (*len == 0) return;
262 while ((*len > delta) && (isspace(buf[delta]))){
265 memmove (buf, &buf[delta], *len - delta + 1);
268 if (*len == 0) return;
269 while (isspace(buf[(*len) - 1])){
270 buf[--(*len)] = '\0';
275 * \brief Strip leading and trailing spaces from a string
276 * \param buf the string to modify
278 void striplt(char *buf)
282 stripltlen(buf, &len);
287 * \brief Determine whether the specified message number is contained within the
290 * \param mset Message set string
291 * \param msgnum Message number we are looking for
293 * \return Nonzero if the specified message number is in the specified message set string.
295 int is_msg_in_mset(char *mset, long msgnum) {
298 char setstr[SIZ], lostr[SIZ], histr[SIZ]; /* was 1024 */
302 * Now set it for all specified messages.
304 num_sets = num_tokens(mset, ',');
305 for (s=0; s<num_sets; ++s) {
306 extract_token(setstr, mset, s, ',', sizeof setstr);
308 extract_token(lostr, setstr, 0, ':', sizeof lostr);
309 if (num_tokens(setstr, ':') >= 2) {
310 extract_token(histr, setstr, 1, ':', sizeof histr);
311 if (!strcmp(histr, "*")) {
312 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
316 strcpy(histr, lostr);
321 if ((msgnum >= lo) && (msgnum <= hi)) return(1);
330 * \brief Strip a boundarized substring out of a string
331 * (for example, remove
332 * parentheses and anything inside them).
334 * This improved version can strip out *multiple* boundarized substrings.
335 * \param str the string to process
336 * \param leftboundary the boundary character on the left side of the target string
337 * \param rightboundary the boundary character on the right side of the target string
339 void stripout(char *str, char leftboundary, char rightboundary)
344 int len = strlen(str);
350 for (a = 0; a < len; ++a) {
351 if (str[a] == leftboundary)
353 if (str[a] == rightboundary)
357 if ((lb > 0) && (rb > lb)) {
358 memmove(&str[lb - 1], &str[rb + 1], len - rb);
359 len -= (rb - lb + 2);
362 } while ((lb > 0) && (rb > lb));
369 * \brief Replacement for sleep() that uses select() in order to avoid SIGALRM
370 * \param seconds how many seconds should we sleep?
372 void sleeeeeeeeeep(int seconds)
378 select(0, NULL, NULL, NULL, &tv);
384 * \brief encode a string into base64 to for example tunnel it through mail transport
385 * CtdlDecodeBase64() and CtdlEncodeBase64() are adaptations of code by
386 * John Walker, copied over from the Citadel server.
387 * \param dest encrypted string
388 * \param source the string to encrypt
389 * \param sourcelen the length of the source data (may contain string terminators)
392 void CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks)
394 int i, hiteof = FALSE;
399 /** Fill dtable with character encodings. */
401 for (i = 0; i < 26; i++) {
403 dtable[26 + i] = 'a' + i;
405 for (i = 0; i < 10; i++) {
406 dtable[52 + i] = '0' + i;
412 byte igroup[3], ogroup[4];
415 igroup[0] = igroup[1] = igroup[2] = 0;
416 for (n = 0; n < 3; n++) {
417 if (spos >= sourcelen) {
422 igroup[n] = (byte) c;
425 ogroup[0] = dtable[igroup[0] >> 2];
427 dtable[((igroup[0] & 3) << 4) |
430 dtable[((igroup[1] & 0xF) << 2) |
432 ogroup[3] = dtable[igroup[2] & 0x3F];
435 * Replace characters in output stream with "=" pad
436 * characters if fewer than three characters were
437 * read from the end of the input stream.
446 for (i = 0; i < 4; i++) {
447 dest[dpos++] = ogroup[i];
451 if ( (linebreaks) && (thisline > 70) ) {
459 if ( (linebreaks) && (thisline > 70) ) {
469 * \brief Convert base64-encoded to binary.
470 * It will stop after reading 'length' bytes.
472 * \param dest The destination buffer
473 * \param source The base64 data to be decoded.
474 * \param length The number of bytes to decode.
475 * \return The actual length of the decoded data.
477 int CtdlDecodeBase64(char *dest, const char *source, size_t length)
483 for (i = 0; i < 255; i++) {
486 for (i = 'A'; i <= 'Z'; i++) {
487 dtable[i] = 0 + (i - 'A');
489 for (i = 'a'; i <= 'z'; i++) {
490 dtable[i] = 26 + (i - 'a');
492 for (i = '0'; i <= '9'; i++) {
493 dtable[i] = 52 + (i - '0');
499 /**CONSTANTCONDITION*/ while (TRUE) {
500 byte a[4], b[4], o[3];
502 for (i = 0; i < 4; i++) {
503 if (spos >= length) {
514 if (dtable[c] & 0x80) {
515 /** Ignoring errors: discard invalid character */
520 b[i] = (byte) dtable[c];
522 o[0] = (b[0] << 2) | (b[1] >> 4);
523 o[1] = (b[1] << 4) | (b[2] >> 2);
524 o[2] = (b[2] << 6) | b[3];
525 i = a[2] == '=' ? 1 : (a[3] == '=' ? 2 : 3);
542 * \brief Generate a new, globally unique UID parameter for a calendar etc. object
544 * \param buf String buffer into which our newly created UUID should be placed
546 void generate_uuid(char *buf) {
549 sprintf(buf, "%s-%lx-%lx-%x",
550 serv_info.serv_nodename,
559 * \brief Local replacement for controversial C library function that generates
560 * names for temporary files. Included to shut up compiler warnings.
561 * \todo return a fd to the file instead of the name for security reasons
562 * \param name the created filename
563 * \param len the length of the filename
565 void CtdlMakeTempFileName(char *name, int len) {
568 while (i++, i < 100) {
569 snprintf(name, len, "/tmp/ctdl.%04x.%04x",
573 if (!access(name, F_OK)) {
582 * \brief case-insensitive substring search
584 * This uses the Boyer-Moore search algorithm and is therefore quite fast.
585 * The code is roughly based on the strstr() replacement from 'tin' written
588 * \param text String to be searched
589 * \param pattern String to search for
591 char *bmstrcasestr(char *text, char *pattern) {
593 register unsigned char *p, *t;
594 register int i, j, *delta;
600 textlen = strlen (text);
601 patlen = strlen (pattern);
603 /* algorithm fails if pattern is empty */
604 if ((p1 = patlen) == 0)
607 /* code below fails (whenever i is unsigned) if pattern too long */
613 for (i = 0; i <= 255; i++)
615 for (p = (unsigned char *) pattern, i = p1; --i > 0;)
616 delta[tolower(*p++)] = i;
619 * From now on, we want patlen - 1.
620 * In the loop below, p points to the end of the pattern,
621 * t points to the end of the text to be tested against the
622 * pattern, and i counts the amount of text remaining, not
623 * including the part to be tested.
626 p = (unsigned char *) pattern + p1;
627 t = (unsigned char *) text + p1;
628 i = textlen - patlen;
630 if (tolower(p[0]) == tolower(t[0])) {
631 if (strncasecmp ((const char *)(p - p1), (const char *)(t - p1), p1) == 0) {
632 return ((char *)t - p1);
635 j = delta[tolower(t[0])];