X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=webcit%2Ftools.c;h=f83a7d863bf60360d99fef3fe986a869b48a1909;hb=6ea3e52ceedf0dc7ab13d2e48987822eee61e8ee;hp=3f445c9b07892e47718f60b2601d5fdc88acad2e;hpb=3d64a152643ab2f0e98550b63c7e93dfa6a72ac7;p=citadel.git

diff --git a/webcit/tools.c b/webcit/tools.c
index 3f445c9b0..f83a7d863 100644
--- a/webcit/tools.c
+++ b/webcit/tools.c
@@ -1,48 +1,30 @@
 /*
  * $Id$
- *
- * Miscellaneous routines 
+ */
+/**
+ * \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"
 
-typedef unsigned char byte;
 
-#define FALSE 0
-#define TRUE 1
+typedef unsigned char byte; /**< byte data type */
 
-char *ascmonths[] = {
-	"Jan", "Feb", "Mar", "Apr", "May", "Jun",
-	"Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
-};
+#define FALSE 0 /**< no. */
+#define TRUE 1  /**< yes. */
 
-char *ascdays[] = {
-	"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"
-};
-
-static byte dtable[256];	/* base64 encode / decode table */
+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) {
@@ -55,65 +37,79 @@ char *safestrncpy(char *dest, const char *src, size_t 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 a;
 	int count = 1;
+	char *ptr = source;
 
-	if (source == NULL)
+	if (source == NULL) {
 		return (0);
-	for (a = 0; a < strlen(source); ++a) {
-		if (source[a] == tok)
+	}
+
+	while (*ptr != '\0') {
+		if (*ptr++ == tok) {
 			++count;
+		}
 	}
+	
 	return (count);
 }
 
 /*
  * extract_token() - a string tokenizer
+ * returns -1 if not found, or length of token.
  */
-void extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen)
+long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen)
 {
-	char *d;		/* dest */
-	const char *s;		/* source */
-	int count = 0;
-	int len = 0;
+	const char *s;			/* source */
+	int len = 0;			/* running total length of extracted string */
+	int current_token = 0;		/* token currently being processed */
+
+	s = source;
+
+	if (dest == NULL) {
+		return(-1);
+	}
 
 	dest[0] = 0;
 
-	/* Locate desired parameter */
-	s = source;
-	while (count < parmnum) {
-		/* End of string, bail! */
-		if (!*s) {
-			s = NULL;
-			break;
-		}
+	if (s == NULL) {
+		return(-1);
+	}
+
+	while (*s) {
 		if (*s == separator) {
-			count++;
+			++current_token;
+		}
+		else if ( (current_token == parmnum) && (len < maxlen) ) {
+			dest[len] = *s;
+			++len;
 		}
-		s++;
+		++s;
 	}
-	if (!s) return;		/* Parameter not found */
 
-	for (d = dest; *s && *s != separator && ++len<maxlen; s++, d++) {
-		*d = *s;
-	}
-	*d = 0;
+	dest[len] = 0;
+	if (current_token < parmnum) return(-1);
+	return(len);
 }
 
 
-
-/*
- * 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)
 {
 	int i;
-	int len;
+	int len, slen;
 	int curr_parm;
 	int start, end;
 
@@ -122,11 +118,14 @@ void remove_token(char *source, int parmnum, char separator)
 	start = (-1);
 	end = (-1);
 
-	if (strlen(source) == 0) {
+	slen = strlen(source);
+	if (slen == 0) {
 		return;
 	}
 
-	for (i = 0; i < strlen(source); ++i) {
+	for (i = 0; 
+	     ( (i < slen)  && (end == -1) ); 
+	     ++i) {
 		if ((start < 0) && (curr_parm == parmnum)) {
 			start = i;
 		}
@@ -141,16 +140,19 @@ void remove_token(char *source, int parmnum, char separator)
 	}
 
 	if (end < 0)
-		end = strlen(source);
+		end = slen;
 
-	strcpy(&source[start], &source[end]);
+	memmove(&source[start], &source[end], slen - end + 1);
 }
 
 
 
 
-/*
- * 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(const char *source, int parmnum)
 {
@@ -160,8 +162,11 @@ int extract_int(const char *source, int parmnum)
 	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(const char *source, int parmnum)
 {
@@ -176,112 +181,45 @@ long extract_long(const char *source, int parmnum)
 
 
 
-/*
- * check for the presence of a character within a string (returns count)
+/**
+ * \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(st, ch)
-char st[];
-char ch;
+int haschar(char *st,char ch)
 {
-	int a, b;
+	int a, b, len;
 	b = 0;
-	for (a = 0; a < strlen(st); ++a)
+	len = strlen(st);
+	for (a = 0; a < len; ++a)
 		if (st[a] == ch)
 			++b;
 	return (b);
 }
 
 
-/*
- * Format a date/time stamp for output 
- */
-void fmt_date(char *buf, time_t thetime)
-{
-	struct tm *tm;
-	int hour;
-
-	buf[0] = 0;
-	tm = localtime(&thetime);
-	hour = tm->tm_hour;
-	if (hour == 0)
-		hour = 12;
-	else if (hour > 12)
-		hour = hour - 12;
-
-	sprintf(buf, "%s %d %d %2d:%02d%s",
-		ascmonths[tm->tm_mon],
-		tm->tm_mday,
-		tm->tm_year + 1900,
-		hour, tm->tm_min, ((tm->tm_hour >= 12) ? "pm" : "am")
-	    );
-}
-
-
-
-/*
- * Format TIME ONLY for output 
- */
-void fmt_time(char *buf, time_t thetime)
-{
-	struct tm *tm;
-	int hour;
-
-	buf[0] = 0;
-	tm = localtime(&thetime);
-	hour = tm->tm_hour;
-	if (hour == 0)
-		hour = 12;
-	else if (hour > 12)
-		hour = hour - 12;
-
-	sprintf(buf, "%d:%02d%s",
-		hour, tm->tm_min, ((tm->tm_hour > 12) ? "pm" : "am")
-	    );
-}
-
-
-
-
-/*
- * Format a date/time stamp to the format used in HTTP headers
- */
-void httpdate(char *buf, time_t thetime)
-{
-	struct tm *tm;
-
-	buf[0] = 0;
-	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);
-}
-
-
-
-
-
-/*
- * Utility function to "readline" from memory
- * (returns new pointer)
+/** 
+ * \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 */
+	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 ((len + 1 < (maxlen)) && (ch != 13) && (ch != 10)) {
+			buf[len++] = ch;
+			buf[len] = 0;
 		}
 		if ((ch == 10) || (ch == 0)) {
 			return ptr;
@@ -291,37 +229,67 @@ char *memreadline(char *start, char *buf, int maxlen)
 
 
 
-/*
- * pattern2()  -  searches for patn within search string, returns pos
+/**
+ * \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)))
+	int len, plen;
+	len = strlen (search);
+	plen = strlen (patn);
+	for (a = 0; a < len; ++a) {
+		if (!strncasecmp(&search[a], patn, plen))
 			return (a);
 	}
 	return (-1);
 }
 
 
-/*
- * Strip leading and trailing spaces from a string
+/**
+ * \brief Strip leading and trailing spaces from a string; with premeasured and adjusted length.
+ * \param buf the string to modify
+ * \param len length of the string. 
+ */
+void stripltlen(char *buf, int *len)
+{
+	int delta = 0;
+	if (*len == 0) return;
+	while ((*len > delta) && (isspace(buf[delta]))){
+		delta ++;
+	}
+	memmove (buf, &buf[delta], *len - delta + 1);
+	(*len) -=delta;
+
+	if (*len == 0) return;
+	while (isspace(buf[(*len) - 1])){
+		buf[--(*len)] = '\0';
+	}
+}
+
+/**
+ * \brief Strip leading and trailing spaces from a string
+ * \param buf the string to modify
  */
 void striplt(char *buf)
 {
-	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;
+	int len;
+	len = strlen(buf);
+	stripltlen(buf, &len);
 }
 
 
-/*
- * Determine whether the specified message number is contained within the
+/**
+ * \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.
  */
 int is_msg_in_mset(char *mset, long msgnum) {
 	int num_sets;
@@ -357,23 +325,28 @@ int is_msg_in_mset(char *mset, long msgnum) {
 
 
 
-/*
- * Strip a boundarized substring out of a string (for example, remove
+/**
+ * \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);
+	int len = strlen(str);
 
 	do {
 		lb = (-1);
 		rb = (-1);
 
-		for (a = 0; a < strlen(str); ++a) {
+		for (a = 0; a < len; ++a) {
 			if (str[a] == leftboundary)
 				lb = a;
 			if (str[a] == rightboundary)
@@ -381,7 +354,8 @@ void stripout(char *str, char leftboundary, char rightboundary)
 		}
 
 		if ((lb > 0) && (rb > lb)) {
-			strcpy(&str[lb - 1], &str[rb + 1]);
+			memmove(&str[lb - 1], &str[rb + 1], len - rb);
+			len -= (rb - lb + 2);
 		}
 
 	} while ((lb > 0) && (rb > lb));
@@ -390,8 +364,9 @@ void stripout(char *str, char leftboundary, char rightboundary)
 
 
 
-/*
- * Replacement for sleep() that uses select() in order to avoid SIGALRM
+/**
+ * \brief Replacement for sleep() that uses select() in order to avoid SIGALRM
+ * \param seconds how many seconds should we sleep?
  */
 void sleeeeeeeeeep(int seconds)
 {
@@ -404,19 +379,23 @@ void sleeeeeeeeeep(int seconds)
 
 
 
-/*
+/**
+ * \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)
+void CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks)
 {
 	int i, hiteof = FALSE;
 	int spos = 0;
 	int dpos = 0;
 	int thisline = 0;
 
-	/*  Fill dtable with character encodings.  */
+	/**  Fill dtable with character encodings.  */
 
 	for (i = 0; i < 26; i++) {
 		dtable[i] = 'A' + i;
@@ -451,9 +430,11 @@ void CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen)
 				   (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. */
+			/**
+			 * 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] = '=';
@@ -466,7 +447,7 @@ void CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen)
 				dest[dpos] = 0;
 			}
 			thisline += 4;
-			if (thisline > 70) {
+			if ( (linebreaks) && (thisline > 70) ) {
 				dest[dpos++] = '\r';
 				dest[dpos++] = '\n';
 				dest[dpos] = 0;
@@ -474,7 +455,7 @@ void CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen)
 			}
 		}
 	}
-	if (thisline > 70) {
+	if ( (linebreaks) && (thisline > 70) ) {
 		dest[dpos++] = '\r';
 		dest[dpos++] = '\n';
 		dest[dpos] = 0;
@@ -483,9 +464,14 @@ void CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen)
 }
 
 
-/* 
- * Convert base64-encoded to binary.  Returns the length of the decoded data.
+/**
+ * \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.
  */
 int CtdlDecodeBase64(char *dest, const char *source, size_t length)
 {
@@ -509,7 +495,7 @@ int CtdlDecodeBase64(char *dest, const char *source, size_t length)
 	dtable['/'] = 63;
 	dtable['='] = 0;
 
-	 /*CONSTANTCONDITION*/ while (TRUE) {
+	/**CONSTANTCONDITION*/ while (TRUE) {
 		byte a[4], b[4], o[3];
 
 		for (i = 0; i < 4; i++) {
@@ -525,7 +511,7 @@ int CtdlDecodeBase64(char *dest, const char *source, size_t length)
 				return (dpos);
 			}
 			if (dtable[c] & 0x80) {
-				/* Ignoring errors: discard invalid character. */
+				/** Ignoring errors: discard invalid character */
 				i--;
 				continue;
 			}
@@ -550,18 +536,112 @@ int CtdlDecodeBase64(char *dest, const char *source, size_t length)
 }
 
 
-/*
- * Generate a new, globally unique UID parameter for a calendar etc. object
+
+/**
+ * \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, "{%08x-%04x-%04x-%04x-%012x}",
-		(int)time(NULL),
-		(seq++),
-		getpid(),
-		rand(),
-		rand()
+	sprintf(buf, "%s-%lx-%lx-%x",
+		serv_info.serv_nodename,
+		(long)time(NULL),
+		(long)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;
+		}
+	}
+}
+
+
+
+/*
+ * \brief	case-insensitive substring search
+ *
+ *		This uses the Boyer-Moore search algorithm and is therefore quite fast.
+ *		The code is roughly based on the strstr() replacement from 'tin' written
+ *		by Urs Jannsen.
+ *
+ * \param	text	String to be searched
+ * \param	pattern	String to search for
+ */
+char *bmstrcasestr(char *text, char *pattern) {
+
+	register unsigned char *p, *t;
+	register int i, j, *delta;
+	register size_t p1;
+	int deltaspace[256];
+	size_t textlen;
+	size_t patlen;
+
+	textlen = strlen (text);
+	patlen = strlen (pattern);
+
+	/* algorithm fails if pattern is empty */
+	if ((p1 = patlen) == 0)
+		return (text);
+
+	/* code below fails (whenever i is unsigned) if pattern too long */
+	if (p1 > textlen)
+		return (NULL);
+
+	/* set up deltas */
+	delta = deltaspace;
+	for (i = 0; i <= 255; i++)
+		delta[i] = p1;
+	for (p = (unsigned char *) pattern, i = p1; --i > 0;)
+		delta[tolower(*p++)] = i;
+
+	/*
+	 * From now on, we want patlen - 1.
+	 * In the loop below, p points to the end of the pattern,
+	 * t points to the end of the text to be tested against the
+	 * pattern, and i counts the amount of text remaining, not
+	 * including the part to be tested.
+	 */
+	p1--;
+	p = (unsigned char *) pattern + p1;
+	t = (unsigned char *) text + p1;
+	i = textlen - patlen;
+	while(1) {
+		if (tolower(p[0]) == tolower(t[0])) {
+			if (strncasecmp ((const char *)(p - p1), (const char *)(t - p1), p1) == 0) {
+				return ((char *)t - p1);
+			}
+		}
+		j = delta[tolower(t[0])];
+		if (i < j)
+			break;
+		i -= j;
+		t += j;
+	}
+	return (NULL);
+}
+
+
+
+
+
+/*@}*/