X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/0cebd8284370988c8b1807ef2544bd80804d074e..afd7d2e640069ab1f2126478b365e6ff46db32d7:/sbr/utils.c?ds=sidebyside diff --git a/sbr/utils.c b/sbr/utils.c index c433e8f0..f24f00de 100644 --- a/sbr/utils.c +++ b/sbr/utils.c @@ -2,8 +2,6 @@ /* * 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. @@ -11,8 +9,21 @@ #include #include -#include -#include +#include + +/* 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) + * this number of elements at a time. + */ +#define MAXMSGS 256 /* * Safely call malloc @@ -40,6 +51,10 @@ mh_xrealloc(void *ptr, size_t size) { void *memory; + /* Some non-POSIX realloc()s don't cope with realloc(NULL,sz) */ + if (!ptr) + return mh_xmalloc(size); + if (size == 0) adios(NULL, "Tried to realloc 0bytes"); @@ -50,6 +65,24 @@ mh_xrealloc(void *ptr, size_t size) return memory; } +/* + * Safely call calloc + */ +void * +mh_xcalloc(size_t nmemb, size_t size) +{ + void *memory; + + if (nmemb == 0 || size == 0) + adios(NULL, "Tried to calloc 0 bytes"); + + if ((memory = calloc(nmemb, size))) { + return memory; + } else { + adios(NULL, "calloc failed"); + } +} + /* * Return the present working directory, if the current directory does not * exist, or is too long, make / the pwd. @@ -65,7 +98,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; } @@ -85,7 +120,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; @@ -113,12 +148,48 @@ add (char *s2, char *s1) 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)()) +void create_folder(char *folder, int autocreate, void (*done_callback)(int)) { struct stat st; extern int errno; @@ -130,7 +201,7 @@ void create_folder(char *folder, int autocreate, void (*done_callback)()) 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) { @@ -165,3 +236,273 @@ num_digits (int n) 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; +} + + +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"); + } + + 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'); + } + } + + return OK; + } else { + int status = context_foil(NULL); + if (status != OK) { + advise("", "failed to create minimal profile/conext"); + } + 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; + } else { + if (context_version == NULL || strcmp(context_version, "nmh-" VERSION) != 0) { + context_replace ("Version", "nmh-" VERSION); + + return 1; + } else { + 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; +}