// 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
+// Copyright (c) 1987-2023 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
-
+// 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>
#include <sys/stat.h>
#include <errno.h>
#include <limits.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 <time.h>
#include "libcitadel.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
//
char *d, *s; // dest, source
int count = 0;
- /* Find desired parameter */
+ // Find desired parameter
d = source;
while (count < parmnum) {
// End of string, bail!
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))) {
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]='=';
}
-// 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;
}
-/*
- * 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)
-{
+// 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;
}
-/*
- * Determine whether the specified message number is contained within the
- * specified sequence set.
- */
-int is_msg_in_sequence_set(const char *mset, long msgnum)
-{
+// 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;
char setstr[128], lostr[128], histr[128];
extract_token(setstr, mset, s, ',', sizeof setstr);
extract_token(lostr, setstr, 0, ':', sizeof lostr);
- if (num_tokens(setstr, ':') >= 2)
- {
+ if (num_tokens(setstr, ':') >= 2) {
extract_token(histr, setstr, 1, ':', sizeof histr);
- if (!strcmp(histr, "*"))
- {
+ if (!strcmp(histr, "*")) {
snprintf(histr, sizeof histr, "%ld", LONG_MAX);
}
}
- else
- {
+ else {
strcpy(histr, lostr);
}
lo = atol(lostr);
return(0);
}
-/*
- * 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)
-{
+// 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;
}
-/*
- * 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)
-{
+// 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;
- while (1)
- {
+ while (1) {
ch = *ptr++;
- if ((len + 1 < (maxlen)) && (ch != 13) && (ch != 10))
- {
+ if ((len + 1 < (maxlen)) && (ch != 13) && (ch != 10)) {
buf[len++] = ch;
}
- if ((ch == 10) || (ch == 0))
- {
+ if ((ch == 10) || (ch == 0)) {
buf[len] = 0;
*retlen = len;
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
- * \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;
}
-/**
- * \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;
}
-/*
- * Strip a boundarized substring out of a string (for example, remove
- * parentheses and anything inside them).
- */
+// 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;
-}
+ long lb = (-1);
+ long rb = (-1);
+ if (!str) {
+ return 0;
+ }
-/*
- * 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);
+ for (int a = 0; str[a]; ++a) {
+ if ((lb==-1) && (str[a] == leftboundary)) {
+ lb = a;
+ } else if (str[a] == rightboundary) {
+ rb = a;
}
}
- return (long)strlen(str);
+ if ((lb==-1) || (rb <= lb)) {
+ return 0;
+ }
+
+ 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 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++;
+ }
+
+ 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);
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 = " +#&;`'|*?-~<>^()[]{}/$\"\\";
}
-
-/*
- * 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
}
-/*
- * 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;
}
}
- /* 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;
);
}
-/*
- * 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;
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;
return (NULL);
}
+
/*
* bmstrcasestr() -- case-insensitive substring search
*
}
-
-
/*
* bmstrcasestr() -- case-insensitive substring search
*
return (NULL);
}
+
/*
* bmstrcasestr() -- case-insensitive substring search
*
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.
}
-
/*
* 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(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);
}
-/*
- * 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);
}
-/*
- * 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;
/*
* 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) {