/*
* $Id$
- *
- * Miscellaneous routines
+ */
+/**
+ * \defgroup MiscRout Miscellaneous routines
+ * \ingroup tools
*/
-#include <ctype.h>
-#include <stdlib.h>
-#include <unistd.h>
-#include <stdio.h>
-#include <fcntl.h>
-#include <signal.h>
-#include <sys/types.h>
-#include <sys/wait.h>
-#include <sys/socket.h>
-#include <sys/time.h>
-#include <limits.h>
-#include <netinet/in.h>
-#include <netdb.h>
-#include <string.h>
-#include <pwd.h>
-#include <errno.h>
-#include <stdarg.h>
-#include <pthread.h>
-#include <signal.h>
-#include <sys/time.h>
+/*@{*/
#include "webcit.h"
#include "webserver.h"
-typedef unsigned char byte;
-
-#define FALSE 0
-#define TRUE 1
-char *ascmonths[] = {
- "Jan", "Feb", "Mar", "Apr", "May", "Jun",
- "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
-};
+typedef unsigned char byte; /**< byte data type */
-char *ascdays[] = {
- "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"
-};
+#define FALSE 0 /**< no. */
+#define TRUE 1 /**< yes. */
-static byte dtable[256]; /* base64 encode / decode table */
+static byte dtable[256]; /**< base64 encode / decode table */
+/**
+ * \brief sanitize strncopy.
+ * \param dest destination string
+ * \param src source string
+ * \param n length of source to copy
+ * \return result string
+ */
char *safestrncpy(char *dest, const char *src, size_t n)
{
if (dest == NULL || src == NULL) {
-/*
- * num_tokens() - discover number of parameters/tokens in a string
+/**
+ * \brief discover number of parameters/tokens in a string
+ * \param source string to inspect
+ * \param tok seperation token
+ * \return number of tokenized parts found
*/
int num_tokens(char *source, char tok)
{
- int a;
+ int a = 0;
int count = 1;
if (source == NULL)
return (count);
}
-/*
- * extract_token() - a string tokenizer
+/**
+ * brief a string tokenizer
+ * \param dest destination string
+ * \param source the string to grab tokens from
+ * \param parmnum the n'th token to grab
+ * \param separator the tokenizer string
+ * \param maxlen the length of dest
*/
void extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen)
{
-/*
- * remove_token() - a tokenizer that kills, maims, and destroys
+/**
+ * \brief a tokenizer that kills, maims, and destroys
+ * \param source the string to process
+ * \param parmnum which token to kill
+ * \param separator the tokenizer string
*/
void remove_token(char *source, int parmnum, char separator)
{
-/*
- * extract_int() - extract an int parm w/o supplying a buffer
+/**
+ * \brief extract an int parm w/o supplying a buffer
+ * \param source the string to locate the int in
+ * \param parmnum the n'th token to grab the int from
+ * \return the integer
*/
int extract_int(const char *source, int parmnum)
{
return(atoi(buf));
}
-/*
- * extract_long() - extract an long parm w/o supplying a buffer
+/**
+ * \brief extract an long parm w/o supplying a buffer
+ * \param source string to examine
+ * \param parmnum n'th token to search long in
+ * \return the found long value
*/
long extract_long(const char *source, int parmnum)
{
-/*
- * check for the presence of a character within a string (returns count)
+/**
+ * \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
*/
-int haschar(st, ch)
-char st[];
-char ch;
+int haschar(char *st,char ch)
{
int a, b;
b = 0;
}
-/*
- * Format a date/time stamp for output
- */
-void fmt_date(char *buf, time_t thetime, int brief)
-{
- struct tm tm;
- struct tm today_tm;
- time_t today_timet;
- int hour;
-
- today_timet = time(NULL);
- localtime_r(&today_timet, &today_tm);
-
- localtime_r(&thetime, &tm);
- hour = tm.tm_hour;
- if (hour == 0)
- hour = 12;
- else if (hour > 12)
- hour = hour - 12;
-
- buf[0] = 0;
-
- if (brief) {
-
- if ((tm.tm_year == today_tm.tm_year)
- &&(tm.tm_mon == today_tm.tm_mon)
- &&(tm.tm_mday == today_tm.tm_mday)) {
- sprintf(buf, "%2d:%02d%s",
- hour, tm.tm_min,
- ((tm.tm_hour >= 12) ? "pm" : "am")
- );
- }
- else {
- sprintf(buf, "%s %d %d",
- ascmonths[tm.tm_mon],
- tm.tm_mday,
- tm.tm_year + 1900
- );
- }
- }
- else {
- sprintf(buf, "%s %d %d %2d:%02d%s",
- ascmonths[tm.tm_mon],
- tm.tm_mday,
- tm.tm_year + 1900,
- hour, tm.tm_min, ((tm.tm_hour >= 12) ? "pm" : "am")
- );
- }
-}
-
-
-
-/*
- * Format TIME ONLY for output
- */
-void fmt_time(char *buf, time_t thetime)
-{
- struct tm *tm;
- int hour;
-
- buf[0] = 0;
- tm = localtime(&thetime);
- hour = tm->tm_hour;
- if (hour == 0)
- hour = 12;
- else if (hour > 12)
- hour = hour - 12;
-
- sprintf(buf, "%d:%02d%s",
- hour, tm->tm_min, ((tm->tm_hour > 12) ? "pm" : "am")
- );
-}
-
-
-
-
-/*
- * Format a date/time stamp to the format used in HTTP headers
- */
-void httpdate(char *buf, time_t thetime)
-{
- struct tm *tm;
-
- buf[0] = 0;
- tm = localtime(&thetime);
-
- sprintf(buf, "%s, %02d %s %4d %02d:%02d:%02d",
- ascdays[tm->tm_wday],
- tm->tm_mday,
- ascmonths[tm->tm_mon],
- tm->tm_year + 1900, tm->tm_hour, tm->tm_min, tm->tm_sec);
-}
-
-
-
-
-
-/*
- * Utility function to "readline" from memory
- * (returns new pointer)
+/**
+ * \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)
{
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;
memset(buf, 0, maxlen);
-/*
- * pattern2() - searches for patn within search string, returns pos
+/**
+ * \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
*/
int pattern2(char *search, char *patn)
{
}
-/*
- * Strip leading and trailing spaces from a string
+/**
+ * \brief Strip leading and trailing spaces from a string
+ * \param buf the string to modify
*/
void striplt(char *buf)
{
}
-/*
- * Determine whether the specified message number is contained within the
+/**
+ * \brief Determine whether the specified message number is contained within the
* specified set.
+ *
+ * \param mset Message set string
+ * \param msgnum Message number we are looking for
+ *
+ * \return Nonzero if the specified message number is in the specified message set string.
*/
int is_msg_in_mset(char *mset, long msgnum) {
int num_sets;
-/*
- * Strip a boundarized substring out of a string (for example, remove
+/**
+ * \brief Strip a boundarized substring out of a string
+ * (for example, remove
* parentheses and anything inside them).
*
* This improved version can strip out *multiple* boundarized substrings.
+ * \param str the string to process
+ * \param leftboundary the boundary character on the left side of the target string
+ * \param rightboundary the boundary character on the right side of the target string
*/
void stripout(char *str, char leftboundary, char rightboundary)
{
-/*
- * Replacement for sleep() that uses select() in order to avoid SIGALRM
+/**
+ * \brief Replacement for sleep() that uses select() in order to avoid SIGALRM
+ * \param seconds how many seconds should we sleep?
*/
void sleeeeeeeeeep(int seconds)
{
-/*
+/**
+ * \brief encode a string into base64 to for example tunnel it through mail transport
* CtdlDecodeBase64() and CtdlEncodeBase64() are adaptations of code by
* John Walker, copied over from the Citadel server.
+ * \param dest encrypted string
+ * \param source the string to encrypt
+ * \param sourcelen the length of the source data (may contain string terminators)
*/
void CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen)
int dpos = 0;
int thisline = 0;
- /* Fill dtable with character encodings. */
+ /** Fill dtable with character encodings. */
for (i = 0; i < 26; i++) {
dtable[i] = 'A' + i;
(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. */
+ /**
+ * 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] = '=';
}
-/*
- * Convert base64-encoded to binary. Returns the length of the decoded data.
+/**
+ * \brief Convert base64-encoded to binary.
* It will stop after reading 'length' bytes.
+ *
+ * \param dest The destination buffer
+ * \param source The base64 data to be decoded.
+ * \param length The number of bytes to decode.
+ * \return The actual length of the decoded data.
*/
int CtdlDecodeBase64(char *dest, const char *source, size_t length)
{
dtable['/'] = 63;
dtable['='] = 0;
- /*CONSTANTCONDITION*/ while (TRUE) {
+ /**CONSTANTCONDITION*/ while (TRUE) {
byte a[4], b[4], o[3];
for (i = 0; i < 4; i++) {
return (dpos);
}
if (dtable[c] & 0x80) {
- /* Ignoring errors: discard invalid character */
+ /** Ignoring errors: discard invalid character */
i--;
continue;
}
}
-/*
- * Generate a new, globally unique UID parameter for a calendar etc. object
+
+/**
+ * \brief Generate a new, globally unique UID parameter for a calendar etc. object
+ *
+ * \param buf String buffer into which our newly created UUID should be placed
*/
void generate_uuid(char *buf) {
static int seq = 0;
- sprintf(buf, "%08x-%04x-%04x-%04x-%012x",
- (int)time(NULL),
- (seq++),
+ sprintf(buf, "%s-%lx-%x-%x",
+ serv_info.serv_nodename,
+ (long)time(NULL),
getpid(),
- rand(),
- rand()
+ (seq++)
);
}
+
+/**
+ * \brief Local replacement for controversial C library function that generates
+ * names for temporary files. Included to shut up compiler warnings.
+ * \todo return a fd to the file instead of the name for security reasons
+ * \param name the created filename
+ * \param len the length of the filename
+ */
+void CtdlMakeTempFileName(char *name, int len) {
+ int i = 0;
+
+ while (i++, i < 100) {
+ snprintf(name, len, "/tmp/ctdl.%04x.%04x",
+ getpid(),
+ rand()
+ );
+ if (!access(name, F_OK)) {
+ return;
+ }
+ }
+}
+
+
+
+/*@}*/
projects / citadel.git / blobdiff