/*
* utils.c -- various utility routines
*
- * $Id$
- *
* This code is Copyright (c) 2006, by the authors of nmh. See the
* COPYRIGHT file in the root directory of the nmh distribution for
* complete copyright information.
#include <h/mh.h>
#include <h/utils.h>
-#include <stdlib.h>
+#include <fcntl.h>
+
+/* sbr/signals.c */
+extern int setup_signal_handlers();
+
+/* sbr/m_mktemp.c */
+extern void remove_registered_files_atexit();
+
+extern char *mhdocdir;
/*
- * Safely call malloc
+ * We allocate space for messages (msgs array)
+ * this number of elements at a time.
*/
-void *
-mh_xmalloc(size_t size)
+#define MAXMSGS 256
+
+/* Call malloc(3), exiting on NULL return. */
+void *mh_xmalloc(size_t size)
{
- void *memory;
+ void *p;
if (size == 0)
- adios(NULL, "Tried to malloc 0 bytes");
+ size = 1; /* Some mallocs don't like 0. */
+ p = malloc(size);
+ if (!p)
+ adios(NULL, "malloc failed, size wanted: %zu", size);
+
+ return p;
+}
+
+/* Call realloc(3), exiting on NULL return. */
+void *mh_xrealloc(void *ptr, size_t size)
+{
+ void *new;
+
+ /* Copy POSIX behaviour, coping with non-POSIX systems. */
+ if (size == 0) {
+ if (ptr) {
+ free(ptr);
+ }
+ return mh_xmalloc(1); /* Get a unique pointer. */
+ }
+ if (!ptr)
+ return mh_xmalloc(size);
- memory = malloc(size);
- if (!memory)
- adios(NULL, "Malloc failed");
+ new = realloc(ptr, size);
+ if (!new)
+ adios(NULL, "realloc failed, size wanted: %zu", size);
- return memory;
+ return new;
}
-/*
- * Safely call realloc
- */
-void *
-mh_xrealloc(void *ptr, size_t size)
+/* Call calloc(3), exiting on NULL return. */
+void *mh_xcalloc(size_t nelem, size_t elsize)
{
- void *memory;
+ void *p;
- if (size == 0)
- adios(NULL, "Tried to realloc 0bytes");
+ if (!nelem || !elsize)
+ return mh_xmalloc(1); /* Get a unique pointer. */
- memory = realloc(ptr, size);
- if (!memory)
- adios(NULL, "Realloc failed");
+ p = calloc(nelem, elsize);
+ if (!p)
+ adios(NULL, "calloc failed, size wanted: %zu * %zu", nelem, elsize);
- return memory;
+ return p;
+}
+
+/* Duplicate a NUL-terminated string, exit on failure. */
+char *mh_xstrdup(const char *src)
+{
+ size_t n;
+ char *dest;
+
+ n = strlen(src) + 1; /* Ignore possibility of overflow. */
+ dest = mh_xmalloc(n);
+ memcpy(dest, src, n);
+
+ return dest;
+}
+
+/* Call free(3), if ptr isn't NULL. */
+void mh_xfree(void *ptr)
+{
+ if (ptr)
+ free(ptr); /* Some very old platforms can't cope with NULL. */
}
/*
char *
pwd(void)
{
- register char *cp;
+ char *cp;
static char curwd[PATH_MAX];
if (!getcwd (curwd, PATH_MAX)) {
if (!mypath || !*mypath
|| (strcpy (curwd, mypath), chdir (curwd)) == -1) {
strcpy (curwd, "/");
- chdir (curwd);
+ if (chdir (curwd) < 0) {
+ advise (curwd, "chdir");
+ }
}
return curwd;
}
return curwd;
}
+
+/*
+ * add -- If "s1" is NULL, this routine just creates a
+ * -- copy of "s2" into newly malloc'ed memory.
+ * --
+ * -- If "s1" is not NULL, then copy the concatenation
+ * -- of "s1" and "s2" (note the order) into newly
+ * -- malloc'ed memory. Then free "s1".
+ */
+char *
+add (const char *s2, char *s1)
+{
+ char *cp;
+ size_t len1 = 0, len2 = 0;
+
+ if (s1)
+ len1 = strlen (s1);
+ if (s2)
+ len2 = strlen (s2);
+
+ cp = mh_xmalloc (len1 + len2 + 1);
+
+ /* Copy s1 and free it */
+ if (s1) {
+ memcpy (cp, s1, len1);
+ free (s1);
+ }
+
+ /* Copy s2 */
+ if (s2)
+ memcpy (cp + len1, s2, len2);
+
+ /* Now NULL terminate the string */
+ cp[len1 + len2] = '\0';
+
+ return cp;
+}
+
+/*
+ * addlist
+ * Append an item to a comma separated list
+ */
+char *
+addlist (char *list, const char *item)
+{
+ if (list)
+ list = add (", ", list);
+
+ return add (item, list);
+}
+
+/*
+ * folder_exists
+ * Check to see if a folder exists.
+ */
+int folder_exists(const char *folder)
+{
+ struct stat st;
+ int exists = 0;
+
+ if (stat (folder, &st) == -1) {
+ /* The folder either doesn't exist, or we hit an error. Either way
+ * return a failure.
+ */
+ exists = 0;
+ } else {
+ /* We can see a folder with the right name */
+ exists = 1;
+ }
+
+ return exists;
+}
+
+
+/*
+ * create_folder
+ * Check to see if a folder exists, if not, prompt the user to create
+ * it.
+ */
+void create_folder(char *folder, int autocreate, void (*done_callback)(int))
+{
+ struct stat st;
+ extern int errno;
+ char *cp;
+
+ if (stat (folder, &st) == -1) {
+ if (errno != ENOENT)
+ adios (folder, "error on folder");
+ if (autocreate == 0) {
+ /* ask before creating folder */
+ cp = concat ("Create folder \"", folder, "\"? ", NULL);
+ if (!read_yes_or_no_if_tty (cp))
+ done_callback (1);
+ free (cp);
+ } else if (autocreate == -1) {
+ /* do not create, so exit */
+ done_callback (1);
+ }
+ if (!makedir (folder))
+ adios (NULL, "unable to create folder %s", folder);
+ }
+}
+
+/*
+ * num_digits
+ * Return the number of digits in a nonnegative integer.
+ */
+int
+num_digits (int n)
+{
+ int ndigits = 0;
+
+ /* Sanity check */
+ if (n < 0)
+ adios (NULL, "oops, num_digits called with negative value");
+
+ if (n == 0)
+ return 1;
+
+ while (n) {
+ n /= 10;
+ ndigits++;
+ }
+
+ return ndigits;
+}
+
+/*
+ * Append a message arg to an array of them, resizing it if necessary.
+ * Really a simple vector-of-(char *) maintenance routine.
+ */
+void
+app_msgarg(struct msgs_array *msgs, char *cp)
+{
+ if(msgs->size >= msgs->max) {
+ msgs->max += MAXMSGS;
+ msgs->msgs = mh_xrealloc(msgs->msgs,
+ msgs->max * sizeof(*msgs->msgs));
+ }
+ msgs->msgs[msgs->size++] = cp;
+}
+
+/*
+ * Append a message number to an array of them, resizing it if necessary.
+ * Like app_msgarg, but with a vector-of-ints instead.
+ */
+
+void
+app_msgnum(struct msgnum_array *msgs, int msgnum)
+{
+ if (msgs->size >= msgs->max) {
+ msgs->max += MAXMSGS;
+ msgs->msgnums = mh_xrealloc(msgs->msgnums,
+ msgs->max * sizeof(*msgs->msgnums));
+ }
+ msgs->msgnums[msgs->size++] = msgnum;
+}
+
+/* Open a form or components file */
+int
+open_form(char **form, char *def)
+{
+ int in;
+ if (*form) {
+ if ((in = open (etcpath (*form), O_RDONLY)) == NOTOK)
+ adios (*form, "unable to open form file");
+ } else {
+ if ((in = open (etcpath (def), O_RDONLY)) == NOTOK)
+ adios (def, "unable to open default components file");
+ *form = def;
+ }
+ return in;
+}
+
+
+/*
+ * Finds first occurrence of str in buf. buf is not a C string but a
+ * byte array of length buflen. str is a null-terminated C string.
+ * find_str() does not modify buf but passes back a non-const char *
+ * pointer so that the caller can modify it.
+ */
+char *
+find_str (const char buf[], size_t buflen, const char *str) {
+ const size_t len = strlen (str);
+ size_t i;
+
+ for (i = 0; i + len <= buflen; ++i, ++buf) {
+ if (! memcmp (buf, str, len)) return (char *) buf;
+ }
+
+ return NULL;
+}
+
+
+/*
+ * Finds last occurrence of str in buf. buf is not a C string but a
+ * byte array of length buflen. str is a null-terminated C string.
+ * find_str() does not modify buf but passes back a non-const char *
+ * pointer so that the caller can modify it.
+ */
+char *
+rfind_str (const char buf[], size_t buflen, const char *str) {
+ const size_t len = strlen (str);
+ size_t i;
+
+ for (i = 0, buf += buflen - len; i + len <= buflen; ++i, --buf) {
+ if (! memcmp (buf, str, len)) return (char *) buf;
+ }
+
+ return NULL;
+}
+
+
+/* POSIX doesn't have strcasestr() so emulate it. */
+char *
+nmh_strcasestr (const char *s1, const char *s2) {
+ const size_t len = strlen (s2);
+
+ if (isupper ((unsigned char) s2[0]) || islower ((unsigned char)s2[0])) {
+ char first[3];
+ first[0] = (char) toupper ((unsigned char) s2[0]);
+ first[1] = (char) tolower ((unsigned char) s2[0]);
+ first[2] = '\0';
+
+ for (s1 = strpbrk (s1, first); s1; s1 = strpbrk (++s1, first)) {
+ if (! strncasecmp (s1, s2, len)) return (char *) s1;
+ }
+ } else {
+ for (s1 = strchr (s1, s2[0]); s1; s1 = strchr (++s1, s2[0])) {
+ if (! strncasecmp (s1, s2, len)) return (char *) s1;
+ }
+ }
+
+ return NULL;
+}
+
+
+/* EndsWithC returns true if non-NULL string s ends with a c before the
+ * terminating NUL. */
+bool EndsWithC(char *s, int c)
+{
+ return *s && s[strlen(s) - 1] == c;
+}
+
+
+/* TrimSuffixC deletes c from the end of non-NULL string s if it's
+ * present, shortening s by 1. Only one instance of c is removed. */
+void TrimSuffixC(char *s, int c)
+{
+ if (!*s)
+ return;
+
+ s += strlen(s) - 1;
+ if (*s == c)
+ *s = '\0';
+}
+
+
+int
+nmh_init(const char *argv0, int read_context) {
+ int status = OK;
+ char *locale;
+
+ invo_name = r1bindex ((char *) argv0, '/');
+
+ if (setup_signal_handlers()) {
+ admonish("sigaction", "unable to set up signal handlers");
+ }
+
+ /* POSIX atexit() does not define any error conditions. */
+ if (atexit(remove_registered_files_atexit)) {
+ admonish("atexit", "unable to register atexit function");
+ }
+
+ /* Read context, if supposed to. */
+ if (read_context) {
+ int allow_version_check = 1;
+ int check_older_version = 0;
+ char *cp;
+
+ context_read();
+
+ if (read_context != 1 ||
+ ((cp = context_find ("Welcome")) && strcasecmp (cp, "disable") == 0)) {
+ allow_version_check = 0;
+ } else if ((cp = getenv ("MHCONTEXT")) != NULL && *cp != '\0') {
+ /* Context file comes from $MHCONTEXT, so only print the message
+ if the context file has an older version. If it does, or if it
+ doesn't have a version at all, update the version. */
+ check_older_version = 1;
+ }
+
+ /* Check to see if the user is running a different (or older, if
+ specified) version of nmh than they had run bfore, and notify them
+ if so. But only if read_context was set to a value to enable. */
+ if (allow_version_check && isatty (fileno (stdin)) &&
+ isatty (fileno (stdout)) && isatty (fileno (stderr))) {
+ if (nmh_version_changed (check_older_version)) {
+ printf ("==================================================="
+ "=====================\n");
+ printf ("Welcome to nmh version %s\n\n", VERSION);
+ printf ("See the release notes in %s/NEWS\n\n",
+ mhdocdir);
+ print_intro (stdout, 1);
+ printf ("\nThis message will not be repeated until "
+ "nmh is next updated.\n");
+ printf ("==================================================="
+ "=====================\n\n");
+
+ fputs ("Press enter to continue: ", stdout);
+ (void) read_line ();
+ putchar ('\n');
+ }
+ }
+ } else {
+ if ((status = context_foil(NULL)) != OK) {
+ advise("", "failed to create minimal profile/context");
+ }
+ }
+
+ /* Allow the user to set a locale in their profile. Otherwise, use the
+ "" string to pull it from their environment, see setlocale(3). */
+ if ((locale = context_find ("locale")) == NULL) {
+ locale = "";
+ }
+
+ if (! setlocale (LC_ALL, locale)) {
+ admonish (NULL, "setlocale failed, check your LC_ALL, LC_CTYPE, and "
+ "LANG environment variables");
+ }
+
+ return status;
+}
+
+
+/*
+ * Check stored version, and return 1 if out-of-date or non-existent.
+ * Because the output of "mhparam version" is prefixed with "nmh-",
+ * use that prefix here.
+ */
+int
+nmh_version_changed (int older) {
+ const char *const context_version = context_find("Version");
+
+ if (older) {
+ /* Convert the version strings to floats and compare them. This will
+ break for versions with multiple decimal points, etc. */
+ const float current_version = strtof (VERSION, NULL);
+ const float old_version =
+ context_version && strncmp (context_version, "nmh-", 4) == 0
+ ? strtof (context_version + 4, NULL)
+ : 99999999;
+
+ if (context_version == NULL || old_version < current_version) {
+ context_replace ("Version", "nmh-" VERSION);
+ }
+
+ return old_version < current_version ? 1 : 0;
+ }
+
+ if (context_version == NULL || strcmp(context_version, "nmh-" VERSION) != 0) {
+ context_replace ("Version", "nmh-" VERSION);
+ return 1;
+ }
+
+ return 0;
+}
+
+
+/* Returns copy of argument str with all characters converted to upper
+ case, and trimmed whitespace (see cpytrim()) . */
+char *
+upcase (const char *str) {
+ char *up = cpytrim (str);
+ char *cp;
+
+ for (cp = up; *cp; ++cp) { *cp = toupper ((unsigned char) *cp); }
+
+ return up;
+}
+
+
+/*
+ * Scan for any 8-bit characters. Return 1 if they exist.
+ *
+ * Scan up until the given endpoint (but not the actual endpoint itself).
+ * If the endpoint is NULL, scan until a '\0' is reached.
+ */
+
+int
+contains8bit(const char *start, const char *end)
+{
+ if (! start)
+ return 0;
+
+ while (*start != '\0' && (!end || (start < end)))
+ if (! isascii((unsigned char) *start++))
+ return 1;
+
+ return 0;
+}
+
+
+/*
+ * See if input has any 8-bit bytes.
+ */
+int
+scan_input (int fd, int *eightbit) {
+ int state;
+ char buf[BUFSIZ];
+
+ *eightbit = 0;
+ lseek (fd, (off_t) 0, SEEK_SET);
+
+ while ((state = read (fd, buf, sizeof buf)) > 0) {
+ if (contains8bit (buf, buf + state)) {
+ *eightbit = 1;
+ return OK;
+ }
+ }
+
+ return state == NOTOK ? NOTOK : OK;
+}
projects / nmh / blobdiff