3 * utils.c -- various utility routines
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.
15 extern int setup_signal_handlers();
18 extern void remove_registered_files_atexit();
20 extern char *mhdocdir
;
23 * We allocate space for messages (msgs array)
24 * this number of elements at a time.
28 /* Call malloc(3), exiting on NULL return. */
29 void *mh_xmalloc(size_t size
)
34 size
= 1; /* Some mallocs don't like 0. */
37 adios(NULL
, "malloc failed, size wanted: %zu", size
);
42 /* Call realloc(3), exiting on NULL return. */
43 void *mh_xrealloc(void *ptr
, size_t size
)
47 /* Copy POSIX behaviour, coping with non-POSIX systems. */
52 return mh_xmalloc(1); /* Get a unique pointer. */
55 return mh_xmalloc(size
);
57 new = realloc(ptr
, size
);
59 adios(NULL
, "realloc failed, size wanted: %zu", size
);
68 mh_xcalloc(size_t nmemb
, size_t size
)
72 if (nmemb
== 0 || size
== 0)
73 adios(NULL
, "Tried to calloc 0 bytes");
75 if ((memory
= calloc(nmemb
, size
))) {
78 adios(NULL
, "calloc failed");
83 * Return the present working directory, if the current directory does not
84 * exist, or is too long, make / the pwd.
90 static char curwd
[PATH_MAX
];
92 if (!getcwd (curwd
, PATH_MAX
)) {
93 admonish (NULL
, "unable to determine working directory");
94 if (!mypath
|| !*mypath
95 || (strcpy (curwd
, mypath
), chdir (curwd
)) == -1) {
97 if (chdir (curwd
) < 0) {
98 advise (curwd
, "chdir");
104 if ((cp
= curwd
+ strlen (curwd
) - 1) > curwd
&& *cp
== '/')
111 * add -- If "s1" is NULL, this routine just creates a
112 * -- copy of "s2" into newly malloc'ed memory.
114 * -- If "s1" is not NULL, then copy the concatenation
115 * -- of "s1" and "s2" (note the order) into newly
116 * -- malloc'ed memory. Then free "s1".
119 add (const char *s2
, char *s1
)
122 size_t len1
= 0, len2
= 0;
129 cp
= mh_xmalloc (len1
+ len2
+ 1);
131 /* Copy s1 and free it */
133 memcpy (cp
, s1
, len1
);
139 memcpy (cp
+ len1
, s2
, len2
);
141 /* Now NULL terminate the string */
142 cp
[len1
+ len2
] = '\0';
149 * Append an item to a comma separated list
152 addlist (char *list
, const char *item
)
155 list
= add (", ", list
);
157 return add (item
, list
);
162 * Check to see if a folder exists.
164 int folder_exists(const char *folder
)
169 if (stat (folder
, &st
) == -1) {
170 /* The folder either doesn't exist, or we hit an error. Either way
175 /* We can see a folder with the right name */
185 * Check to see if a folder exists, if not, prompt the user to create
188 void create_folder(char *folder
, int autocreate
, void (*done_callback
)(int))
194 if (stat (folder
, &st
) == -1) {
196 adios (folder
, "error on folder");
197 if (autocreate
== 0) {
198 /* ask before creating folder */
199 cp
= concat ("Create folder \"", folder
, "\"? ", NULL
);
200 if (!read_yes_or_no_if_tty (cp
))
203 } else if (autocreate
== -1) {
204 /* do not create, so exit */
207 if (!makedir (folder
))
208 adios (NULL
, "unable to create folder %s", folder
);
214 * Return the number of digits in a nonnegative integer.
223 adios (NULL
, "oops, num_digits called with negative value");
237 * Append a message arg to an array of them, resizing it if necessary.
238 * Really a simple vector-of-(char *) maintenance routine.
241 app_msgarg(struct msgs_array
*msgs
, char *cp
)
243 if(msgs
->size
>= msgs
->max
) {
244 msgs
->max
+= MAXMSGS
;
245 msgs
->msgs
= mh_xrealloc(msgs
->msgs
,
246 msgs
->max
* sizeof(*msgs
->msgs
));
248 msgs
->msgs
[msgs
->size
++] = cp
;
252 * Append a message number to an array of them, resizing it if necessary.
253 * Like app_msgarg, but with a vector-of-ints instead.
257 app_msgnum(struct msgnum_array
*msgs
, int msgnum
)
259 if (msgs
->size
>= msgs
->max
) {
260 msgs
->max
+= MAXMSGS
;
261 msgs
->msgnums
= mh_xrealloc(msgs
->msgnums
,
262 msgs
->max
* sizeof(*msgs
->msgnums
));
264 msgs
->msgnums
[msgs
->size
++] = msgnum
;
267 /* Open a form or components file */
269 open_form(char **form
, char *def
)
273 if ((in
= open (etcpath (*form
), O_RDONLY
)) == NOTOK
)
274 adios (*form
, "unable to open form file");
276 if ((in
= open (etcpath (def
), O_RDONLY
)) == NOTOK
)
277 adios (def
, "unable to open default components file");
285 * Finds first occurrence of str in buf. buf is not a C string but a
286 * byte array of length buflen. str is a null-terminated C string.
287 * find_str() does not modify buf but passes back a non-const char *
288 * pointer so that the caller can modify it.
291 find_str (const char buf
[], size_t buflen
, const char *str
) {
292 const size_t len
= strlen (str
);
295 for (i
= 0; i
+ len
<= buflen
; ++i
, ++buf
) {
296 if (! memcmp (buf
, str
, len
)) return (char *) buf
;
304 * Finds last occurrence of str in buf. buf is not a C string but a
305 * byte array of length buflen. str is a null-terminated C string.
306 * find_str() does not modify buf but passes back a non-const char *
307 * pointer so that the caller can modify it.
310 rfind_str (const char buf
[], size_t buflen
, const char *str
) {
311 const size_t len
= strlen (str
);
314 for (i
= 0, buf
+= buflen
- len
; i
+ len
<= buflen
; ++i
, --buf
) {
315 if (! memcmp (buf
, str
, len
)) return (char *) buf
;
322 /* POSIX doesn't have strcasestr() so emulate it. */
324 nmh_strcasestr (const char *s1
, const char *s2
) {
325 const size_t len
= strlen (s2
);
327 if (isupper ((unsigned char) s2
[0]) || islower ((unsigned char)s2
[0])) {
329 first
[0] = (char) toupper ((unsigned char) s2
[0]);
330 first
[1] = (char) tolower ((unsigned char) s2
[0]);
333 for (s1
= strpbrk (s1
, first
); s1
; s1
= strpbrk (++s1
, first
)) {
334 if (! strncasecmp (s1
, s2
, len
)) return (char *) s1
;
337 for (s1
= strchr (s1
, s2
[0]); s1
; s1
= strchr (++s1
, s2
[0])) {
338 if (! strncasecmp (s1
, s2
, len
)) return (char *) s1
;
347 nmh_init(const char *argv0
, int read_context
) {
348 if (! setlocale(LC_ALL
, "")) {
349 admonish(NULL
, "setlocale failed, check your LC_ALL, LC_CTYPE, and "
350 "LANG environment variables");
353 invo_name
= r1bindex ((char *) argv0
, '/');
355 if (setup_signal_handlers()) {
356 admonish("sigaction", "unable to set up signal handlers");
359 /* POSIX atexit() does not define any error conditions. */
360 if (atexit(remove_registered_files_atexit
)) {
361 admonish("atexit", "unable to register atexit function");
364 /* Read context, if supposed to. */
366 int allow_version_check
= 1;
367 int check_older_version
= 0;
372 if (read_context
!= 1 ||
373 ((cp
= context_find ("Welcome")) && strcasecmp (cp
, "disable") == 0)) {
374 allow_version_check
= 0;
375 } else if ((cp
= getenv ("MHCONTEXT")) != NULL
&& *cp
!= '\0') {
376 /* Context file comes from $MHCONTEXT, so only print the message
377 if the context file has an older version. If it does, or if it
378 doesn't have a version at all, update the version. */
379 check_older_version
= 1;
382 /* Check to see if the user is running a different (or older, if
383 specified) version of nmh than they had run bfore, and notify them
384 if so. But only if read_context was set to a value to enable. */
385 if (allow_version_check
&& isatty (fileno (stdin
)) &&
386 isatty (fileno (stdout
)) && isatty (fileno (stderr
))) {
387 if (nmh_version_changed (check_older_version
)) {
388 printf ("==================================================="
389 "=====================\n");
390 printf ("Welcome to nmh version %s\n\n", VERSION
);
391 printf ("See the release notes in %s/NEWS\n\n",
393 print_intro (stdout
, 1);
394 printf ("\nThis message will not be repeated until "
395 "nmh is next updated.\n");
396 printf ("==================================================="
397 "=====================\n\n");
399 fputs ("Press enter to continue: ", stdout
);
407 int status
= context_foil(NULL
);
409 advise("", "failed to create minimal profile/context");
417 * Check stored version, and return 1 if out-of-date or non-existent.
418 * Because the output of "mhparam version" is prefixed with "nmh-",
419 * use that prefix here.
422 nmh_version_changed (int older
) {
423 const char *const context_version
= context_find("Version");
426 /* Convert the version strings to floats and compare them. This will
427 break for versions with multiple decimal points, etc. */
428 const float current_version
= strtof (VERSION
, NULL
);
429 const float old_version
=
430 context_version
&& strncmp (context_version
, "nmh-", 4) == 0
431 ? strtof (context_version
+ 4, NULL
)
434 if (context_version
== NULL
|| old_version
< current_version
) {
435 context_replace ("Version", "nmh-" VERSION
);
438 return old_version
< current_version
? 1 : 0;
440 if (context_version
== NULL
|| strcmp(context_version
, "nmh-" VERSION
) != 0) {
441 context_replace ("Version", "nmh-" VERSION
);
451 /* Returns copy of argument str with all characters converted to upper
452 case, and trimmed whitespace (see cpytrim()) . */
454 upcase (const char *str
) {
455 char *up
= cpytrim (str
);
458 for (cp
= up
; *cp
; ++cp
) { *cp
= toupper ((unsigned char) *cp
); }
465 * Scan for any 8-bit characters. Return 1 if they exist.
467 * Scan up until the given endpoint (but not the actual endpoint itself).
468 * If the endpoint is NULL, scan until a '\0' is reached.
472 contains8bit(const char *start
, const char *end
)
477 while (*start
!= '\0' && (!end
|| (start
< end
)))
478 if (! isascii((unsigned char) *start
++))
486 * See if input has any 8-bit bytes.
489 scan_input (int fd
, int *eightbit
) {
494 lseek (fd
, (off_t
) 0, SEEK_SET
);
496 while ((state
= read (fd
, buf
, sizeof buf
)) > 0) {
497 if (contains8bit (buf
, buf
+ state
)) {
503 return state
== NOTOK
? NOTOK
: OK
;