/*
- * tools.c -- Miscellaneous routines
+ * $Id$
+ */
+/**
+ * \defgroup MiscRout Miscellaneous routines
+ * \ingroup tools
*/
-
-
-#include <ctype.h>
-#include <stdlib.h>
-#include <unistd.h>
-#include <stdio.h>
-#include <fcntl.h>
-#include <signal.h>
-#include <sys/types.h>
-#include <sys/wait.h>
-#include <sys/socket.h>
-#include <sys/time.h>
-#include <limits.h>
-#include <netinet/in.h>
-#include <netdb.h>
-#include <string.h>
-#include <pwd.h>
-#include <errno.h>
-#include <stdarg.h>
-#include <pthread.h>
-#include <signal.h>
-#include <sys/time.h>
+/*@{*/
#include "webcit.h"
#include "webserver.h"
-char *ascmonths[] = {
- "Jan", "Feb", "Mar", "Apr", "May", "Jun",
- "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
-};
+typedef unsigned char byte; /**< byte data type */
-char *ascdays[] = {
- "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"
-};
+#define FALSE 0 /**< no. */
+#define TRUE 1 /**< yes. */
+static byte dtable[256]; /**< base64 encode / decode table */
+/**
+ * \brief sanitize strncopy.
+ * \param dest destination string
+ * \param src source string
+ * \param n length of source to copy
+ * \return result string
+ */
char *safestrncpy(char *dest, const char *src, size_t n)
{
if (dest == NULL || src == NULL) {
- lprintf(1, "safestrncpy: NULL argument\n");
abort();
}
strncpy(dest, src, n);
-/*
- * num_tokens() - discover number of parameters/tokens in a string
+/**
+ * \brief discover number of parameters/tokens in a string
+ * \param source string to inspect
+ * \param tok seperation token
+ * \return number of tokenized parts found
*/
-int num_tokens(char *source, char tok) {
+int num_tokens(char *source, char tok)
+{
int a;
int count = 1;
- if (source == NULL) return(0);
- for (a=0; a<strlen(source); ++a) {
- if (source[a]==tok) ++count;
+ if (source == NULL)
+ return (0);
+ for (a = 0; a < strlen(source); ++a) {
+ if (source[a] == tok)
+ ++count;
}
- return(count);
+ return (count);
}
-/*
- * extract_token() - a smarter string tokenizer
+/**
+ * brief a string tokenizer
+ * \param dest destination string
+ * \param source the string to grab tokens from
+ * \param parmnum the n'th token to grab
+ * \param separator the tokenizer string
+ * \param maxlen the length of dest
*/
-void extract_token(char *dest, char *source, int parmnum, char separator)
+void extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen)
{
- int i;
- int len;
- int curr_parm;
-
- strcpy(dest,"");
- len = 0;
- curr_parm = 0;
-
- if (strlen(source)==0) {
- return;
- }
-
- for (i=0; i<strlen(source); ++i) {
- if (source[i]==separator) {
- ++curr_parm;
+ char *d; /* dest */
+ const char *s; /* source */
+ int count = 0;
+ int len = 0;
+
+ dest[0] = 0;
+
+ /* Locate desired parameter */
+ s = source;
+ while (count < parmnum) {
+ /* End of string, bail! */
+ if (!*s) {
+ s = NULL;
+ break;
}
- else if (curr_parm == parmnum) {
- dest[len+1] = 0;
- dest[len++] = source[i];
+ if (*s == separator) {
+ count++;
}
+ s++;
}
+ if (!s) return; /* Parameter not found */
+
+ for (d = dest; *s && *s != separator && ++len<maxlen; s++, d++) {
+ *d = *s;
+ }
+ *d = 0;
}
-/*
- * remove_token() - a tokenizer that kills, maims, and destroys
+/**
+ * \brief a tokenizer that kills, maims, and destroys
+ * \param source the string to process
+ * \param parmnum which token to kill
+ * \param separator the tokenizer string
*/
void remove_token(char *source, int parmnum, char separator)
{
start = (-1);
end = (-1);
- if (strlen(source)==0) {
+ if (strlen(source) == 0) {
return;
- }
+ }
- for (i=0; i<strlen(source); ++i) {
- if ( (start < 0) && (curr_parm == parmnum) ) {
+ for (i = 0; i < strlen(source); ++i) {
+ if ((start < 0) && (curr_parm == parmnum)) {
start = i;
}
- if ( (end < 0) && (curr_parm == (parmnum+1)) ) {
+ if ((end < 0) && (curr_parm == (parmnum + 1))) {
end = i;
}
- if (source[i]==separator) {
+ if (source[i] == separator) {
++curr_parm;
}
}
- if (end < 0) end = strlen(source);
+ if (end < 0)
+ end = strlen(source);
strcpy(&source[start], &source[end]);
}
-/*
- * extract_int() - extract an int parm w/o supplying a buffer
+/**
+ * \brief extract an int parm w/o supplying a buffer
+ * \param source the string to locate the int in
+ * \param parmnum the n'th token to grab the int from
+ * \return the integer
*/
-int extract_int(char *source, int parmnum)
+int extract_int(const char *source, int parmnum)
{
- char buf[SIZ];
+ char buf[32];
- extract_token(buf, source, parmnum, '|');
+ extract_token(buf, source, parmnum, '|', sizeof buf);
return(atoi(buf));
}
-/*
- * extract_long() - extract an long parm w/o supplying a buffer
+/**
+ * \brief extract an long parm w/o supplying a buffer
+ * \param source string to examine
+ * \param parmnum n'th token to search long in
+ * \return the found long value
*/
-long extract_long(char *source, long int parmnum)
+long extract_long(const char *source, int parmnum)
{
- char buf[SIZ];
+ char buf[32];
- extract_token(buf, source, parmnum, '|');
+ extract_token(buf, source, parmnum, '|', sizeof buf);
return(atol(buf));
}
+/**
+ * \brief check for the presence of a character within a string (returns count)
+ * \param st the string to examine
+ * \param ch the char to search
+ * \return the position inside of st
+ */
+int haschar(char *st,char ch)
+{
+ int a, b;
+ b = 0;
+ for (a = 0; a < strlen(st); ++a)
+ if (st[a] == ch)
+ ++b;
+ return (b);
+}
+/**
+ * \brief Utility function to "readline" from memory
+ * \param start Location in memory from which we are reading.
+ * \param buf the buffer to place the string in.
+ * \param maxlen Size of string buffer
+ * \return Pointer to the source memory right after we stopped reading.
+ */
+char *memreadline(char *start, char *buf, int maxlen)
+{
+ char ch;
+ char *ptr;
+ int len = 0; /**< tally our own length to avoid strlen() delays */
+
+ ptr = start;
+ memset(buf, 0, maxlen);
+
+ while (1) {
+ ch = *ptr++;
+ if ((len < (maxlen - 1)) && (ch != 13) && (ch != 10)) {
+ buf[strlen(buf) + 1] = 0;
+ buf[strlen(buf)] = ch;
+ ++len;
+ }
+ if ((ch == 10) || (ch == 0)) {
+ return ptr;
+ }
+ }
+}
+/**
+ * \brief searches for a paternn within asearch string
+ * \param search the string to search
+ * \param patn the pattern to find in string
+ * \returns position in string
+ */
+int pattern2(char *search, char *patn)
+{
+ int a;
+ for (a = 0; a < strlen(search); ++a) {
+ if (!strncasecmp(&search[a], patn, strlen(patn)))
+ return (a);
+ }
+ return (-1);
+}
-
-
-/*
- * check for the presence of a character within a string (returns count)
+/**
+ * \brief Strip leading and trailing spaces from a string
+ * \param buf the string to modify
*/
-int haschar(st, ch)
-char st[];
-char ch;
+void striplt(char *buf)
{
- int a, b;
- b = 0;
- for (a = 0; a < strlen(st); ++a)
- if (st[a] == ch)
- ++b;
- return (b);
+ if (strlen(buf) == 0) return;
+ while ((strlen(buf) > 0) && (isspace(buf[0])))
+ strcpy(buf, &buf[1]);
+ if (strlen(buf) == 0) return;
+ while (isspace(buf[strlen(buf) - 1]))
+ buf[strlen(buf) - 1] = 0;
}
-/*
- * Format a date/time stamp for output
+/**
+ * \brief Determine whether the specified message number is contained within the
+ * specified set.
+ *
+ * \param mset Message set string
+ * \param msgnum Message number we are looking for
+ *
+ * \return Nonzero if the specified message number is in the specified message set string.
*/
-void fmt_date(char *buf, time_t thetime) {
- struct tm *tm;
-
- strcpy(buf, "");
- tm = localtime(&thetime);
-
- sprintf(buf, "%s %d %d %2d:%02d%s",
- ascmonths[tm->tm_mon],
- tm->tm_mday,
- tm->tm_year + 1900,
- ( (tm->tm_hour > 12) ? (tm->tm_hour - 12) : (tm->tm_hour) ),
- tm->tm_min,
- ( (tm->tm_hour > 12) ? "pm" : "am" )
- );
+int is_msg_in_mset(char *mset, long msgnum) {
+ int num_sets;
+ int s;
+ char setstr[SIZ], lostr[SIZ], histr[SIZ]; /* was 1024 */
+ long lo, hi;
+
+ /*
+ * Now set it for all specified messages.
+ */
+ num_sets = num_tokens(mset, ',');
+ for (s=0; s<num_sets; ++s) {
+ extract_token(setstr, mset, s, ',', sizeof setstr);
+
+ extract_token(lostr, setstr, 0, ':', sizeof lostr);
+ if (num_tokens(setstr, ':') >= 2) {
+ extract_token(histr, setstr, 1, ':', sizeof histr);
+ if (!strcmp(histr, "*")) {
+ snprintf(histr, sizeof histr, "%ld", LONG_MAX);
+ }
+ }
+ else {
+ strcpy(histr, lostr);
+ }
+ lo = atol(lostr);
+ hi = atol(histr);
+
+ if ((msgnum >= lo) && (msgnum <= hi)) return(1);
+ }
+
+ return(0);
}
+/**
+ * \brief Strip a boundarized substring out of a string
+ * (for example, remove
+ * parentheses and anything inside them).
+ *
+ * This improved version can strip out *multiple* boundarized substrings.
+ * \param str the string to process
+ * \param leftboundary the boundary character on the left side of the target string
+ * \param rightboundary the boundary character on the right side of the target string
+ */
+void stripout(char *str, char leftboundary, char rightboundary)
+{
+ int a;
+ int lb = (-1);
+ int rb = (-1);
+
+ do {
+ lb = (-1);
+ rb = (-1);
+
+ for (a = 0; a < strlen(str); ++a) {
+ if (str[a] == leftboundary)
+ lb = a;
+ if (str[a] == rightboundary)
+ rb = a;
+ }
+
+ if ((lb > 0) && (rb > lb)) {
+ strcpy(&str[lb - 1], &str[rb + 1]);
+ }
-/*
- * Format a date/time stamp to the format used in HTTP headers
+ } while ((lb > 0) && (rb > lb));
+
+}
+
+
+
+/**
+ * \brief Replacement for sleep() that uses select() in order to avoid SIGALRM
+ * \param seconds how many seconds should we sleep?
*/
-void httpdate(char *buf, time_t thetime) {
- struct tm *tm;
-
- strcpy(buf, "");
- tm = localtime(&thetime);
-
- sprintf(buf, "%s, %02d %s %4d %02d:%02d:%02d",
- ascdays[tm->tm_wday],
- tm->tm_mday,
- ascmonths[tm->tm_mon],
- tm->tm_year + 1900,
- tm->tm_hour,
- tm->tm_min,
- tm->tm_sec
- );
+void sleeeeeeeeeep(int seconds)
+{
+ struct timeval tv;
+
+ tv.tv_sec = seconds;
+ tv.tv_usec = 0;
+ select(0, NULL, NULL, NULL, &tv);
}
+/**
+ * \brief encode a string into base64 to for example tunnel it through mail transport
+ * CtdlDecodeBase64() and CtdlEncodeBase64() are adaptations of code by
+ * John Walker, copied over from the Citadel server.
+ * \param dest encrypted string
+ * \param source the string to encrypt
+ * \param sourcelen the length of the source data (may contain string terminators)
+ */
+void CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen)
+{
+ int i, hiteof = FALSE;
+ int spos = 0;
+ int dpos = 0;
+ int thisline = 0;
-/*
- * Utility function to "readline" from memory
- * (returns new pointer)
+ /** Fill dtable with character encodings. */
+
+ for (i = 0; i < 26; i++) {
+ dtable[i] = 'A' + i;
+ dtable[26 + i] = 'a' + i;
+ }
+ for (i = 0; i < 10; i++) {
+ dtable[52 + i] = '0' + i;
+ }
+ dtable[62] = '+';
+ dtable[63] = '/';
+
+ while (!hiteof) {
+ byte igroup[3], ogroup[4];
+ int c, n;
+
+ igroup[0] = igroup[1] = igroup[2] = 0;
+ for (n = 0; n < 3; n++) {
+ if (spos >= sourcelen) {
+ hiteof = TRUE;
+ break;
+ }
+ c = source[spos++];
+ igroup[n] = (byte) c;
+ }
+ if (n > 0) {
+ ogroup[0] = dtable[igroup[0] >> 2];
+ ogroup[1] =
+ dtable[((igroup[0] & 3) << 4) |
+ (igroup[1] >> 4)];
+ ogroup[2] =
+ dtable[((igroup[1] & 0xF) << 2) |
+ (igroup[2] >> 6)];
+ ogroup[3] = dtable[igroup[2] & 0x3F];
+
+ /**
+ * Replace characters in output stream with "=" pad
+ * characters if fewer than three characters were
+ * read from the end of the input stream.
+ */
+
+ if (n < 3) {
+ ogroup[3] = '=';
+ if (n < 2) {
+ ogroup[2] = '=';
+ }
+ }
+ for (i = 0; i < 4; i++) {
+ dest[dpos++] = ogroup[i];
+ dest[dpos] = 0;
+ }
+ thisline += 4;
+ if (thisline > 70) {
+ dest[dpos++] = '\r';
+ dest[dpos++] = '\n';
+ dest[dpos] = 0;
+ thisline = 0;
+ }
+ }
+ }
+ if (thisline > 70) {
+ dest[dpos++] = '\r';
+ dest[dpos++] = '\n';
+ dest[dpos] = 0;
+ thisline = 0;
+ }
+}
+
+
+/**
+ * \brief Convert base64-encoded to binary.
+ * It will stop after reading 'length' bytes.
+ *
+ * \param dest The destination buffer
+ * \param source The base64 data to be decoded.
+ * \param length The number of bytes to decode.
+ * \return The actual length of the decoded data.
*/
-char *memreadline(char *start, char *buf, int maxlen)
+int CtdlDecodeBase64(char *dest, const char *source, size_t length)
{
- char ch;
- char *ptr;
- int len = 0; /* tally our own length to avoid strlen() delays */
-
- ptr = start;
- memset(buf, 0, maxlen);
-
- while (1) {
- ch = *ptr++;
- if ( (len < (maxlen - 1)) && (ch != 13) && (ch != 10) ) {
- buf[strlen(buf) + 1] = 0;
- buf[strlen(buf)] = ch;
- ++len;
- }
- if ((ch == 10) || (ch == 0)) {
- return ptr;
- }
- }
+ int i, c;
+ int dpos = 0;
+ int spos = 0;
+
+ for (i = 0; i < 255; i++) {
+ dtable[i] = 0x80;
+ }
+ for (i = 'A'; i <= 'Z'; i++) {
+ dtable[i] = 0 + (i - 'A');
+ }
+ for (i = 'a'; i <= 'z'; i++) {
+ dtable[i] = 26 + (i - 'a');
+ }
+ for (i = '0'; i <= '9'; i++) {
+ dtable[i] = 52 + (i - '0');
+ }
+ dtable['+'] = 62;
+ dtable['/'] = 63;
+ dtable['='] = 0;
+
+ /**CONSTANTCONDITION*/ while (TRUE) {
+ byte a[4], b[4], o[3];
+
+ for (i = 0; i < 4; i++) {
+ if (spos >= length) {
+ return (dpos);
+ }
+ c = source[spos++];
+
+ if (c == 0) {
+ if (i > 0) {
+ return (dpos);
+ }
+ return (dpos);
+ }
+ if (dtable[c] & 0x80) {
+ /** Ignoring errors: discard invalid character */
+ i--;
+ continue;
+ }
+ a[i] = (byte) c;
+ b[i] = (byte) dtable[c];
+ }
+ o[0] = (b[0] << 2) | (b[1] >> 4);
+ o[1] = (b[1] << 4) | (b[2] >> 2);
+ o[2] = (b[2] << 6) | b[3];
+ i = a[2] == '=' ? 1 : (a[3] == '=' ? 2 : 3);
+ if (i >= 1)
+ dest[dpos++] = o[0];
+ if (i >= 2)
+ dest[dpos++] = o[1];
+ if (i >= 3)
+ dest[dpos++] = o[2];
+ dest[dpos] = 0;
+ if (i < 3) {
+ return (dpos);
+ }
+ }
}
+/**
+ * \brief Generate a new, globally unique UID parameter for a calendar etc. object
+ *
+ * \param buf String buffer into which our newly created UUID should be placed
+ */
+void generate_uuid(char *buf) {
+ static int seq = 0;
+
+ sprintf(buf, "%s-%lx-%x-%x",
+ serv_info.serv_nodename,
+ (long)time(NULL),
+ getpid(),
+ (seq++)
+ );
+}
+
+
+/**
+ * \brief Local replacement for controversial C library function that generates
+ * names for temporary files. Included to shut up compiler warnings.
+ * \todo return a fd to the file instead of the name for security reasons
+ * \param name the created filename
+ * \param len the length of the filename
+ */
+void CtdlMakeTempFileName(char *name, int len) {
+ int i = 0;
+
+ while (i++, i < 100) {
+ snprintf(name, len, "/tmp/ctdl.%04x.%04x",
+ getpid(),
+ rand()
+ );
+ if (!access(name, F_OK)) {
+ return;
+ }
+ }
+}
+
+
+/*@}*/
projects / citadel.git / blobdiff