/*
* $Id$
- *
- * Miscellaneous routines
+ */
+/**
+ * \defgroup MiscRout Miscellaneous routines
*/
-#include <ctype.h>
-#include <stdlib.h>
-#ifdef HAVE_UNISTD_H
-#include <unistd.h>
-#endif
-#include <stdio.h>
-#ifdef HAVE_FCNTL_H
-#include <fcntl.h>
-#endif
-#include <signal.h>
-#include <sys/types.h>
-#include <sys/wait.h>
-#include <sys/socket.h>
-#ifdef HAVE_SYS_TIME_H
-#include <sys/time.h>
-#endif
-#ifdef HAVE_LIMITS_H
-#include <limits.h>
-#endif
-#include <netinet/in.h>
-#include <arpa/inet.h>
-#include <netdb.h>
-#include <string.h>
-#include <pwd.h>
-#include <errno.h>
-#include <stdarg.h>
-#include <pthread.h>
-#include <signal.h>
+/*@{*/
#include "webcit.h"
#include "webserver.h"
-typedef unsigned char byte;
+typedef unsigned char byte; /**< byte data type */
-#define FALSE 0
-#define TRUE 1
+#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)
{
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[];
}
-/*
- * Utility function to "readline" from memory
- * (returns new pointer)
+/**
+ * \brief Utility function to "readline" from memory
+ * \param start position in buf
+ * \param buf the buffer to create string in???
+ * \param maxlen how big may the buffer get?
+ * \return new pointer to read string
*/
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 stringset???
+ * \param msgnum a citadel server indexnumber
+ * \return yes / no ???
*/
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 encrypted string
+ * \param length the maximal length of dest???
+ * \return the length 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 uid to create ????
*/
void generate_uuid(char *buf) {
static int seq = 0;
);
}
+
+/**
+ * \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