tools.c: bugfixes to trim functions (Phil Slack)
[citadel.git] / libcitadel / lib / tools.c
index 14e43071a1761d6c02ed248ae6fdc6e70d82c7c7..2b5066d95fcde99bbffaad31153223dca81b1989 100644 (file)
@@ -1,24 +1,10 @@
-/*
- * 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
- */
-
+// A basic toolset containing miscellaneous functions for string manipluation,
+// encoding/decoding, and a bunch of other stuff.
+//
+// Copyright (c) 1987-2022 by the citadel.org team
+//
+// This program is open source software.  Use, duplication, or disclosure
+// is subject to the terms of the GNU General Public License, version 3.
 
 #include <stdlib.h>
 #include <unistd.h>
@@ -30,8 +16,6 @@
 #include <sys/stat.h>
 #include <errno.h>
 #include <limits.h>
-#include "b64/cencode.h"
-#include "b64/cdecode.h"
 
 #if TIME_WITH_SYS_TIME
 # include <sys/time.h>
 #define TRUE  1
 #define FALSE 0
 
-typedef unsigned char byte;          /* Byte type */
+typedef unsigned char byte;          // Byte type
 
-/*
- * 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)
-{
+// 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;
 
-       if (dest == NULL || src == NULL) {
+       if (dest == NULL || src == NULL)
+       {
                fprintf(stderr, "safestrncpy: NULL argument\n");
                abort();
        }
@@ -80,12 +62,8 @@ int safestrncpy(char *dest, const char *src, size_t n)
 }
 
 
-
-/*
- * num_tokens()  -  discover number of parameters/tokens in a string
- */
-int num_tokens(const char *source, char tok)
-{
+// num_tokens()  -  discover number of parameters/tokens in a string
+int num_tokens(const char *source, char tok) {
        int count = 1;
        const char *ptr = source;
 
@@ -102,18 +80,13 @@ int num_tokens(const char *source, char tok)
        return (count);
 }
 
-//extern void cit_backtrace(void);
-
 
-/*
- * extract_token() - a string tokenizer
- * returns -1 if not found, or length of token.
- */
-long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen)
-{
-       const char *s;                  //* source * /
-       int len = 0;                    //* running total length of extracted string * /
-       int current_token = 0;          //* token currently being processed * /
+// extract_token() - a string tokenizer
+// returns -1 if not found, or length of token.
+long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen) {
+       const char *s;                  // source
+       int len = 0;                    // running total length of extracted string
+       int current_token = 0;          // token currently being processed
 
        s = source;
 
@@ -121,8 +94,6 @@ long extract_token(char *dest, const char *source, int parmnum, char separator,
                return(-1);
        }
 
-       //cit_backtrace();
-       //lprintf (CTDL_DEBUG, "test >: n: %d sep: %c source: %s \n willi \n", parmnum, separator, source);
        dest[0] = 0;
 
        if (s == NULL) {
@@ -135,9 +106,7 @@ long extract_token(char *dest, const char *source, int parmnum, char separator,
                if (*s == separator) {
                        ++current_token;
                }
-               if ( (current_token == parmnum) && 
-                    (*s != separator) && 
-                    (len < maxlen) ) {
+               if ( (current_token == parmnum) && (*s != separator) && (len < maxlen) ) {
                        dest[len] = *s;
                        ++len;
                }
@@ -149,70 +118,21 @@ long extract_token(char *dest, const char *source, int parmnum, char separator,
 
        dest[len] = '\0';
        if (current_token < parmnum) {
-               //lprintf (CTDL_DEBUG,"test <!: %s\n", dest);
                return(-1);
        }
-       //lprintf (CTDL_DEBUG,"test <: %d; %s\n", len, dest);
        return(len);
 }
-//*/
-
-
-/*
- * extract_token() - a string tokenizer
- * /
-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;
-
-       
-       //cit_backtrace();
-       //lprintf (CTDL_DEBUG, "test >: n: %d sep: %c source: %s \n willi \n", parmnum, separator, source);
-       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) {
-               //lprintf (CTDL_DEBUG,"test <!: %s\n", dest);
-               return -1;              // Parameter not found
-       }
-       
-       for (d = dest; *s && *s != separator && ++len<maxlen; s++, d++) {
-               *d = *s;
-       }
-       *d = 0;
-       //lprintf (CTDL_DEBUG,"test <: %d; %s\n", len, dest);
-       return 0;
-}
-*/
 
 
-/*
- * remove_token() - a tokenizer that kills, maims, and destroys
- */
-void remove_token(char *source, int parmnum, char separator)
-{
-       char *d, *s;            /* dest, source */
+// remove_token() - a tokenizer that kills, maims, and destroys
+void remove_token(char *source, int parmnum, char separator) {
+       char *d, *s;            // dest, source
        int count = 0;
 
-       /* Find desired parameter */
+       // Find desired parameter
        d = source;
        while (count < parmnum) {
-               /* End of string, bail! */
+               // End of string, bail!
                if (!*d) {
                        d = NULL;
                        break;
@@ -222,35 +142,26 @@ void remove_token(char *source, int parmnum, char separator)
                }
                d++;
        }
-       if (!d) return;         /* Parameter not found */
+       if (!d) return;         // Parameter not found
 
-       /* Find next parameter */
+       // Find next parameter
        s = d;
        while (*s && *s != separator) {
                s++;
        }
 
-       /* Hack and slash */
+       // Hack and slash
        if (*s)
                strcpy(d, ++s);
        else if (d == source)
                *d = 0;
        else
                *--d = 0;
-       /*
-       while (*s) {
-               *d++ = *s++;
-       }
-       *d = 0;
-       */
 }
 
 
-/*
- * extract_int()  -  extract an int parm w/o supplying a buffer
- */
-int extract_int(const char *source, int parmnum)
-{
+// extract_int()  -  extract an int parm without supplying a buffer
+int extract_int(const char *source, int parmnum) {
        char buf[32];
        
        if (extract_token(buf, source, parmnum, '|', sizeof buf) > 0)
@@ -259,11 +170,9 @@ int extract_int(const char *source, int parmnum)
                return 0;
 }
 
-/*
- * extract_long()  -  extract an long parm w/o supplying a buffer
- */
-long extract_long(const char *source, int parmnum)
-{
+
+// extract_long()  -  extract an long parm without supplying a buffer
+long extract_long(const char *source, int parmnum) {
        char buf[32];
        
        if (extract_token(buf, source, parmnum, '|', sizeof buf) > 0)
@@ -273,11 +182,8 @@ long extract_long(const char *source, int parmnum)
 }
 
 
-/*
- * extract_unsigned_long() - extract an unsigned long parm
- */
-unsigned long extract_unsigned_long(const char *source, int parmnum)
-{
+// extract_unsigned_long() - extract an unsigned long parm
+unsigned long extract_unsigned_long(const char *source, int parmnum) {
        char buf[32];
 
        if (extract_token(buf, source, parmnum, '|', sizeof buf) > 0)
@@ -286,88 +192,23 @@ unsigned long extract_unsigned_long(const char *source, int parmnum)
                return 0;
 }
 
-size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks)
-{
-       // linebreaks at 70 are ugly for base64, since 3 bytes in makes 4 bytes out
-       int breaklength = 68;
-       int readlength = 3 * breaklength / 4;
-
-       int destoffset;
-       int sourceoffset;
-       int sourceremaining;
-
-       base64_encodestate _state;
-
-       base64_init_encodestate(&_state);
-
-       if (linebreaks) {
-               sourceremaining = sourcelen;
-               destoffset = 0;
-               sourceoffset = 0;
-
-               while (sourceremaining > 0) {
-                       destoffset += base64_encode_block(
-                               &(source[sourceoffset]),
-                               (readlength > sourceremaining ? sourceremaining : readlength),
-                               &(dest[destoffset]),
-                               &_state);
-                       sourceoffset += readlength;
-                       sourceremaining -= readlength;
-                       dest[destoffset++] = '\r';
-                       dest[destoffset++] = '\n';
-               }
 
-               destoffset += base64_encode_blockend(&(dest[destoffset]), &_state);
-       }
-       else {
-               destoffset = base64_encode_block(source, sourcelen, dest, &_state);
-
-               destoffset += base64_encode_blockend(&(dest[destoffset]), &_state);
-       }
-       dest[destoffset] = 0;
-       return destoffset;
-}
-
-
-/* 
- * Convert base64-encoded to binary.  Returns the length of the decoded data.
- * It will stop after reading 'length' bytes.
- */
-int CtdlDecodeBase64(char *dest, const char *source, size_t length)
-{
-       base64_decodestate _state;
-       int len;
-
-       base64_init_decodestate(&_state);
-
-       len = base64_decode_block(source, length, dest, &_state);
-       dest[len] = '\0';
-       return len;
-}
-
-
-/*
- * if we send out non ascii subjects, we encode it this way.
- */
-char *rfc2047encode(const char *line, long length)
-{
+// if we send out non ascii subjects, we encode it this way.
+char *rfc2047encode(const char *line, long length) {
        const char *AlreadyEncoded;
        char *result;
        long end;
 #define UTF8_HEADER "=?UTF-8?B?"
 
-       /* check if we're already done */
+       // check if we're already done
        AlreadyEncoded = strstr(line, "=?");
-       if ((AlreadyEncoded != NULL) &&
-           ((strstr(AlreadyEncoded, "?B?") != NULL)||
-            (strstr(AlreadyEncoded, "?Q?") != NULL)))
-       {
+       if ((AlreadyEncoded != NULL) && ((strstr(AlreadyEncoded, "?B?") != NULL)|| (strstr(AlreadyEncoded, "?Q?") != NULL))) {
                return strdup(line);
        }
 
        result = (char*) malloc(sizeof(UTF8_HEADER) + 4 + length * 2);
        strncpy (result, UTF8_HEADER, strlen (UTF8_HEADER));
-       CtdlEncodeBase64(result + strlen(UTF8_HEADER), line, length, 0);
+       CtdlEncodeBase64(result + strlen(UTF8_HEADER), line, length, BASE64_NO_LINEBREAKS);
        end = strlen (result);
         result[end]='?';
        result[end+1]='=';
@@ -375,12 +216,9 @@ char *rfc2047encode(const char *line, long length)
        return result;
 }
 
-/*
- * removes double slashes from pathnames
- * allows / disallows trailing slashes
- */
-void StripSlashes(char *Dir, int TrailingSlash)
-{
+// removes double slashes from pathnames
+// allows / disallows trailing slashes
+void StripSlashes(char *Dir, int TrailingSlash) {
        char *a, *b;
 
        a = b = Dir;
@@ -405,10 +243,9 @@ void StripSlashes(char *Dir, int TrailingSlash)
 
 }
 
-/*
- * Strip leading and trailing spaces from a string
- */
-size_t striplt(char *buf) {
+
+// Trim leading and trailing whitespace from a string
+size_t string_trim(char *buf) {
        char *first_nonspace = NULL;
        char *last_nonspace = NULL;
        char *ptr;
@@ -439,14 +276,11 @@ size_t striplt(char *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 number of times ch appears in st
- */
-int haschar(const char *st, int ch)
-{
+// check for the presence of a character within a string (returns count)
+// st  the string to examine
+// ch  the char to search
+// returns the number of times ch appears in st
+int haschar(const char *st, int ch) {
        const char *ptr;
        int b;
        b = 0;
@@ -461,36 +295,7 @@ int haschar(const char *st, int ch)
 }
 
 
-
-
-
-/*
- * 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;
-       char *teh_format = NULL;
-
-       *buf = '\0';
-       localtime_r(&thetime, &tm);
-
-       if (seconds) {
-               teh_format = "%F %R:%S";
-       }
-       else {
-               teh_format = "%F %R";
-       }
-
-       strftime(buf, n, teh_format, &tm);
-}
-
-
-
-/*
- * Determine whether the specified message number is contained within the
- * specified sequence set.
- */
+// Determine whether the specified message number is contained within the specified sequence set.
 int is_msg_in_sequence_set(const char *mset, long msgnum) {
        int num_sets;
        int s;
@@ -520,18 +325,15 @@ int is_msg_in_sequence_set(const char *mset, long msgnum) {
        return(0);
 }
 
-/** 
- * \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)
-{
+// Utility function to "readline" from memory
+// start       Location in memory from which we are reading.
+// buf         the buffer to place the string in.
+// maxlen      Size of string buffer
+// returns 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;
 
@@ -548,19 +350,16 @@ char *memreadline(char *start, char *buf, int maxlen)
 }
 
 
-/** 
- * \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)
-{
+// Utility function to "readline" from memory
+// start       Location in memory from which we are reading.
+// buf         the buffer to place the string in.
+// maxlen      Size of string buffer
+// retlen      the length of the returned string
+// returns a 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 */
+       int len = 0;            // tally our own length to avoid strlen() delays
 
        ptr = start;
 
@@ -578,18 +377,15 @@ 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)
-{
+// Utility function to "readline" from memory
+// start Location in memory from which we are reading.
+// buf the buffer to place the string in.
+// 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 */
+       int len = 0;            // tally our own length to avoid strlen() delays
 
        ptr = start;
 
@@ -606,19 +402,16 @@ const char *cmemreadline(const char *start, char *buf, int maxlen)
 }
 
 
-/** 
- * \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)
-{
+// Utility function to "readline" from memory
+// start Location in memory from which we are reading.
+// buf the buffer to place the string in.
+// maxlen Size of string buffer
+// 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 */
+       int len = 0;            // tally our own length to avoid strlen() delays
 
        ptr = start;
 
@@ -636,62 +429,62 @@ const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retle
 }
 
 
+// Strip a boundarized substring out of a string (for example, remove parentheses and anything inside them).
+int stripout(char *str, char leftboundary, char rightboundary) {
+       long lb = (-1);
+       long rb = (-1);
 
+       if (!str) {
+               return 0;
+       }
 
-/*
- * Strip a boundarized substring out of a string (for example, remove
- * parentheses and anything inside them).
- */
-int 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]);
-               return 1;
-        }
-
-        else if ( (lb == 0) && (rb > lb) ) {
-                strcpy(str, &str[rb + 1]);
-               return 1;
-        }
-       return 0;
-}
+       for (int a = 0; str[a]; ++a) {
+               if ((lb==-1) && (str[a] == leftboundary)) {
+                       lb = a;
+               } else if (str[a] == rightboundary) {
+                       rb = a;
+               }
+       }
 
+       if ((lb==-1) || (rb <= lb)) {
+               return 0;
+       }
 
-/*
- * Reduce a string down to a boundarized substring (for example, remove
- * parentheses and anything outside them).
- */
+       strcpy(str + lb, str + rb + 1);
+       return 1;
+}
+
+// Reduce a string down to a boundarized substring (for example, remove
+// parentheses and anything outside them).
 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);
+       long lb = (-1);
+       long rb = (-1);
+       long orig_len = 0;
+
+       if (!str) {
+               return 0;
+       }
+
+       while (str[orig_len]) {
+               if ((lb==-1) && (str[orig_len] == leftboundary)) {
+                       lb = orig_len;
+               } else if (str[orig_len] == rightboundary) {
+                       rb = orig_len;
                }
+               orig_len++;
        }
 
-       return (long)strlen(str);
-}
+       if ((lb==-1) || (rb <= lb)) {
+               return orig_len;
+       }
+
+       fflush(stderr);
 
+       long new_len = rb - lb - 1;
+       memmove(str, str + lb + 1, new_len);
+       str[new_len] = 0;
+       return new_len;
+}
 
 char *myfgets(char *s, int size, FILE *stream) {
        char *ret = fgets(s, size, stream);
@@ -707,14 +500,12 @@ char *myfgets(char *s, int size, FILE *stream) {
        return ret;
 }
 
-/** 
- * \brief Escape a string for feeding out as a URL.
- * \param outbuf the output buffer
- * \param oblen the size of outbuf to sanitize
- * \param strbuf the input buffer
- */
-void urlesc(char *outbuf, size_t oblen, char *strbuf)
-{
+
+// Escape a string for feeding out as a URL.
+// outbuf the output buffer
+// oblen the size of outbuf to sanitize
+// strbuf the input buffer
+void urlesc(char *outbuf, size_t oblen, char *strbuf) {
        int a, b, c, len, eclen, olen;
        char *ec = " +#&;`'|*?-~<>^()[]{}/$\"\\";
 
@@ -739,10 +530,7 @@ void urlesc(char *outbuf, size_t oblen, char *strbuf)
 }
 
 
-
-/*
- * In our world, we want strcpy() to be able to work with overlapping strings.
- */
+// In our world, we want strcpy() to be able to work with overlapping strings.
 #ifdef strcpy
 #undef strcpy
 #endif
@@ -752,14 +540,12 @@ char *strcpy(char *dest, const char *src) {
 }
 
 
-/*
- * Generate a new, globally unique UID parameter for a calendar etc. object
- */
+// Generate a new, globally unique UID parameter for a calendar etc. object
 void generate_uuid(char *buf) {
        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 we are running on Linux then we have a kernelspace uuid generator available
 
        if (no_kernel_uuid == 0) {
                FILE *fp;
@@ -775,7 +561,7 @@ void generate_uuid(char *buf) {
                }
        }
 
-       /* If the kernel didn't provide us with a uuid, we generate a pseudo-random one */
+       // If the kernel didn't provide us with a uuid, we generate a pseudo-random one
 
        no_kernel_uuid = 1;
 
@@ -794,13 +580,12 @@ void generate_uuid(char *buf) {
        );
 }
 
-/*
- * 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.
- */
+
+// 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 char *_bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen) {
 
        register unsigned char *p, *t;
@@ -811,28 +596,26 @@ inline static char *_bmstrcasestr_len(char *text, size_t textlen, const char *pa
        if (!text) return(NULL);
        if (!pattern) return(NULL);
 
-       /* algorithm fails if pattern is empty */
+       // algorithm fails if pattern is empty
        if ((p1 = patlen) == 0)
                return (text);
 
-       /* code below fails (whenever i is unsigned) if pattern too long */
+       // code below fails (whenever i is unsigned) if pattern too long
        if (p1 > textlen)
                return (NULL);
 
-       /* set up deltas */
+       // 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.
-        */
+       // 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;
@@ -852,6 +635,7 @@ inline static char *_bmstrcasestr_len(char *text, size_t textlen, const char *pa
        return (NULL);
 }
 
+
 /*
  * bmstrcasestr() -- case-insensitive substring search
  *
@@ -877,8 +661,6 @@ char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t p
 }
 
 
-
-
 /*
  * bmstrcasestr() -- case-insensitive substring search
  *
@@ -937,6 +719,7 @@ inline static const char *_cbmstrcasestr_len(const char *text, size_t textlen, c
        return (NULL);
 }
 
+
 /*
  * bmstrcasestr() -- case-insensitive substring search
  *
@@ -957,10 +740,12 @@ const char *cbmstrcasestr(const char *text, const char *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
  * names for temporary files.  Included to shut up compiler warnings.
@@ -980,7 +765,6 @@ 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.
@@ -988,12 +772,10 @@ void CtdlMakeTempFileName(char *name, int len) {
 int is_msg_in_mset(const char *mset, long msgnum) {
        int num_sets;
        int s;
-       char setstr[SIZ], lostr[SIZ], histr[SIZ];       /* was 1024 */
+       char setstr[SIZ], lostr[SIZ], histr[SIZ];
        long lo, hi;
 
-       /*
-        * Now set it for all specified messages.
-        */
+       // 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);
@@ -1018,12 +800,9 @@ int is_msg_in_mset(const char *mset, long msgnum) {
 }
 
 
-/*
- * searches for a pattern within a search string
- * returns position in string
- */
-int pattern2(char *search, char *patn)
-{
+// searches for a pattern within a search string
+// returns position in string
+int pattern2(char *search, char *patn) {
        int a;
        int len, plen;
        len = strlen (search);
@@ -1036,33 +815,10 @@ int pattern2(char *search, char *patn)
 }
 
 
-/*
- * 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)
-{
-       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';
-       }
-}
-
-
 /*
  * Convert all whitespace characters in a supplied string to underscores
  */
-void convert_spaces_to_underscores(char *str)
-{
+void convert_spaces_to_underscores(char *str) {
        int len;
        int i;
 
@@ -1080,8 +836,7 @@ void convert_spaces_to_underscores(char *str)
 /*
  * check whether the provided string needs to be qp encoded or not
  */
-int CheckEncode(const char *pch, long len, const char *pche)
-{
+int CheckEncode(const char *pch, long len, const char *pche) {
        if (pche == NULL)
                pche = pch + len;
        while (pch < pche) {