]> code.citadel.org Git - citadel.git/blobdiff - citadel/tools.c
* Completed self-service list subscription via web.
[citadel.git] / citadel / tools.c
index c2d216ada2ed1879ed0b83fbedb091ac2f41fddc..3a457ae6efc072a71c87bfa325699e6049df0bd0 100644 (file)
 /*
- * tools.c -- Miscellaneous routines used by both the client and server.
  * $Id$
+ *
+ * Utility functions that are used by both the client and server.
+ *
  */
 
+#ifdef DLL_EXPORT
+#define IN_LIBCIT
+#endif
+
+#include "sysdep.h"
 #include <stdio.h>
 #include <stdlib.h>
+#include <ctype.h>
 #include <string.h>
+#include <stdarg.h>
+
+#if TIME_WITH_SYS_TIME
+# include <sys/time.h>
+# include <time.h>
+#else
+# if HAVE_SYS_TIME_H
+#  include <sys/time.h>
+# else
+#  include <time.h>
+# endif
+#endif
+
 #include "tools.h"
+#include "citadel.h"
+
+#define TRUE  1
+#define FALSE 0
+
+typedef unsigned char byte;          /* Byte type */
+static byte dtable[256];             /* base64 encode / decode table */
+
 
 char *safestrncpy(char *dest, const char *src, size_t n)
 {
-  if (dest == NULL || src == NULL)
-    {
-      fprintf(stderr, "safestrncpy: NULL argument\n");
-      abort();
+       if (dest == NULL || src == NULL) {
+               fprintf(stderr, "safestrncpy: NULL argument\n");
+               abort();
+       }
+       strncpy(dest, src, n);
+       dest[n - 1] = 0;
+       return dest;
+}
+
+
+
+#ifndef HAVE_STRNCASECMP
+int strncasecmp(char *lstr, char *rstr, int len)
+{
+       int pos = 0;
+       char lc,rc;
+       while (pos<len) {
+               lc=tolower(lstr[pos]);
+               rc=tolower(rstr[pos]);
+               if ((lc==0)&&(rc==0)) return(0);
+               if (lc<rc) return(-1);
+               if (lc>rc) return(1);
+               pos=pos+1;
+       }
+       return(0);
+}
+#endif
+
+
+
+/*
+ * num_tokens()  -  discover number of parameters/tokens in a string
+ */
+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;
+       }
+       return(count);
+}
+
+
+/* extract_token_fast() - a smarter string tokenizer */
+void extract_token(char *dest, char *source, int parmnum, char separator)
+{
+       char *d, *s;            /* dest, source */
+       int count = 0;
+
+       strcpy(dest, "");
+
+       /* Locate desired parameter */
+       s = source;
+       while (count < parmnum) {
+               /* End of string, bail! */
+               if (!*s) {
+                       s = NULL;
+                       break;
+               }
+               if (*s == separator) {
+                       count++;
+               }
+               s++;
+       }
+       if (!s) return;         /* Parameter not found */
+
+       for (d = dest; *s && *s != separator; s++, d++) {
+               *d = *s;
+       }
+       *d = 0;
+}
+
+
+/*
+ * extract_token()  -  a smarter string tokenizer
+ */
+void extract_token_old(char *dest, char *source, int parmnum, char separator) 
+{
+       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;
+               }
+               else if (curr_parm == parmnum) {
+                       dest[len+1] = 0;
+                       dest[len++] = source[i];
+               }
+       }
+}
+
+
+
+/* remove_token_fast() - a tokenizer that kills, maims, and destroys fast */
+void remove_token(char *source, int parmnum, char separator)
+{
+       char *d, *s;            /* dest, source */
+       int count = 0;
+
+       /* Find desired parameter */
+       d = source;
+       while (count < parmnum) {
+               /* End of string, bail! */
+               if (!*d) {
+                       d = NULL;
+                       break;
+               }
+               if (*d == separator) {
+                       count++;
+               }
+               d++;
+       }
+       if (!d) return;         /* Parameter not found */
+
+       /* Find next parameter */
+       s = d;
+       while (*s && *s != separator) {
+               s++;
+       }
+
+       /* Hack and slash */
+       if (*s)
+               strcpy(d, ++s);
+       else if (d == source)
+               *d = 0;
+       else
+               *--d = 0;
+       /*
+       while (*s) {
+               *d++ = *s++;
+       }
+       *d = 0;
+       */
+}
+
+
+/*
+ * remove_token()  -  a tokenizer that kills, maims, and destroys
+ */
+void remove_token_old(char *source, int parmnum, char separator)
+{
+       int i;
+       int len;
+       int curr_parm;
+       int start, end;
+
+       len = 0;
+       curr_parm = 0;
+       start = (-1);
+       end = (-1);
+
+       if (strlen(source)==0) {
+               return;
+               }
+
+       for (i=0; i<strlen(source); ++i) {
+               if ( (start < 0) && (curr_parm == parmnum) ) {
+                       start = i;
+               }
+
+               if ( (end < 0) && (curr_parm == (parmnum+1)) ) {
+                       end = i;
+               }
+
+               if (source[i]==separator) {
+                       ++curr_parm;
+               }
+       }
+
+       if (end < 0) end = strlen(source);
+       strcpy(&source[start], &source[end]);
+}
+
+
+
+
+/*
+ * extract_int()  -  extract an int parm w/o supplying a buffer
+ */
+int extract_int(char *source, int parmnum)
+{
+       char buf[SIZ];
+       
+       extract_token(buf, source, parmnum, '|');
+       return(atoi(buf));
+}
+
+/*
+ * extract_long()  -  extract an long parm w/o supplying a buffer
+ */
+long extract_long(char *source, long int parmnum)
+{
+       char buf[SIZ];
+       
+       extract_token(buf, source, parmnum, '|');
+       return(atol(buf));
+}
+
+
+
+/*
+ * decode_base64() and encode_base64() are adaptations of code by
+ * John Walker, found in full in the file "base64.c" included with this
+ * distribution.  The difference between those functions and these is that
+ * these are intended to encode/decode small string buffers, and those are
+ * intended to encode/decode entire MIME parts.
+ */
+
+void encode_base64(char *dest, char *source)
+{
+    int i, hiteof = FALSE;
+    int spos = 0;
+    int dpos = 0;
+
+    /* 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++) {
+           c = source[spos++];
+           if (c == 0) {
+               hiteof = TRUE;
+               break;
+           }
+           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;
+           }
+       }
+    }
+}
+
+
+/* 
+ * Convert base64-encoded to binary.  Returns the length of the decoded data.
+ * It will stop after reading 'length' bytes.
+ */
+int decode_base64(char *dest, char *source, size_t length)
+{
+    int i, c;
+    int dpos = 0;
+    int spos = 0;
+
+    for (i = 0; i < 255; i++) {
+       dtable[i] = 0x80;
     }
-  strncpy(dest, src, n);
-  dest[n - 1] = 0;
-  return dest;
+    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);
+       }
+    }
+}
+
+
+
+/*
+ * Strip leading and trailing spaces from a string
+ */
+void striplt(char *buf)
+{
+        while ((strlen(buf) > 0) && (isspace(buf[0])))
+                strcpy(buf, &buf[1]);
+        while (isspace(buf[strlen(buf) - 1]))
+                buf[strlen(buf) - 1] = 0;
+}
+
+
+
+
+
+/* 
+ * Return the number of occurances of character ch in string st
+ */ 
+int haschar(const char *st, int ch)
+{
+       int a, b;
+       b = 0;
+       for (a = 0; a < strlen(st); ++a)
+               if (st[a] == ch)
+                       ++b;
+       return (b);
+}
+
+
+
+
+/*
+ * Compare two strings, insensitive to case, punctuation, and non-alnum chars
+ */
+int collapsed_strcmp(char *s1, char *s2) {
+       char *c1, *c2;
+       int i, ret, pos;
+
+       c1 = malloc(strlen(s1)+1);
+       c2 = malloc(strlen(s2)+1);
+       c1[0] = 0;
+       c2[0] = 0;
+
+       pos = 0;
+       for (i=0; i<strlen(s1); ++i) {
+               if (isalnum(s1[i])) {
+                       c1[pos] = tolower(s1[i]);
+                       c1[++pos] = 0;
+               }
+       }
+
+       pos = 0;
+       for (i=0; i<strlen(s2); ++i) {
+               if (isalnum(s2[i])) {
+                       c2[pos] = tolower(s2[i]);
+                       c2[++pos] = 0;
+               }
+       }
+
+       ret = strcmp(c1, c2);
+       free(c1);
+       free(c2);
+       return(ret);
+}
+
+
+
+/*
+ * Format a date/time stamp for output 
+ * seconds is whether to print the seconds
+ */
+void fmt_date(char *buf, size_t n, time_t thetime, int seconds) {
+       struct tm *tm;
+       int hour;
+
+       char *ascmonths[] = {
+               "Jan", "Feb", "Mar", "Apr", "May", "Jun",
+               "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
+       };
+
+       strcpy(buf, "");
+       tm = localtime(&thetime);
+
+       hour = tm->tm_hour;
+       if (hour == 0)  hour = 12;
+       else if (hour > 12) hour = hour - 12;
+
+       if (seconds) {
+               snprintf(buf, n, "%s %d %4d %d:%02d:%02d%s",
+                       ascmonths[tm->tm_mon],
+                       tm->tm_mday,
+                       tm->tm_year + 1900,
+                       hour,
+                       tm->tm_min,
+                       tm->tm_sec,
+                       ( (tm->tm_hour >= 12) ? "pm" : "am" )
+               );
+       } else {
+               snprintf(buf, n, "%s %d %4d %d:%02d%s",
+                       ascmonths[tm->tm_mon],
+                       tm->tm_mday,
+                       tm->tm_year + 1900,
+                       hour,
+                       tm->tm_min,
+                       ( (tm->tm_hour >= 12) ? "pm" : "am" )
+               );
+       }
+}
+
+
+
+/*
+ * Determine whether the specified message number is contained within the
+ * specified set.
+ */
+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, ',');
+
+               extract_token(lostr, setstr, 0, ':');
+               if (num_tokens(setstr, ':') >= 2) {
+                       extract_token(histr, setstr, 1, ':');
+                       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);
+}
+
+
+/*
+ * Utility function to "readline" from memory
+ * (returns new pointer)
+ */
+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;
+                }
+        }
+}
+
+
+/*
+ * Strip a boundarized substring out of a string (for example, remove
+ * parentheses and anything inside them).
+ */
+void stripout(char *str, char leftboundary, char rightboundary) {
+       int a;
+        int lb = (-1);
+        int 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]);
+        }
+
 }
+
+
+/*
+ * Reduce a string down to a boundarized substring (for example, remove
+ * parentheses and anything outside them).
+ */
+void stripallbut(char *str, char leftboundary, char rightboundary) {
+       int a;
+
+       for (a = 0; a < strlen(str); ++ a) {
+               if (str[a] == leftboundary) strcpy(str, &str[a+1]);
+       }
+
+       for (a = 0; a < strlen(str); ++ a) {
+               if (str[a] == rightboundary) str[a] = 0;
+       }
+
+}
+
+char *myfgets(char *s, int size, FILE *stream) {
+       char *ret = fgets(s, size, stream);
+       char *nl;
+
+       if (ret != NULL) {
+               nl = strchr(s, '\n');
+
+               if (nl != NULL)
+                       *nl = 0;
+       }
+
+       return ret;
+}
+
+/*
+ * Escape a string for feeding out as a URL.
+ * Output buffer must be big enough to handle escape expansion!
+ */
+void urlesc(char *outbuf, char *strbuf)
+{
+       int a, b, c;
+       char *ec = " #&;`'|*?-~<>^()[]{}$\\";
+
+       strcpy(outbuf, "");
+
+       for (a = 0; a < strlen(strbuf); ++a) {
+               c = 0;
+               for (b = 0; b < strlen(ec); ++b) {
+                       if (strbuf[a] == ec[b])
+                               c = 1;
+               }
+               b = strlen(outbuf);
+               if (c == 1)
+                       sprintf(&outbuf[b], "%%%02x", strbuf[a]);
+               else
+                       sprintf(&outbuf[b], "%c", strbuf[a]);
+       }
+}
+
+