diplodocus.org Git - nmh/blob - sbr/utils.c

   1
   2 /*
   3  * utils.c -- various utility routines
   4  *
   5  * This code is Copyright (c) 2006, by the authors of nmh.  See the
   6  * COPYRIGHT file in the root directory of the nmh distribution for
   7  * complete copyright information.
   8  */
   9
  10 #include <h/mh.h>
  11 #include <h/utils.h>
  12 #include <fcntl.h>
  13
  14 /* sbr/signals.c */
  15 extern int setup_signal_handlers();
  16
  17 /* sbr/m_mktemp.c */
  18 extern void remove_registered_files_atexit();
  19
  20 extern char *mhdocdir;
  21
  22 /*
  23  * We allocate space for messages (msgs array)
  24  * this number of elements at a time.
  25  */
  26 #define MAXMSGS 256
  27
  28 /* Call malloc(3), exiting on NULL return. */
  29 void *mh_xmalloc(size_t size)
  30 {
  31     void *p;
  32
  33     if (size == 0)
  34         size = 1; /* Some mallocs don't like 0. */
  35     p = malloc(size);
  36     if (!p)
  37         adios(NULL, "malloc failed, size wanted: %zu", size);
  38
  39     return p;
  40 }
  41
  42 /* Call realloc(3), exiting on NULL return. */
  43 void *mh_xrealloc(void *ptr, size_t size)
  44 {
  45     void *new;
  46
  47     /* Copy POSIX behaviour, coping with non-POSIX systems. */
  48     if (size == 0) {
  49         mh_xfree(ptr);
  50         return mh_xmalloc(1); /* Get a unique pointer. */
  51     }
  52     if (!ptr)
  53         return mh_xmalloc(size);
  54
  55     new = realloc(ptr, size);
  56     if (!new)
  57         adios(NULL, "realloc failed, size wanted: %zu", size);
  58
  59     return new;
  60 }
  61
  62 /* Call calloc(3), exiting on NULL return. */
  63 void *mh_xcalloc(size_t nelem, size_t elsize)
  64 {
  65     void *p;
  66
  67     if (!nelem || !elsize)
  68         return mh_xmalloc(1); /* Get a unique pointer. */
  69
  70     p = calloc(nelem, elsize);
  71     if (!p)
  72         adios(NULL, "calloc failed, size wanted: %zu * %zu", nelem, elsize);
  73
  74     return p;
  75 }
  76
  77 /* Duplicate a NUL-terminated string, exit on failure. */
  78 char *mh_xstrdup(const char *src)
  79 {
  80     size_t n;
  81     char *dest;
  82
  83     n = strlen(src) + 1; /* Ignore possibility of overflow. */
  84     dest = mh_xmalloc(n);
  85     memcpy(dest, src, n);
  86
  87     return dest;
  88 }
  89
  90 /* Call free(3), if ptr isn't NULL. */
  91 void mh_xfree(void *ptr)
  92 {
  93     if (ptr)
  94         free(ptr); /* Some very old platforms can't cope with NULL. */
  95 }
  96
  97 /*
  98  * Return the present working directory, if the current directory does not
  99  * exist, or is too long, make / the pwd.
 100  */
 101 char *
 102 pwd(void)
 103 {
 104     char *cp;
 105     static char curwd[PATH_MAX];
 106
 107     if (!getcwd (curwd, PATH_MAX)) {
 108         admonish (NULL, "unable to determine working directory");
 109         if (!mypath || !*mypath
 110                 || (strcpy (curwd, mypath), chdir (curwd)) == -1) {
 111             strcpy (curwd, "/");
 112             if (chdir (curwd) < 0) {
 113                 advise (curwd, "chdir");
 114             }
 115         }
 116         return curwd;
 117     }
 118
 119     if ((cp = curwd + strlen (curwd) - 1) > curwd && *cp == '/')
 120         *cp = '\0';
 121
 122     return curwd;
 123 }
 124
 125 /*
 126  * add   -- If "s1" is NULL, this routine just creates a
 127  *       -- copy of "s2" into newly malloc'ed memory.
 128  *       --
 129  *       -- If "s1" is not NULL, then copy the concatenation
 130  *       -- of "s1" and "s2" (note the order) into newly
 131  *       -- malloc'ed memory.  Then free "s1".
 132  */
 133 char *
 134 add (const char *s2, char *s1)
 135 {
 136     char *cp;
 137     size_t len1 = 0, len2 = 0;
 138
 139     if (s1)
 140         len1 = strlen (s1);
 141     if (s2)
 142         len2 = strlen (s2);
 143
 144     cp = mh_xmalloc (len1 + len2 + 1);
 145
 146     /* Copy s1 and free it */
 147     if (s1) {
 148         memcpy (cp, s1, len1);
 149         free (s1);
 150     }
 151
 152     /* Copy s2 */
 153     if (s2)
 154         memcpy (cp + len1, s2, len2);
 155
 156     /* Now NULL terminate the string */
 157     cp[len1 + len2] = '\0';
 158
 159     return cp;
 160 }
 161
 162 /*
 163  * addlist
 164  *      Append an item to a comma separated list
 165  */
 166 char *
 167 addlist (char *list, const char *item)
 168 {
 169     if (list)
 170         list = add (", ", list);
 171
 172     return add (item, list);
 173 }
 174
 175 /*
 176  * folder_exists
 177  *      Check to see if a folder exists.
 178  */
 179 int folder_exists(const char *folder)
 180 {
 181     struct stat st;
 182
 183     return stat(folder, &st) != -1;
 184 }
 185
 186 /*
 187  * create_folder
 188  *      Check to see if a folder exists, if not, prompt the user to create
 189  *      it.
 190  */
 191 void create_folder(char *folder, int autocreate, void (*done_callback)(int))
 192 {
 193     struct stat st;
 194     extern int errno;
 195     char *cp;
 196
 197     if (stat (folder, &st) == -1) {
 198         if (errno != ENOENT)
 199             adios (folder, "error on folder");
 200         if (autocreate == 0) {
 201             /* ask before creating folder */
 202             cp = concat ("Create folder \"", folder, "\"? ", NULL);
 203             if (!read_yes_or_no_if_tty (cp))
 204                 done_callback (1);
 205             free (cp);
 206         } else if (autocreate == -1) {
 207             /* do not create, so exit */
 208             done_callback (1);
 209         }
 210         if (!makedir (folder))
 211             adios (NULL, "unable to create folder %s", folder);
 212     }
 213 }
 214
 215 /*
 216  * num_digits
 217  *      Return the number of digits in a nonnegative integer.
 218  */
 219 int
 220 num_digits (int n)
 221 {
 222     int ndigits = 0;
 223
 224     /* Sanity check */
 225     if (n < 0)
 226         adios (NULL, "oops, num_digits called with negative value");
 227
 228     if (n == 0)
 229         return 1;
 230
 231     while (n) {
 232         n /= 10;
 233         ndigits++;
 234     }
 235
 236     return ndigits;
 237 }
 238
 239 /*
 240  * Append a message arg to an array of them, resizing it if necessary.
 241  * Really a simple vector-of-(char *) maintenance routine.
 242  */
 243 void
 244 app_msgarg(struct msgs_array *msgs, char *cp)
 245 {
 246         if(msgs->size >= msgs->max) {
 247                 msgs->max += MAXMSGS;
 248                 msgs->msgs = mh_xrealloc(msgs->msgs,
 249                         msgs->max * sizeof(*msgs->msgs));
 250         }
 251         msgs->msgs[msgs->size++] = cp;
 252 }
 253
 254 /*
 255  * Append a message number to an array of them, resizing it if necessary.
 256  * Like app_msgarg, but with a vector-of-ints instead.
 257  */
 258
 259 void
 260 app_msgnum(struct msgnum_array *msgs, int msgnum)
 261 {
 262         if (msgs->size >= msgs->max) {
 263                 msgs->max += MAXMSGS;
 264                 msgs->msgnums = mh_xrealloc(msgs->msgnums,
 265                         msgs->max * sizeof(*msgs->msgnums));
 266         }
 267         msgs->msgnums[msgs->size++] = msgnum;
 268 }
 269
 270 /* Open a form or components file */
 271 int
 272 open_form(char **form, char *def)
 273 {
 274         int in;
 275         if (*form) {
 276                 if ((in = open (etcpath (*form), O_RDONLY)) == NOTOK)
 277                         adios (*form, "unable to open form file");
 278         } else {
 279                 if ((in = open (etcpath (def), O_RDONLY)) == NOTOK)
 280                         adios (def, "unable to open default components file");
 281                 *form = def;
 282         }
 283         return in;
 284 }
 285
 286
 287 /*
 288  * Finds first occurrence of str in buf.  buf is not a C string but a
 289  * byte array of length buflen.  str is a null-terminated C string.
 290  * find_str() does not modify buf but passes back a non-const char *
 291  * pointer so that the caller can modify it.
 292  */
 293 char *
 294 find_str (const char buf[], size_t buflen, const char *str) {
 295     const size_t len = strlen (str);
 296     size_t i;
 297
 298     for (i = 0; i + len <= buflen; ++i, ++buf) {
 299         if (! memcmp (buf, str, len)) return (char *) buf;
 300     }
 301
 302     return NULL;
 303 }
 304
 305
 306 /*
 307  * Finds last occurrence of str in buf.  buf is not a C string but a
 308  * byte array of length buflen.  str is a null-terminated C string.
 309  * find_str() does not modify buf but passes back a non-const char *
 310  * pointer so that the caller can modify it.
 311  */
 312 char *
 313 rfind_str (const char buf[], size_t buflen, const char *str) {
 314     const size_t len = strlen (str);
 315     size_t i;
 316
 317     for (i = 0, buf += buflen - len; i + len <= buflen; ++i, --buf) {
 318         if (! memcmp (buf, str, len)) return (char *) buf;
 319     }
 320
 321     return NULL;
 322 }
 323
 324
 325 /* POSIX doesn't have strcasestr() so emulate it. */
 326 char *
 327 nmh_strcasestr (const char *s1, const char *s2) {
 328     const size_t len = strlen (s2);
 329
 330     if (isupper ((unsigned char) s2[0])  ||  islower ((unsigned char)s2[0])) {
 331         char first[3];
 332         first[0] = (char) toupper ((unsigned char) s2[0]);
 333         first[1] = (char) tolower ((unsigned char) s2[0]);
 334         first[2] = '\0';
 335
 336         for (s1 = strpbrk (s1, first); s1; s1 = strpbrk (++s1, first)) {
 337             if (! strncasecmp (s1, s2, len)) return (char *) s1;
 338         }
 339     } else {
 340         for (s1 = strchr (s1, s2[0]); s1; s1 = strchr (++s1, s2[0])) {
 341             if (! strncasecmp (s1, s2, len)) return (char *) s1;
 342         }
 343     }
 344
 345     return NULL;
 346 }
 347
 348
 349 /* truncpy copies at most size - 1 chars from non-NULL src to non-NULL,
 350  * non-overlapping, dst, and ensures dst is NUL terminated.  If size is
 351  * zero then it aborts as dst cannot be NUL terminated.
 352  *
 353  * It's to be used when truncation is intended and correct, e.g.
 354  * reporting a possibly very long external string back to the user.  One
 355  * of its advantages over strncpy(3) is it doesn't pad in the common
 356  * case of no truncation. */
 357 void trunccpy(char *dst, const char *src, size_t size)
 358 {
 359     if (!size) {
 360         advise(NULL, "trunccpy: zero-length destination: \"%.20s\"",
 361             src ? src : "null");
 362         abort();
 363     }
 364
 365     if (strnlen(src, size) < size) {
 366         strcpy(dst, src);
 367     } else {
 368         memcpy(dst, src, size - 1);
 369         dst[size - 1] = '\0';
 370     }
 371 }
 372
 373
 374 /* HasPrefix returns true if non-NULL s starts with non-NULL prefix. */
 375 bool HasPrefix(const char *s, const char *prefix)
 376 {
 377     while (*s && *s == *prefix) {
 378         s++;
 379         prefix++;
 380     }
 381
 382     return *prefix == '\0';
 383 }
 384
 385
 386 /* HasSuffix returns true if non-NULL s ends with non-NULL suffix. */
 387 bool HasSuffix(const char *s, const char *suffix)
 388 {
 389     size_t ls, lsuf;
 390
 391     ls = strlen(s);
 392     lsuf = strlen(suffix);
 393
 394     return lsuf <= ls && !strcmp(s + ls - lsuf, suffix);
 395 }
 396
 397
 398 /* HasSuffixC returns true if non-NULL string s ends with a c before the
 399  * terminating NUL. */
 400 bool HasSuffixC(const char *s, int c)
 401 {
 402     return *s && s[strlen(s) - 1] == c;
 403 }
 404
 405
 406 /* TrimSuffixC deletes c from the end of non-NULL string s if it's
 407  * present, shortening s by 1.  Only one instance of c is removed. */
 408 void TrimSuffixC(char *s, int c)
 409 {
 410     if (!*s)
 411         return;
 412
 413     s += strlen(s) - 1;
 414     if (*s == c)
 415         *s = '\0';
 416 }
 417
 418
 419 /* ToLower runs all of s through tolower(3). */
 420 void ToLower(char *s)
 421 {
 422     unsigned char *b;
 423
 424     for (b = (unsigned char *)s; (*b = tolower(*b)); b++)
 425         ;
 426 }
 427
 428
 429 /* ToUpper runs all of s through toupper(3). */
 430 void ToUpper(char *s)
 431 {
 432     unsigned char *b;
 433
 434     for (b = (unsigned char *)s; (*b = toupper(*b)); b++)
 435         ;
 436 }
 437
 438
 439 int
 440 nmh_init(const char *argv0, int read_context) {
 441     int status = OK;
 442     char *locale;
 443
 444     invo_name = r1bindex ((char *) argv0, '/');
 445
 446     if (setup_signal_handlers()) {
 447         admonish("sigaction", "unable to set up signal handlers");
 448     }
 449
 450     /* POSIX atexit() does not define any error conditions. */
 451     if (atexit(remove_registered_files_atexit)) {
 452         admonish("atexit", "unable to register atexit function");
 453     }
 454
 455     /* Read context, if supposed to. */
 456     if (read_context) {
 457         int allow_version_check = 1;
 458         int check_older_version = 0;
 459         char *cp;
 460
 461         context_read();
 462
 463         if (read_context != 1  ||
 464             ((cp = context_find ("Welcome")) && strcasecmp (cp, "disable") == 0)) {
 465             allow_version_check = 0;
 466         } else if ((cp = getenv ("MHCONTEXT")) != NULL && *cp != '\0') {
 467             /* Context file comes from $MHCONTEXT, so only print the message
 468                if the context file has an older version.  If it does, or if it
 469                doesn't have a version at all, update the version. */
 470             check_older_version = 1;
 471         }
 472
 473         /* Check to see if the user is running a different (or older, if
 474            specified) version of nmh than they had run bfore, and notify them
 475            if so.  But only if read_context was set to a value to enable. */
 476         if (allow_version_check  &&  isatty (fileno (stdin))  &&
 477             isatty (fileno (stdout))  &&  isatty (fileno (stderr))) {
 478             if (nmh_version_changed (check_older_version)) {
 479                 printf ("==================================================="
 480                         "=====================\n");
 481                 printf ("Welcome to nmh version %s\n\n", VERSION);
 482                 printf ("See the release notes in %s/NEWS\n\n",
 483                          mhdocdir);
 484                 print_intro (stdout, 1);
 485                 printf ("\nThis message will not be repeated until "
 486                         "nmh is next updated.\n");
 487                 printf ("==================================================="
 488                         "=====================\n\n");
 489
 490                 fputs ("Press enter to continue: ", stdout);
 491                 (void) read_line ();
 492                 putchar ('\n');
 493             }
 494         }
 495     } else {
 496         if ((status = context_foil(NULL)) != OK) {
 497             advise("", "failed to create minimal profile/context");
 498         }
 499     }
 500
 501     /* Allow the user to set a locale in their profile.  Otherwise, use the
 502        "" string to pull it from their environment, see setlocale(3). */
 503     if ((locale = context_find ("locale")) == NULL) {
 504         locale = "";
 505     }
 506
 507     if (! setlocale (LC_ALL, locale)) {
 508         admonish (NULL, "setlocale failed, check your LC_ALL, LC_CTYPE, and "
 509                  "LANG environment variables");
 510     }
 511
 512     return status;
 513 }
 514
 515
 516 /*
 517  * Check stored version, and return 1 if out-of-date or non-existent.
 518  * Because the output of "mhparam version" is prefixed with "nmh-",
 519  * use that prefix here.
 520  */
 521 int
 522 nmh_version_changed (int older) {
 523     const char *const context_version = context_find("Version");
 524
 525     if (older) {
 526         /* Convert the version strings to floats and compare them.  This will
 527            break for versions with multiple decimal points, etc. */
 528         const float current_version = strtof (VERSION, NULL);
 529         const float old_version =
 530             context_version  &&  HasPrefix(context_version, "nmh-")
 531             ?  strtof (context_version + 4, NULL)
 532             :  99999999;
 533
 534         if (context_version == NULL  ||  old_version < current_version) {
 535             context_replace ("Version", "nmh-" VERSION);
 536         }
 537
 538         return old_version < current_version  ?  1  :  0;
 539     }
 540
 541     if (context_version == NULL  ||  strcmp(context_version, "nmh-" VERSION) != 0) {
 542         context_replace ("Version", "nmh-" VERSION);
 543         return 1;
 544     }
 545
 546     return 0;
 547 }
 548
 549
 550 /* Returns copy of argument str with all characters converted to upper
 551    case, and trimmed whitespace (see cpytrim()) . */
 552 char *
 553 upcase (const char *str) {
 554     char *up = cpytrim (str);
 555
 556     ToUpper(up);
 557
 558     return up;
 559 }
 560
 561
 562 /*
 563  * Scan for any 8-bit characters.  Return 1 if they exist.
 564  *
 565  * Scan up until the given endpoint (but not the actual endpoint itself).
 566  * If the endpoint is NULL, scan until a '\0' is reached.
 567  */
 568
 569 int
 570 contains8bit(const char *start, const char *end)
 571 {
 572     if (! start)
 573         return 0;
 574
 575     while (*start != '\0' && (!end || (start < end)))
 576         if (! isascii((unsigned char) *start++))
 577             return 1;
 578
 579     return 0;
 580 }
 581
 582
 583 /*
 584  * See if input has any 8-bit bytes.
 585  */
 586 int
 587 scan_input (int fd, int *eightbit) {
 588     int state;
 589     char buf[BUFSIZ];
 590
 591     *eightbit = 0;
 592     lseek (fd, (off_t) 0, SEEK_SET);
 593
 594     while ((state = read (fd, buf, sizeof buf)) > 0) {
 595         if (contains8bit (buf, buf + state)) {
 596             *eightbit = 1;
 597             return OK;
 598         }
 599     }
 600
 601     return state == NOTOK  ?  NOTOK  :  OK;
 602 }