Assume POSIX ctype.h; don't vet tolower()'s parameter.

[nmh] / sbr / utils.c

diff --git a/sbr/utils.c b/sbr/utils.c
index c6f75e07379e3c47878359c7eb88c6a4485a945f..fbada4e6aa54d46c7ae4c6be436ea2ed7a3a0313 100644 (file)
--- a/sbr/utils.c
+++ b/sbr/utils.c
@@ -17,6 +17,7 @@ extern int setup_signal_handlers();
 /* sbr/m_mktemp.c */
 extern void remove_registered_files_atexit();
 
 /* sbr/m_mktemp.c */
 extern void remove_registered_files_atexit();
 

+extern char *mhdocdir;

 
 /*
  * We allocate space for messages (msgs array)
 
 /*
  * We allocate space for messages (msgs array)


@@ -24,62 +25,75 @@ extern void remove_registered_files_atexit();
  */
 #define MAXMSGS 256
 
  */
 #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)
 
     if (size == 0)

-        adios(NULL, "Tried to malloc 0 bytes");
-
-    memory = malloc(size);
-    if (!memory)
-        adios(NULL, "Malloc failed");
+        size = 1; /* Some mallocs don't like 0. */
+    p = malloc(size);
+    if (!p)
+        adios(NULL, "malloc failed, size wanted: %zu", size);

 
 

-    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 (!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;

 
 

-    memory = realloc(ptr, size);
-    if (!memory)
-        adios(NULL, "Realloc failed");
+    if (!nelem || !elsize)
+        return mh_xmalloc(1); /* Get a unique pointer. */

 
 

-    return memory;
+    p = calloc(nelem, elsize);
+    if (!p)
+        adios(NULL, "calloc failed, size wanted: %zu * %zu", nelem, elsize);
+
+    return p;

 }
 
 }
 

-/*
- * Safely call calloc
- */
-void *
-mh_xcalloc(size_t nmemb, size_t size)
+/* Duplicate a NUL-terminated string, exit on failure. */
+char *mh_xstrdup(const char *src)

 {
 {

-    void *memory;
+    size_t n;
+    char *dest;

 
 

-    if (nmemb == 0  ||  size == 0)
-        adios(NULL, "Tried to calloc 0 bytes");
+    n = strlen(src) + 1; /* Ignore possibility of overflow. */
+    dest = mh_xmalloc(n);
+    memcpy(dest, src, n);

 
 

-    if ((memory = calloc(nmemb, size))) {
-        return memory;
-    } else {
-        adios(NULL, "calloc failed");
-    }
+    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. */

 }
 
 /*
 }
 
 /*


@@ -89,7 +103,7 @@ mh_xcalloc(size_t nmemb, size_t size)
 char *
 pwd(void)
 {
 char *
 pwd(void)
 {

-    register char *cp;
+    char *cp;

     static char curwd[PATH_MAX];
 
     if (!getcwd (curwd, PATH_MAX)) {
     static char curwd[PATH_MAX];
 
     if (!getcwd (curwd, PATH_MAX)) {


@@ -200,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 (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) {
                 done_callback (1);
             free (cp);
         } else if (autocreate == -1) {


@@ -346,12 +360,31 @@ nmh_strcasestr (const char *s1, const char *s2) {
 }
 
 
 }
 
 

+/* 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
 nmh_init(const char *argv0, int read_context) {

-    if (! setlocale(LC_ALL, "")) {
-        admonish(NULL, "setlocale failed, check your LC_ALL, LC_CTYPE, and "
-                 "LANG environment variables");
-    }
+    int status = OK;
+    char *locale;

 
     invo_name = r1bindex ((char *) argv0, '/');
 
 
     invo_name = r1bindex ((char *) argv0, '/');
 


@@ -364,16 +397,98 @@ nmh_init(const char *argv0, int read_context) {
         admonish("atexit", "unable to register atexit function");
     }
 
         admonish("atexit", "unable to register atexit function");
     }
 

+    /* Read context, if supposed to. */

     if (read_context) {
     if (read_context) {

+        int allow_version_check = 1;
+        int check_older_version = 0;
+        char *cp;
+

         context_read();
         context_read();

-        return OK;
+
+        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 {
     } else {

-        int status = context_foil(NULL);
-        if (status != OK) {
-            advise("", "failed to create minimal profile/conext");
+        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 status;
+
+        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;

 }
 
 
 }
 
 


@@ -409,3 +524,25 @@ contains8bit(const char *start, const char *end)
 
     return 0;
 }
 
     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;
+}