X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=libcitadel%2Flib%2Ftools.c;h=df2f1b42d1086e434a3c254ebca21fe217a3047a;hb=1aa2da0249792527f99172681aecc77e0ad086af;hp=61e49f0d089de8fc528fab6ee3e6e54e4c5a29d2;hpb=df7df08f76c54e628a9bf50a560056a1b0b83d2f;p=citadel.git diff --git a/libcitadel/lib/tools.c b/libcitadel/lib/tools.c index 61e49f0d0..df2f1b42d 100644 --- a/libcitadel/lib/tools.c +++ b/libcitadel/lib/tools.c @@ -1,6 +1,22 @@ /* * A basic toolset containing miscellaneous functions for string manipluation, * encoding/decoding, and a bunch of other stuff. + * + * Copyright (c) 1987-2011 by the citadel.org team + * + * This program is open source software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ @@ -33,10 +49,56 @@ #define FALSE 0 typedef unsigned char byte; /* Byte type */ -static byte dtable[256] = "\0"; /* base64 decode table */ -static byte etable[256] = "\0"; /* base64 encode table */ -char *safestrncpy(char *dest, const char *src, size_t n) +/* Base64 encoding table */ +const byte etable[256] = { + 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, + 82, 83, 84, 85, 86, 87, 88, 89, 90, 97, 98, 99, 100, 101, 102, 103, + 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, + 118, 119, 120, 121, 122, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 43, + 47, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0 +}; + +/* Base64 decoding table */ +const byte dtable[256] = { + 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, + 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, + 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, + 128, 62, 128, 128, 128, 63, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, + 128, 128, 128, 0, 128, 128, 128, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, + 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 128, 128, 128, + 128, 128, 128, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, + 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 128, 128, 128, 128, + 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, + 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, + 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, + 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, + 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, + 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, + 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, + 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, + 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, 128, + 128, 128, 0 +}; + +/* + * copy a string into a buffer of a known size. abort if we exceed the limits + * + * dest the targetbuffer + * src the source string + * n the size od dest + * + * returns the number of characters copied if dest is big enough, -n if not. + */ +int safestrncpy(char *dest, const char *src, size_t n) { int i = 0; @@ -47,11 +109,11 @@ char *safestrncpy(char *dest, const char *src, size_t n) do { dest[i] = src[i]; - if (dest[i] == 0) return(dest); + if (dest[i] == 0) return i; ++i; } while (i 0) - memmove(buf, &buf[a], len - a + 1); } +/* + * Strip leading and trailing spaces from a string + */ +size_t striplt(char *buf) { + char *first_nonspace = NULL; + char *last_nonspace = NULL; + char *ptr; + size_t new_len = 0; + if ((buf == NULL) || (*buf == '\0')) { + return 0; + } + for (ptr=buf; *ptr!=0; ++ptr) { + if (!isspace(*ptr)) { + if (!first_nonspace) { + first_nonspace = ptr; + } + last_nonspace = ptr; + } + } + + if ((!first_nonspace) || (!last_nonspace)) { + buf[0] = 0; + return 0; + } + + new_len = last_nonspace - first_nonspace + 1; + memmove(buf, first_nonspace, new_len); + buf[new_len] = 0; + return new_len; +} /** * \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 + * \return the number of times ch appears in st */ -int haschar(const char *st,int ch) +int haschar(const char *st, int ch) { const char *ptr; int b; @@ -503,40 +566,19 @@ int haschar(const char *st,int ch) */ void fmt_date(char *buf, size_t n, time_t thetime, int seconds) { struct tm tm; - int hour; + char *teh_format = NULL; - /* Month strings for date conversions ... this needs to be localized eventually */ - char *fmt_date_months[12] = { - "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" - }; - - strcpy(buf, ""); + *buf = '\0'; localtime_r(&thetime, &tm); - 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", - fmt_date_months[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", - fmt_date_months[tm.tm_mon], - tm.tm_mday, - tm.tm_year + 1900, - hour, - tm.tm_min, - ( (tm.tm_hour >= 12) ? "pm" : "am" ) - ); + teh_format = "%F %R:%S"; + } + else { + teh_format = "%F %R"; } + + strftime(buf, n, teh_format, &tm); } @@ -545,7 +587,7 @@ void fmt_date(char *buf, size_t n, time_t thetime, int seconds) { * Determine whether the specified message number is contained within the * specified sequence set. */ -int is_msg_in_sequence_set(char *mset, long msgnum) { +int is_msg_in_sequence_set(const char *mset, long msgnum) { int num_sets; int s; char setstr[128], lostr[128], histr[128]; @@ -632,13 +674,71 @@ char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen) } +/** + * \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. + */ +const char *cmemreadline(const char *start, char *buf, int maxlen) +{ + char ch; + const char *ptr; + int len = 0; /**< tally our own length to avoid strlen() delays */ + + ptr = start; + + 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. + */ +const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen) +{ + char ch; + const char *ptr; + int len = 0; /**< tally our own length to avoid strlen() delays */ + + ptr = start; + + while (1) { + ch = *ptr++; + if ((len + 1 < (maxlen)) && (ch != 13) && (ch != 10)) { + buf[len++] = ch; + } + if ((ch == 10) || (ch == 0)) { + buf[len] = 0; + *retlen = len; + 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 stripout(char *str, char leftboundary, char rightboundary) { int a; int lb = (-1); int rb = (-1); @@ -650,12 +750,14 @@ void stripout(char *str, char leftboundary, char rightboundary) { if ( (lb > 0) && (rb > lb) ) { strcpy(&str[lb - 1], &str[rb + 1]); + return 1; } else if ( (lb == 0) && (rb > lb) ) { strcpy(str, &str[rb + 1]); + return 1; } - + return 0; } @@ -663,19 +765,30 @@ void stripout(char *str, char leftboundary, char rightboundary) { * 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; +long stripallbut(char *str, char leftboundary, char rightboundary) { + long len = 0; + + char *lb = NULL; + char *rb = NULL; + + lb = strrchr(str, leftboundary); + if (lb != NULL) { + ++lb; + rb = strchr(str, rightboundary); + if ((rb != NULL) && (rb >= lb)) { + *rb = 0; + fflush(stderr); + len = (long)rb - (long)lb; + memmove(str, lb, len); + str[len] = 0; + return(len); + } } + return (long)strlen(str); } + char *myfgets(char *s, int size, FILE *stream) { char *ret = fgets(s, size, stream); char *nl; @@ -701,7 +814,7 @@ void urlesc(char *outbuf, size_t oblen, char *strbuf) int a, b, c, len, eclen, olen; char *ec = " +#&;`'|*?-~<>^()[]{}/$\"\\"; - strcpy(outbuf, ""); + *outbuf = '\0'; len = strlen(strbuf); eclen = strlen(ec); olen = 0; @@ -739,12 +852,41 @@ char *strcpy(char *dest, const char *src) { * Generate a new, globally unique UID parameter for a calendar etc. object */ void generate_uuid(char *buf) { - static int seq = 0; + static int seq = (-1); + static int no_kernel_uuid = 0; + + /* If we are running on Linux then we have a kernelspace uuid generator available */ + + if (no_kernel_uuid == 0) { + FILE *fp; + fp = fopen("/proc/sys/kernel/random/uuid", "rb"); + if (fp) { + int rv; + rv = fread(buf, 36, 1, fp); + fclose(fp); + if (rv == 1) { + buf[36] = 0; + return; + } + } + } + + /* If the kernel didn't provide us with a uuid, we generate a pseudo-random one */ - sprintf(buf, "%lx-%lx-%x", - time(NULL), + no_kernel_uuid = 1; + + if (seq == (-1)) { + seq = (int)rand(); + } + ++seq; + seq = (seq % 0x0FFF) ; + + sprintf(buf, "%08lx-%04lx-4%03x-a%03x-%012lx", + (long)time(NULL), (long)getpid(), - (seq++) + seq, + seq, + (long)rand() ); } @@ -755,18 +897,101 @@ void generate_uuid(char *buf) { * The code is roughly based on the strstr() replacement from 'tin' written * by Urs Jannsen. */ -char *bmstrcasestr(char *text, char *pattern) { +inline static char *_bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen) { register unsigned char *p, *t; register int i, j, *delta; register size_t p1; int deltaspace[256]; + + if (!text) return(NULL); + if (!pattern) return(NULL); + + /* 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); +} + +/* + * bmstrcasestr() -- 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. + */ +char *bmstrcasestr(char *text, const char *pattern) { size_t textlen; size_t patlen; + if (!text) return(NULL); + if (!pattern) return(NULL); + textlen = strlen (text); patlen = strlen (pattern); + return _bmstrcasestr_len(text, textlen, pattern, patlen); +} + +char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen) { + return _bmstrcasestr_len(text, textlen, pattern, patlen); +} + + + + +/* + * bmstrcasestr() -- 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. + */ +inline static const char *_cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen) { + + register unsigned char *p, *t; + register int i, j, *delta; + register size_t p1; + int deltaspace[256]; + + if (!text) return(NULL); + if (!pattern) return(NULL); + /* algorithm fails if pattern is empty */ if ((p1 = patlen) == 0) return (text); @@ -808,7 +1033,29 @@ char *bmstrcasestr(char *text, char *pattern) { return (NULL); } +/* + * bmstrcasestr() -- 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. + */ +const char *cbmstrcasestr(const char *text, const char *pattern) { + size_t textlen; + size_t patlen; + + if (!text) return(NULL); + if (!pattern) return(NULL); + + textlen = strlen (text); + patlen = strlen (pattern); + + return _cbmstrcasestr_len(text, textlen, pattern, patlen); +} +const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen) { + return _cbmstrcasestr_len(text, textlen, pattern, patlen); +} /* * Local replacement for controversial C library function that generates @@ -818,7 +1065,7 @@ void CtdlMakeTempFileName(char *name, int len) { int i = 0; while (i++, i < 100) { - snprintf(name, len, "/tmp/ctdl.%4lx.%04x", + snprintf(name, len, "/tmp/ctdl.%04lx.%04x", (long)getpid(), rand() ); @@ -834,7 +1081,7 @@ void CtdlMakeTempFileName(char *name, int len) { * Determine whether the specified message number is contained within the specified set. * Returns nonzero if the specified message number is in the specified message set string. */ -int is_msg_in_mset(char *mset, long msgnum) { +int is_msg_in_mset(const char *mset, long msgnum) { int num_sets; int s; char setstr[SIZ], lostr[SIZ], histr[SIZ]; /* was 1024 */ @@ -868,10 +1115,8 @@ int is_msg_in_mset(char *mset, long msgnum) { /* - * \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 + * searches for a pattern within a search string + * returns position in string */ int pattern2(char *search, char *patn) { @@ -887,10 +1132,10 @@ int pattern2(char *search, char *patn) } -/** - * \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. +/* + * Strip leading and trailing spaces from a string; with premeasured and adjusted length. + * buf - the string to modify + * len - length of the string. */ void stripltlen(char *buf, int *len) { @@ -908,3 +1153,40 @@ void stripltlen(char *buf, int *len) } } + +/* + * Convert all whitespace characters in a supplied string to underscores + */ +void convert_spaces_to_underscores(char *str) +{ + int len; + int i; + + if (!str) return; + + len = strlen(str); + for (i=0; i 126)) { + return 1; + } + pch++; + } + return 0; +} +