]> diplodocus.org Git - nmh/blobdiff - sbr/utils.c
Assume POSIX ctype.h; don't vet tolower()'s parameter.
[nmh] / sbr / utils.c
index a279a327d16f70cf6b60e3500419d77362c4af97..fbada4e6aa54d46c7ae4c6be436ea2ed7a3a0313 100644 (file)
@@ -9,9 +9,15 @@
 
 #include <h/mh.h>
 #include <h/utils.h>
-#include <stdlib.h>
 #include <fcntl.h>
-#include <errno.h>
+
+/* sbr/signals.c */
+extern int setup_signal_handlers();
+
+/* sbr/m_mktemp.c */
+extern void remove_registered_files_atexit();
+
+extern char *mhdocdir;
 
 /*
  * We allocate space for messages (msgs array)
  */
 #define MAXMSGS 256
 
-/*
- * Safely call malloc
- */
-void *
-mh_xmalloc(size_t size)
+/* 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);
 
-    memory = malloc(size);
-    if (!memory)
-        adios(NULL, "Malloc failed");
-
-    return memory;
+    return p;
 }
 
-/*
- * Safely call realloc
- */
-void *
-mh_xrealloc(void *ptr, size_t size)
+/* Call realloc(3), exiting on NULL return. */
+void *mh_xrealloc(void *ptr, size_t size)
 {
-    void *memory;
+    void *new;
 
-    /* Some non-POSIX realloc()s don't cope with realloc(NULL,sz) */
+    /* 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);
 
-    if (size == 0)
-        adios(NULL, "Tried to realloc 0bytes");
+    new = realloc(ptr, size);
+    if (!new)
+        adios(NULL, "realloc failed, size wanted: %zu", size);
+
+    return new;
+}
+
+/* Call calloc(3), exiting on NULL return. */
+void *mh_xcalloc(size_t nelem, size_t elsize)
+{
+    void *p;
+
+    if (!nelem || !elsize)
+        return mh_xmalloc(1); /* Get a unique pointer. */
+
+    p = calloc(nelem, elsize);
+    if (!p)
+        adios(NULL, "calloc failed, size wanted: %zu * %zu", nelem, elsize);
 
-    memory = realloc(ptr, size);
-    if (!memory)
-        adios(NULL, "Realloc failed");
+    return p;
+}
+
+/* Duplicate a NUL-terminated string, exit on failure. */
+char *mh_xstrdup(const char *src)
+{
+    size_t n;
+    char *dest;
 
-    return memory;
+    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. */
 }
 
 /*
@@ -66,7 +103,7 @@ mh_xrealloc(void *ptr, size_t size)
 char *
 pwd(void)
 {
-    register char *cp;
+    char *cp;
     static char curwd[PATH_MAX];
 
     if (!getcwd (curwd, PATH_MAX)) {
@@ -74,7 +111,9 @@ pwd(void)
         if (!mypath || !*mypath
                 || (strcpy (curwd, mypath), chdir (curwd)) == -1) {
             strcpy (curwd, "/");
-            chdir (curwd);
+            if (chdir (curwd) < 0) {
+                advise (curwd, "chdir");
+            }
         }
         return curwd;
     }
@@ -94,7 +133,7 @@ pwd(void)
  *       -- malloc'ed memory.  Then free "s1".
  */
 char *
-add (char *s2, char *s1)
+add (const char *s2, char *s1)
 {
     char *cp;
     size_t len1 = 0, len2 = 0;
@@ -127,7 +166,7 @@ add (char *s2, char *s1)
  *     Append an item to a comma separated list
  */
 char *
-addlist (char *list, char *item)
+addlist (char *list, const char *item)
 {
     if (list)
        list = add (", ", list);
@@ -139,7 +178,7 @@ addlist (char *list, char *item)
  * folder_exists
  *      Check to see if a folder exists.
  */
-int folder_exists(char *folder)
+int folder_exists(const char *folder)
 {
     struct stat st;
     int exists = 0;
@@ -175,7 +214,7 @@ void create_folder(char *folder, int autocreate, void (*done_callback)(int))
         if (autocreate == 0) {
             /* ask before creating folder */
             cp = concat ("Create folder \"", folder, "\"? ", NULL);
-            if (!getanswer (cp))
+            if (!read_yes_or_no_if_tty (cp))
                 done_callback (1);
             free (cp);
         } else if (autocreate == -1) {
@@ -226,6 +265,22 @@ app_msgarg(struct msgs_array *msgs, char *cp)
        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)
@@ -241,3 +296,253 @@ open_form(char **form, char *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;
+}