* tiny tool for message retrieval, first draft.
[citadel.git] / webcit / tools.c
index 86e2d4f5ce6cc616d5127867cb745eec1e05e37e..591af0d977a0d73c101d8e9467be93ac9f92549a 100644 (file)
@@ -3,6 +3,7 @@
  */
 /**
  * \defgroup MiscRout Miscellaneous routines 
+ * \ingroup tools
  */
 
 /*@{*/
@@ -44,56 +45,73 @@ char *safestrncpy(char *dest, const char *src, size_t n)
  */
 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);
 }
 
-/**
- * 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
+/*
+ * 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);
+       }
 
+//     cit_backtrace();
+//     lprintf (CTDL_DEBUG, "test >: n: %d sep: %c source: %s \n willi \n", parmnum, separator, source);
        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);
+       }
+
+       maxlen--;
+       
+       while (*s) {
                if (*s == separator) {
-                       count++;
+                       ++current_token;
                }
-               s++;
+               if ( (current_token == parmnum) && 
+                    (*s != separator) && 
+                    (len < maxlen) ) {
+                       dest[len] = *s;
+                       ++len;
+               }
+               else if ((current_token > parmnum) || (len >= maxlen)) {
+                       break;
+               }
+               ++s;
        }
-       if (!s) return;         /* Parameter not found */
 
-       for (d = dest; *s && *s != separator && ++len<maxlen; s++, d++) {
-               *d = *s;
+       dest[len] = '\0';
+       if (current_token < parmnum) {
+//             lprintf (CTDL_DEBUG,"test <!: %s\n", dest);
+               return(-1);
        }
-       *d = 0;
+//     lprintf (CTDL_DEBUG,"test <: %d; %s\n", len, dest);
+       return(len);
 }
-
+//*/
 
 
 /**
@@ -105,7 +123,7 @@ void extract_token(char *dest, const char *source, int parmnum, char separator,
 void remove_token(char *source, int parmnum, char separator)
 {
        int i;
-       int len;
+       int len, slen;
        int curr_parm;
        int start, end;
 
@@ -114,11 +132,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;
                }
@@ -133,9 +154,9 @@ 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);
 }
 
 
@@ -180,12 +201,14 @@ long extract_long(const char *source, int parmnum)
  * \param ch the char to search
  * \return the position inside of st
  */
-int haschar(char *st,char ch)
+int haschar(const char *st,char ch)
 {
-       int a, b;
+       const char *ptr;
+       int b;
        b = 0;
-       for (a = 0; a < strlen(st); ++a)
-               if (st[a] == ch)
+       ptr = st;
+       while (!IsEmptyStr(ptr))
+               if (*ptr == ch)
                        ++b;
        return (b);
 }
@@ -193,10 +216,10 @@ int haschar(char *st,char ch)
 
 /** 
  * \brief Utility function to "readline" from memory
- * \param start position in buf
- * \param buf the buffer to create string in???
- * \param maxlen how big may the buffer get?
- * \return new pointer to read string
+ * \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)
 {
@@ -205,16 +228,43 @@ char *memreadline(char *start, char *buf, int maxlen)
        int len = 0;            /**< tally our own length to avoid strlen() delays */
 
        ptr = start;
-       memset(buf, 0, maxlen);
+       while (1) {
+               ch = *ptr++;
+               if ((len + 1 < (maxlen)) && (ch != 13) && (ch != 10)) {
+                       buf[len++] = ch;
+               }
+               if ((ch == 10) || (ch == 0)) {
+                       buf[len] = 0;
+                       return ptr;
+               }
+       }
+}
+
+
+/** 
+ * \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
+ * \param retlen the length of the returned string
+ * \return Pointer to the source memory right after we stopped reading.
+ */
+char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen)
+{
+       char ch;
+       char *ptr;
+       int len = 0;            /**< tally our own length to avoid strlen() delays */
+
+       ptr = start;
 
        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;
                }
                if ((ch == 10) || (ch == 0)) {
+                       buf[len] = 0;
+                       *retlen = len;
                        return ptr;
                }
        }
@@ -231,35 +281,58 @@ char *memreadline(char *start, char *buf, int maxlen)
 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);
 }
 
 
+/**
+ * \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);
 }
 
 
 /**
  * \brief Determine whether the specified message number is contained within the
  * specified set.
- * \param mset stringset???
- * \param msgnum a citadel server indexnumber
- * \return yes / no ???
+ *
+ * \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;
@@ -310,12 +383,13 @@ 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)
@@ -323,7 +397,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));
@@ -354,14 +429,18 @@ void sleeeeeeeeeep(int seconds)
  * \param dest encrypted string
  * \param source the string to encrypt
  * \param sourcelen the length of the source data (may contain string terminators)
+ * \return the length of the encoded string.
  */
 
-void CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen)
+size_t CtdlEncodeBase64(char **pdest, const char *source, size_t sourcelen, size_t *destlen, int linebreaks)
 {
        int i, hiteof = FALSE;
        int spos = 0;
        int dpos = 0;
        int thisline = 0;
+       char *dest;
+
+       dest = *pdest;
 
        /**  Fill dtable with character encodings.  */
 
@@ -411,11 +490,31 @@ void CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen)
                                }
                        }
                        for (i = 0; i < 4; i++) {
+                               if (dpos > *destlen)
+                               {
+                                       int newlen;
+                                       char *newbuf;
+                                       newlen = *destlen + *destlen / 2;
+                                       newbuf = (char*) malloc(newlen);
+                                       memcpy(newbuf, dest, *destlen);
+                                       *pdest = dest = newbuf;
+                                       *destlen = newlen;
+                               }
                                dest[dpos++] = ogroup[i];
                                dest[dpos] = 0;
                        }
                        thisline += 4;
-                       if (thisline > 70) {
+                       if ( (linebreaks) && (thisline > 70) ) {
+                               if (dpos + 3 > *destlen)
+                               {
+                                       int newlen;
+                                       char *newbuf;
+                                       newlen = *destlen + *destlen / 2;
+                                       newbuf = (char*) malloc(newlen);
+                                       memcpy(newbuf, dest, *destlen);
+                                       *pdest = dest = newbuf;
+                                       *destlen = newlen;
+                               }
                                dest[dpos++] = '\r';
                                dest[dpos++] = '\n';
                                dest[dpos] = 0;
@@ -423,22 +522,34 @@ void CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen)
                        }
                }
        }
-       if (thisline > 70) {
+       if ( (linebreaks) && (thisline > 70) ) {
+               if (dpos + 3 > *destlen)
+               {
+                       int newlen;
+                       char *newbuf;
+                       newlen = *destlen + 5;
+                       newbuf = (char*) malloc(newlen);
+                       memcpy(newbuf, dest, *destlen);
+                       *pdest = dest = newbuf;
+                       *destlen = newlen;
+               }
                dest[dpos++] = '\r';
                dest[dpos++] = '\n';
                dest[dpos] = 0;
                thisline = 0;
        }
+       return dpos;
 }
 
 
 /**
  * \brief Convert base64-encoded to binary.  
  * It will stop after reading 'length' bytes.
- * \param dest the destination buffer 
- * \param source the encrypted string
- * \param length the maximal length of dest???
- * \return the length actual length of the decoded data.
+ *
+ * \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)
 {
@@ -506,20 +617,58 @@ int CtdlDecodeBase64(char *dest, const char *source, size_t length)
 
 /**
  * \brief Generate a new, globally unique UID parameter for a calendar etc. object
- * \param buf uid to create ????
+ *
+ * \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",
+       sprintf(buf, "%s-%lx-%lx-%x",
                serv_info.serv_nodename,
                (long)time(NULL),
-               getpid(),
+               (long)getpid(),
                (seq++)
        );
 }
 
 
+/*
+ * Convert "quoted-printable" to binary.  Returns number of bytes decoded.
+ * according to RFC2045 section 6.7
+ */
+int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen) {
+       unsigned int ch;
+       int decoded_length = 0;
+       int pos = 0;
+
+       while (pos < sourcelen)
+       {
+               if (!strncmp(&encoded[pos], "=\r\n", 3))
+               {
+                       pos += 3;
+               }
+               else if (!strncmp(&encoded[pos], "=\n", 2))
+               {
+                       pos += 2;
+               }
+               else if (encoded[pos] == '=')
+               {
+                       ch = 0;
+                       sscanf(&encoded[pos+1], "%02x", &ch);
+                       pos += 3;
+                       decoded[decoded_length++] = ch;
+               }
+               else
+               {
+                       decoded[decoded_length++] = encoded[pos];
+                       pos += 1;
+               }
+       }
+       decoded[decoded_length] = 0;
+       return(decoded_length);
+}
+
+
 /**
  * \brief Local replacement for controversial C library function that generates
  * names for temporary files.  Included to shut up compiler warnings.
@@ -543,4 +692,71 @@ void CtdlMakeTempFileName(char *name, int len) {
 
 
 
+/*
+ * \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);
+}
+
+
+
+
+
 /*@}*/