war on old style
[citadel.git] / libcitadel / lib / tools.c
index 57e1e8ce3d6cefce9b535ae60d3abd0cc806b8ad..131cc2f7ae98f1fb83f8553ebb568921ca7a118e 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-2017 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>
 
 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)
@@ -81,23 +62,17 @@ 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;
 
-       if (source == NULL)
-       {
+       if (source == NULL) {
                return (0);
        }
 
-       while (*ptr != '\0')
-       {
-               if (*ptr++ == tok)
-               {
+       while (*ptr != '\0') {
+               if (*ptr++ == tok) {
                        ++count;
                }
        }
@@ -106,92 +81,76 @@ int num_tokens(const char *source, char tok)
 }
 
 
-/*
- * 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;
 
-       if (dest == NULL)
-       {
+       if (dest == NULL) {
                return(-1);
        }
 
        dest[0] = 0;
 
-       if (s == NULL)
-       {
+       if (s == NULL) {
                return(-1);
        }
        
        maxlen--;
 
-       while (*s)
-       {
-               if (*s == separator)
-               {
+       while (*s) {
+               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;
                }
-               else if ((current_token > parmnum) || (len >= maxlen))
-               {
+               else if ((current_token > parmnum) || (len >= maxlen)) {
                        break;
                }
                ++s;
        }
 
        dest[len] = '\0';
-       if (current_token < parmnum)
-       {
+       if (current_token < parmnum) {
                return(-1);
        }
        return(len);
 }
 
 
-/*
- * 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 */
        d = source;
-       while (count < parmnum)
-       {
-               /* End of string, bail! */
+       while (count < parmnum) {
+               // End of string, bail!
                if (!*d) {
                        d = NULL;
                        break;
                }
-               if (*d == separator)
-               {
+               if (*d == separator) {
                        count++;
                }
                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)
-       {
+       while (*s && *s != separator) {
                s++;
        }
 
-       /* Hack and slash */
+       // Hack and slash
        if (*s)
                strcpy(d, ++s);
        else if (d == source)
@@ -201,11 +160,8 @@ void remove_token(char *source, int parmnum, char separator)
 }
 
 
-/*
- * 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)
@@ -215,11 +171,8 @@ int extract_int(const char *source, int parmnum)
 }
 
 
-/*
- * 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)
@@ -229,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)
@@ -243,70 +193,8 @@ unsigned long extract_unsigned_long(const char *source, int parmnum)
 }
 
 
-size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks)
-{
-       int breaklength = 68;   // must be a multiple of 4
-       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, 0);
-       }
-       else {
-               destoffset = base64_encode_block(source, sourcelen, dest, &_state);
-
-               destoffset += base64_encode_blockend(&(dest[destoffset]), &_state, 0);
-       }
-       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;
@@ -314,16 +202,13 @@ char *rfc2047encode(const char *line, long length)
 
        /* 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]='=';
@@ -331,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;
@@ -362,9 +244,7 @@ void StripSlashes(char *Dir, int TrailingSlash)
 }
 
 
-/*
- * Strip leading and trailing spaces from a string
- */
+// Strip leading and trailing spaces from a string
 size_t striplt(char *buf) {
        char *first_nonspace = NULL;
        char *last_nonspace = NULL;
@@ -402,8 +282,7 @@ size_t striplt(char *buf) {
  * ch  the char to search
  * returns 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;
        b = 0;
@@ -422,8 +301,7 @@ int haschar(const char *st, int ch)
  * 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 is_msg_in_sequence_set(const char *mset, long msgnum) {
        int num_sets;
        int s;
        char setstr[128], lostr[128], histr[128];
@@ -462,8 +340,7 @@ int is_msg_in_sequence_set(const char *mset, long msgnum)
  * 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 *memreadline(char *start, char *buf, int maxlen) {
        char ch;
        char *ptr;
        int len = 0;            /* tally our own length to avoid strlen() delays */
@@ -491,8 +368,7 @@ char *memreadline(char *start, char *buf, int maxlen)
  * 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 *memreadlinelen(char *start, char *buf, int maxlen, int *retlen) {
        char ch;
        char *ptr;
        int len = 0;            /* tally our own length to avoid strlen() delays */
@@ -788,6 +664,7 @@ inline static char *_bmstrcasestr_len(char *text, size_t textlen, const char *pa
        return (NULL);
 }
 
+
 /*
  * bmstrcasestr() -- case-insensitive substring search
  *
@@ -813,8 +690,6 @@ char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t p
 }
 
 
-
-
 /*
  * bmstrcasestr() -- case-insensitive substring search
  *
@@ -873,6 +748,7 @@ inline static const char *_cbmstrcasestr_len(const char *text, size_t textlen, c
        return (NULL);
 }
 
+
 /*
  * bmstrcasestr() -- case-insensitive substring search
  *
@@ -893,10 +769,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.
@@ -916,7 +794,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.
@@ -924,12 +801,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);
@@ -954,12 +829,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);
@@ -977,8 +849,7 @@ int pattern2(char *search, char *patn)
  * buf - the string to modify
  * len - length of the string. 
  */
-void stripltlen(char *buf, int *len)
-{
+void stripltlen(char *buf, int *len) {
        int delta = 0;
        if (*len == 0) return;
        while ((*len > delta) && (isspace(buf[delta]))){
@@ -997,8 +868,7 @@ void stripltlen(char *buf, int *len)
 /*
  * 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;
 
@@ -1016,8 +886,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) {