-const char miscutil_rcs[] = "$Id: miscutil.c,v 1.68 2011/09/04 11:10:56 fabiankeil Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/miscutil.c,v $
* to deserve their own file but don't really fit in
* any other file.
*
- * Copyright : Written by and Copyright (C) 2001-2011 the
- * Privoxy team. http://www.privoxy.org/
+ * Copyright : Written by and Copyright (C) 2001-2020 the
+ * Privoxy team. https://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
* by and Copyright (C) 1997 Anonymous Coders and
#include "project.h"
#include "miscutil.h"
-#include "errlog.h"
#include "jcc.h"
-
-const char miscutil_h_rcs[] = MISCUTIL_H_VERSION;
+#include "errlog.h"
/*********************************************************************
*
* Function : zalloc
*
- * Description : Malloc some memory and set it to '\0'.
+ * Description : Returns allocated memory that is initialized
+ * with zeros.
*
* Parameters :
* 1 : size = Size of memory chunk to return.
*
- * Returns : Pointer to newly malloc'd memory chunk.
+ * Returns : Pointer to newly alloc'd memory chunk.
*
*********************************************************************/
void *zalloc(size_t size)
{
void * ret;
+#ifdef HAVE_CALLOC
+ ret = calloc(1, size);
+#else
+#warning calloc appears to be unavailable. Your platform will become unsupported in the future
if ((ret = (void *)malloc(size)) != NULL)
{
memset(ret, 0, size);
}
+#endif
return(ret);
}
+/*********************************************************************
+ *
+ * Function : zalloc_or_die
+ *
+ * Description : zalloc wrapper that either succeeds or causes
+ * program termination.
+ *
+ * Useful in situations were the string length is
+ * "small" and zalloc() failures couldn't be handled
+ * better anyway. In case of debug builds, failures
+ * trigger an assert().
+ *
+ * Parameters :
+ * 1 : size = Size of memory chunk to return.
+ *
+ * Returns : Pointer to newly malloc'd memory chunk.
+ *
+ *********************************************************************/
+void *zalloc_or_die(size_t size)
+{
+ void *buffer;
+
+ buffer = zalloc(size);
+ if (buffer == NULL)
+ {
+ assert(buffer != NULL);
+ log_error(LOG_LEVEL_FATAL, "Out of memory in zalloc_or_die().");
+ exit(1);
+ }
+
+ return(buffer);
+
+}
+
+/*********************************************************************
+ *
+ * Function : strdup_or_die
+ *
+ * Description : strdup wrapper that either succeeds or causes
+ * program termination.
+ *
+ * Useful in situations were the string length is
+ * "small" and strdup() failures couldn't be handled
+ * better anyway. In case of debug builds, failures
+ * trigger an assert().
+ *
+ * Parameters :
+ * 1 : str = String to duplicate
+ *
+ * Returns : Pointer to newly strdup'd copy of the string.
+ *
+ *********************************************************************/
+char *strdup_or_die(const char *str)
+{
+ char *new_str;
+
+ new_str = strdup(str);
+
+ if (new_str == NULL)
+ {
+ assert(new_str != NULL);
+ log_error(LOG_LEVEL_FATAL, "Out of memory in strdup_or_die().");
+ exit(1);
+ }
+
+ return(new_str);
+
+}
+
+
+/*********************************************************************
+ *
+ * Function : malloc_or_die
+ *
+ * Description : malloc wrapper that either succeeds or causes
+ * program termination.
+ *
+ * Useful in situations were the buffer size is "small"
+ * and malloc() failures couldn't be handled better
+ * anyway. In case of debug builds, failures trigger
+ * an assert().
+ *
+ * Parameters :
+ * 1 : buffer_size = Size of the space to allocate
+ *
+ * Returns : Pointer to newly malloc'd memory
+ *
+ *********************************************************************/
+void *malloc_or_die(size_t buffer_size)
+{
+ char *new_buf;
+
+ if (buffer_size == 0)
+ {
+ log_error(LOG_LEVEL_ERROR,
+ "malloc_or_die() called with buffer size 0");
+ assert(buffer_size != 0);
+ buffer_size = 4096;
+ }
+
+ new_buf = malloc(buffer_size);
+
+ if (new_buf == NULL)
+ {
+ assert(new_buf != NULL);
+ log_error(LOG_LEVEL_FATAL, "Out of memory in malloc_or_die().");
+ exit(1);
+ }
+
+ return(new_buf);
+
+}
+
+
#if defined(unix)
/*********************************************************************
*
* Function : write_pid_file
*
- * Description : Writes a pid file with the pid of the main process
+ * Description : Writes a pid file with the pid of the main process.
+ * Exits if the file can't be opened
*
- * Parameters : None
+ * Parameters :
+ * 1 : pid_file = Path of the pid file that gets created.
*
* Returns : N/A
*
*********************************************************************/
-void write_pid_file(void)
+void write_pid_file(const char *pid_file)
{
FILE *fp;
- /*
- * If no --pidfile option was given,
- * we can live without one.
- */
- if (pidfile == NULL) return;
-
- if ((fp = fopen(pidfile, "w")) == NULL)
+ if ((fp = fopen(pid_file, "w")) == NULL)
{
- log_error(LOG_LEVEL_INFO, "can't open pidfile '%s': %E", pidfile);
+ log_error(LOG_LEVEL_FATAL, "can't open pid file '%s': %E", pid_file);
}
else
{
* Function : hash_string
*
* Description : Take a string and compute a (hopefuly) unique numeric
- * integer value. This has several uses, but being able
- * to "switch" a string the one of my favorites.
+ * integer value. This is useful to "switch" a string.
*
* Parameters :
* 1 : s : string to be hashed.
*
- * Returns : an unsigned long variable with the hashed value.
+ * Returns : The string's hash
*
*********************************************************************/
-unsigned int hash_string( const char* s )
+unsigned int hash_string(const char* s)
{
unsigned int h = 0;
- for ( ; *s; ++s )
+ for (; *s; ++s)
{
h = 5 * h + (unsigned int)*s;
}
while (*s1 && *s2)
{
- if ( ( *s1 != *s2 ) && ( ijb_tolower(*s1) != ijb_tolower(*s2) ) )
+ if ((*s1 != *s2) && (privoxy_tolower(*s1) != privoxy_tolower(*s2)))
{
break;
}
s1++, s2++;
}
- return(ijb_tolower(*s1) - ijb_tolower(*s2));
+ return(privoxy_tolower(*s1) - privoxy_tolower(*s2));
}
while (*s1 && *s2)
{
- if ( ( *s1 != *s2 ) && ( ijb_tolower(*s1) != ijb_tolower(*s2) ) )
+ if ((*s1 != *s2) && (privoxy_tolower(*s1) != privoxy_tolower(*s2)))
{
break;
}
s1++, s2++;
}
- return(ijb_tolower(*s1) - ijb_tolower(*s2));
+ return(privoxy_tolower(*s1) - privoxy_tolower(*s2));
}
* strip trailing whitespace
*/
p = string + strlen(string);
- while (p > string && ijb_isspace(*(p-1)))
+ while (p > string && privoxy_isspace(*(p-1)))
{
p--;
}
* find end of leading whitespace
*/
q = r = string;
- while (*q && ijb_isspace(*q))
+ while (*q && privoxy_isspace(*q))
{
q++;
}
}
+/*********************************************************************
+ *
+ * Function : string_move
+ *
+ * Description : memmove wrapper to move the last part of a string
+ * towards the beginning, overwriting the part in
+ * the middle. strlcpy() can't be used here as the
+ * strings overlap.
+ *
+ * Parameters :
+ * 1 : dst = Destination to overwrite
+ * 2 : src = Source to move.
+ *
+ * Returns : N/A
+ *
+ *********************************************************************/
+void string_move(char *dst, char *src)
+{
+ assert(dst < src);
+
+ /* +1 to copy the terminating nul as well. */
+ memmove(dst, src, strlen(src)+1);
+}
+
+
/*********************************************************************
*
* Function : bindup
{
char *duplicate;
- if (NULL == (duplicate = (char *)malloc(len)))
+ duplicate = (char *)malloc(len);
+ if (NULL != duplicate)
{
- return NULL;
- }
- else
- {
- memcpy(duplicate, string, len);
+ memcpy(duplicate, string, len);
}
return duplicate;
*********************************************************************/
char * make_path(const char * dir, const char * file)
{
-#ifdef AMIGA
- char path[512];
-
- if(dir)
- {
- if(dir[0] == '.')
- {
- if(dir[1] == '/')
- {
- strncpy(path,dir+2,512);
- }
- else
- {
- strncpy(path,dir+1,512);
- }
- }
- else
- {
- strncpy(path,dir,512);
- }
- path[511]=0;
- }
- else
- {
- path[0]=0;
- }
- if(AddPart(path,file,512))
- {
- return strdup(path);
- }
- else
- {
- return NULL;
- }
-#else /* ndef AMIGA */
-
if ((file == NULL) || (*file == '\0'))
{
return NULL; /* Error */
size_t path_size = strlen(dir) + strlen(file) + 2; /* +2 for trailing (back)slash and \0 */
#if defined(unix)
- if ( *dir != '/' && basedir && *basedir )
+ if (*dir != '/' && basedir && *basedir)
{
/*
* Relative path, so start with the base directory.
*/
path_size += strlen(basedir) + 1; /* +1 for the slash */
path = malloc(path_size);
- if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
+ if (!path) log_error(LOG_LEVEL_FATAL, "malloc failed!");
strlcpy(path, basedir, path_size);
strlcat(path, "/", path_size);
strlcat(path, dir, path_size);
#endif /* defined unix */
{
path = malloc(path_size);
- if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
+ if (!path) log_error(LOG_LEVEL_FATAL, "malloc failed!");
strlcpy(path, dir, path_size);
}
assert(NULL != path);
#if defined(_WIN32) || defined(__OS2__)
- if(path[strlen(path)-1] != '\\')
+ if (path[strlen(path)-1] != '\\')
{
strlcat(path, "\\", path_size);
}
#else /* ifndef _WIN32 || __OS2__ */
- if(path[strlen(path)-1] != '/')
+ if (path[strlen(path)-1] != '/')
{
strlcat(path, "/", path_size);
}
return path;
}
-#endif /* ndef AMIGA */
}
if (range <= 0) return 0;
-#ifdef HAVE_RANDOM
+#ifdef HAVE_ARC4RANDOM
+ number = arc4random() % range + 1;
+#elif defined(HAVE_RANDOM)
number = random() % range + 1;
#elif defined(MUTEX_LOCKS_AVAILABLE)
privoxy_mutex_lock(&rand_mutex);
"might cause crashes, predictable results or even combine these fine options.");
number = rand() % (long int)(range + 1);
-#endif /* (def HAVE_RANDOM) */
+#endif /* (def HAVE_ARC4RANDOM) */
return number;
}
#endif /* ndef HAVE_STRLCAT */
+/*********************************************************************
+ *
+ * Function : privoxy_millisleep
+ *
+ * Description : Sleep a number of milliseconds
+ *
+ * Parameters :
+ * 1 : delay: Number of milliseconds to sleep
+ *
+ * Returns : -1 on error, 0 otherwise
+ *
+ *********************************************************************/
+int privoxy_millisleep(unsigned milliseconds)
+{
+#ifdef HAVE_NANOSLEEP
+ struct timespec rqtp = {0};
+ struct timespec rmtp = {0};
+
+ rqtp.tv_sec = milliseconds / 1000;
+ rqtp.tv_nsec = (milliseconds % 1000) * 1000 * 1000;
+
+ return nanosleep(&rqtp, &rmtp);
+#elif defined (_WIN32)
+ Sleep(milliseconds);
+
+ return 0;
+#elif defined(__OS2__)
+ DosSleep(milliseconds * 10);
+
+ return 0;
+#else
+#warning Missing privoxy_milisleep() implementation. delay-response{} will not work.
+
+ return -1;
+#endif /* def HAVE_NANOSLEEP */
+
+}
+
+
+/*********************************************************************
+ *
+ * Function : privoxy_gmtime_r
+ *
+ * Description : Behave like gmtime_r() and convert a
+ * time_t to a struct tm.
+ *
+ * Parameters :
+ * 1 : time_spec: The time to convert
+ * 2 : result: The struct tm to use as storage
+ *
+ * Returns : Pointer to the result or NULL on error.
+ *
+ *********************************************************************/
+struct tm *privoxy_gmtime_r(const time_t *time_spec, struct tm *result)
+{
+ struct tm *timeptr;
+
+#ifdef HAVE_GMTIME_R
+ timeptr = gmtime_r(time_spec, result);
+#elif defined(MUTEX_LOCKS_AVAILABLE)
+ privoxy_mutex_lock(&gmtime_mutex);
+ timeptr = gmtime(time_spec);
+#else
+#warning Using unlocked gmtime()
+ timeptr = gmtime(time_spec);
+#endif
+
+ if (timeptr == NULL)
+ {
+#if !defined(HAVE_GMTIME_R) && defined(MUTEX_LOCKS_AVAILABLE)
+ privoxy_mutex_unlock(&gmtime_mutex);
+#endif
+ return NULL;
+ }
+
+#if !defined(HAVE_GMTIME_R)
+ *result = *timeptr;
+ timeptr = result;
+#ifdef MUTEX_LOCKS_AVAILABLE
+ privoxy_mutex_unlock(&gmtime_mutex);
+#endif
+#endif
+
+ return timeptr;
+}
+
#if !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV)
/*********************************************************************
*
strcat(old_zone, zone);
putenv(old_zone);
#ifdef _WIN32
+ /* http://man7.org/linux/man-pages/man3/putenv.3.html
+ * int putenv(char *string);
+ * The string pointed to by string becomes part of the environment, so altering the
+ * string changes the environment.
+ * In other words, the memory pointed to by *string is used until
+ * a) another call to putenv() with the same e-var name
+ * b) the program exits
+ *
+ * Windows e-vars don't work that way, so let's not leak memory.
+ */
free(old_zone);
#endif /* def _WIN32 */
}
projects / privoxy.git / blobdiff