2 * Copyright (c) 2013-2014 Devin Teske <dteske@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
32 #include <sys/types.h>
46 #include "dialog_util.h"
50 #include "dpv_private.h"
54 /* Test Mechanics (Only used when dpv_config.options |= DPV_TEST_MODE) */
55 #define INCREMENT 1 /* Increment % per-pass test-mode */
56 #define XDIALOG_INCREMENT 15 /* different for slower Xdialog(1) */
57 static uint8_t increment = INCREMENT;
60 uint8_t debug = FALSE;
63 int dpv_interrupt = FALSE;
64 int dpv_abort = FALSE;
65 unsigned int dpv_nfiles = 0;
68 long long dpv_overall_read = 0;
69 static char pathbuf[PATH_MAX];
71 /* Extra display information */
72 uint8_t no_labels = FALSE; /* dpv_config.options & DPV_NO_LABELS */
73 uint8_t wide = FALSE; /* dpv_config.options & DPV_WIDE_MODE */
74 char *aprompt = NULL; /* dpv_config.aprompt */
75 char *msg_done = NULL; /* dpv_config.msg_done */
76 char *msg_fail = NULL; /* dpv_config.msg_fail */
77 char *msg_pending = NULL; /* dpv_config.msg_pending */
78 char *pprompt = NULL; /* dpv_config.pprompt */
80 /* Status-Line format for when using dialog(3) */
81 static const char *status_format_custom = NULL;
82 static char status_format_default[DPV_STATUS_FORMAT_MAX];
85 * Takes a pointer to a dpv_config structure containing layout details and
86 * pointer to initial element in a linked-list of dpv_file_node structures,
87 * each presenting a file to process. Executes the `action' function passed-in
88 * as a member to the `config' structure argument.
91 dpv(struct dpv_config *config, struct dpv_file_node *file_list)
95 uint8_t nls = FALSE; /* See dialog_prompt_nlstate() */
96 uint8_t no_overrun = FALSE;
97 uint8_t pprompt_nls = FALSE; /* See dialog_prompt_nlstate() */
98 uint8_t shrink_label_size = FALSE;
106 const char *status_fmt;
107 const char *path_fmt;
108 enum dpv_display display_type;
109 enum dpv_output output_type;
110 enum dpv_status status;
111 int (*action)(struct dpv_file_node *file, int out);
113 int dialog_last_update = 0;
114 int dialog_old_nthfile = 0;
115 int dialog_old_seconds = -1;
116 int dialog_out = STDOUT_FILENO;
117 int dialog_update_usec = 0;
118 int dialog_updates_per_second;
127 int status_last_update = 0;
128 int status_old_nthfile = 0;
129 int status_old_seconds = -1;
130 int status_update_usec = 0;
131 int status_updates_per_second;
135 struct dpv_file_node *curfile;
136 struct dpv_file_node *first_file;
137 struct dpv_file_node *list_head;
139 struct timeval start;
140 char init_prompt[PROMPT_MAX + 1] = "";
142 /* Initialize globals to default values */
150 dialog_updates_per_second = DIALOG_UPDATES_PER_SEC;
151 display_limit = DISPLAY_LIMIT_DEFAULT;
152 display_type = DPV_DISPLAY_LIBDIALOG;
153 label_size = LABEL_SIZE_DEFAULT;
159 output_type = DPV_OUTPUT_NONE;
160 pbar_size = PBAR_SIZE_DEFAULT;
161 status_format_custom = NULL;
162 status_updates_per_second = STATUS_UPDATES_PER_SEC;
166 /* Process config options (overriding defaults) */
167 if (config != NULL) {
168 if (config->aprompt != NULL) {
169 if (aprompt == NULL) {
170 aprompt = malloc(DPV_APROMPT_MAX);
174 snprintf(aprompt, DPV_APROMPT_MAX, "%s",
177 if (config->pprompt != NULL) {
178 if (pprompt == NULL) {
179 pprompt = malloc(DPV_PPROMPT_MAX + 2);
180 /* +2 is for implicit "\n" appended later */
184 snprintf(pprompt, DPV_APROMPT_MAX, "%s",
188 options = config->options;
189 action = config->action;
190 backtitle = config->backtitle;
191 debug = config->debug;
192 dialog_test = ((options & DPV_TEST_MODE) != 0);
193 dialog_updates_per_second = config->dialog_updates_per_second;
194 display_limit = config->display_limit;
195 display_type = config->display_type;
196 label_size = config->label_size;
197 msg_done = (char *)config->msg_done;
198 msg_fail = (char *)config->msg_fail;
199 msg_pending = (char *)config->msg_pending;
200 no_labels = ((options & DPV_NO_LABELS) != 0);
201 no_overrun = ((options & DPV_NO_OVERRUN) != 0);
202 output = config->output;
203 output_type = config->output_type;
204 pbar_size = config->pbar_size;
205 status_updates_per_second = config->status_updates_per_second;
206 title = config->title;
207 wide = ((options & DPV_WIDE_MODE) != 0);
209 /* Enforce some minimums (pedantic) */
210 if (display_limit < -1)
217 /* For the mini-pbar, -1 means hide, zero is invalid unless
218 * only one file is given */
219 if (pbar_size == 0) {
220 if (file_list == NULL || file_list->next == NULL)
223 pbar_size = PBAR_SIZE_DEFAULT;
226 /* For the label, -1 means auto-size, zero is invalid unless
227 * specifically requested through the use of options flag */
228 if (label_size == 0 && no_labels == FALSE)
229 label_size = LABEL_SIZE_DEFAULT;
231 /* Status update should not be zero */
232 if (status_updates_per_second == 0)
233 status_updates_per_second = STATUS_UPDATES_PER_SEC;
234 } /* config != NULL */
236 /* Process the type of display we've been requested to produce */
237 switch (display_type) {
238 case DPV_DISPLAY_STDOUT:
242 use_libdialog = FALSE;
245 case DPV_DISPLAY_DIALOG:
248 use_libdialog = FALSE;
251 case DPV_DISPLAY_XDIALOG:
252 snprintf(dialog, PATH_MAX, XDIALOG);
255 use_libdialog = FALSE;
261 use_libdialog = TRUE;
266 /* Enforce additional minimums that require knowing our display type */
267 if (dialog_updates_per_second == 0)
268 dialog_updates_per_second = use_xdialog ?
269 XDIALOG_UPDATES_PER_SEC : DIALOG_UPDATES_PER_SEC;
271 /* Allow forceful override of use_color */
272 if (config != NULL && (config->options & DPV_USE_COLOR) != 0)
275 /* Count the number of files in provided list of dpv_file_node's */
276 if (use_dialog && pprompt != NULL && *pprompt != '\0')
277 pprompt_nls = dialog_prompt_nlstate(pprompt);
279 max_cols = dialog_maxcols();
280 if (label_size == -1)
281 shrink_label_size = TRUE;
283 /* Process file arguments */
284 for (curfile = file_list; curfile != NULL; curfile = curfile->next) {
287 /* dialog(3) only expands literal newlines */
288 if (use_libdialog) strexpandnl(curfile->name);
290 /* Optionally calculate label size for file */
291 if (shrink_label_size) {
293 name = curfile->name;
294 if (curfile == file_list)
296 last = (char *)dialog_prompt_lastline(name, nls);
300 nls = dialog_prompt_nlstate(name);
303 len = dialog_prompt_longestline(last, nls);
304 if ((int)len > (label_size - 3)) {
308 /* Room for ellipsis (unless NULL) */
313 if (max_cols > 0 && label_size > (max_cols - pbar_size
315 label_size = max_cols - pbar_size - 9;
319 warnx("label=[%s] path=[%s] size=%lli",
320 curfile->name, curfile->path, curfile->length);
323 /* Optionally process the contents of DIALOGRC (~/.dialogrc) */
325 res = parse_dialogrc();
326 if (debug && res == 0) {
327 warnx("Successfully read `%s' config file", DIALOGRC);
328 warnx("use_shadow = %i (Boolean)", use_shadow);
329 warnx("use_colors = %i (Boolean)", use_colors);
330 warnx("gauge_color=[%s] (FBH)", gauge_color);
332 } else if (use_libdialog) {
333 init_dialog(stdin, stdout);
334 use_shadow = dialog_state.use_shadow;
335 use_colors = dialog_state.use_colors;
336 gauge_color[0] = 48 + dlg_color_table[GAUGE_ATTR].fg;
337 gauge_color[1] = 48 + dlg_color_table[GAUGE_ATTR].bg;
338 gauge_color[2] = dlg_color_table[GAUGE_ATTR].hilite ?
340 gauge_color[3] = '\0';
343 warnx("Finished initializing dialog(3) library");
344 warnx("use_shadow = %i (Boolean)", use_shadow);
345 warnx("use_colors = %i (Boolean)", use_colors);
346 warnx("gauge_color=[%s] (FBH)", gauge_color);
350 /* Enable mini progress bar automatically for stdin streams if unable
351 * to calculate progress (missing `lines:' syntax). */
352 if (dpv_nfiles <= 1 && file_list != NULL && file_list->length < 0 &&
354 pbar_size = PBAR_SIZE_DEFAULT;
356 /* If $USE_COLOR is set and non-NULL enable color; otherwise disable */
357 if ((cp = getenv(ENV_USE_COLOR)) != 0)
358 use_color = *cp != '\0' ? 1 : 0;
360 /* Print error and return `-1' if not given at least one name */
361 if (dpv_nfiles == 0) {
362 warnx("%s: no labels provided", __func__);
365 warnx("%s: %u label%s provided", __func__, dpv_nfiles,
366 dpv_nfiles == 1 ? "" : "s");
368 /* If only one file and pbar size is zero, default to `-1' */
369 if (dpv_nfiles <= 1 && pbar_size == 0)
372 /* Print some debugging information */
374 warnx("%s: %s(%i) max rows x cols = %i x %i",
375 __func__, use_xdialog ? XDIALOG : DIALOG,
376 use_libdialog ? 3 : 1, dialog_maxrows(),
380 /* Xdialog(1) updates a lot slower than dialog(1) */
381 if (dialog_test && use_xdialog)
382 increment = XDIALOG_INCREMENT;
384 /* Always add implicit newline to pprompt (when specified) */
385 if (pprompt != NULL && *pprompt != '\0') {
386 len = strlen(pprompt);
388 * NOTE: pprompt = malloc(PPROMPT_MAX + 2)
389 * NOTE: (see getopt(2) section above for pprompt allocation)
391 pprompt[len++] = '\\';
392 pprompt[len++] = 'n';
393 pprompt[len++] = '\0';
396 /* Xdialog(1) requires newlines (a) escaped and (b) in triplicate */
397 if (use_xdialog && pprompt != NULL) {
398 /* Replace `\n' with `\n\\n\n' in pprompt */
399 len = strlen(pprompt);
400 len += strcount(pprompt, "\\n") * 2;
401 if (len > DPV_PPROMPT_MAX)
402 errx(EXIT_FAILURE, "%s: Oops, pprompt buffer overflow "
403 "(%zu > %i)", __func__, len, DPV_PPROMPT_MAX);
404 if (replaceall(pprompt, "\\n", "\n\\n\n") < 0)
405 err(EXIT_FAILURE, "%s: replaceall()", __func__);
407 /* libdialog requires literal newlines */
408 else if (use_libdialog && pprompt != NULL)
409 strexpandnl(pprompt);
411 /* Xdialog(1) requires newlines (a) escaped and (b) in triplicate */
412 if (use_xdialog && aprompt != NULL) {
413 /* Replace `\n' with `\n\\n\n' in aprompt */
414 len = strlen(aprompt);
415 len += strcount(aprompt, "\\n") * 2;
416 if (len > DPV_APROMPT_MAX)
417 errx(EXIT_FAILURE, "%s: Oops, aprompt buffer overflow "
418 " (%zu > %i)", __func__, len, DPV_APROMPT_MAX);
419 if (replaceall(aprompt, "\\n", "\n\\n\n") < 0)
420 err(EXIT_FAILURE, "%s: replaceall()", __func__);
422 /* libdialog requires literal newlines */
423 else if (use_libdialog && aprompt != NULL)
424 strexpandnl(aprompt);
427 * Warn user about an obscure dialog(1) bug (neither Xdialog(1) nor
428 * libdialog are affected) in the `--gauge' widget. If the first non-
429 * whitespace letter of "{new_prompt}" in "XXX\n{new_prompt}\nXXX\n"
430 * is a number, the number can sometimes be mistaken for a percentage
431 * to the overall progressbar. Other nasty side-effects such as the
432 * entire prompt not displaying or displaying improperly are caused by
435 * NOTE: When we can use color, we have a work-around... prefix the
436 * output with `\Zn' (used to terminate ANSI and reset to normal).
438 if (use_dialog && !use_color) {
441 /* First, check pprompt (falls through if NULL) */
443 while (fc != NULL && *fc != '\0') {
444 if (*fc == '\n') /* leading literal newline OK */
446 if (!isspace(*fc) && *fc != '\\' && backslash == 0)
448 else if (backslash > 0 && *fc != 'n')
450 else if (*fc == '\\') {
453 break; /* we're safe */
457 /* First non-whitespace character that dialog(1) will see */
458 if (fc != NULL && *fc >= '0' && *fc <= '9')
459 warnx("%s: WARNING! text argument to `-p' begins with "
460 "a number (not recommended)", __func__);
461 else if (fc > pprompt)
462 warnx("%s: WARNING! text argument to `-p' begins with "
463 "whitespace (not recommended)", __func__);
466 * If no pprompt or pprompt is all whitespace, check the first
467 * file name provided to make sure it is alright too.
469 if ((pprompt == NULL || *fc == '\0') && file_list != NULL) {
470 first_file = file_list;
471 fc = first_file->name;
472 while (fc != NULL && *fc != '\0' && isspace(*fc))
474 /* First non-whitespace char that dialog(1) will see */
475 if (fc != NULL && *fc >= '0' && *fc <= '9')
476 warnx("%s: WARNING! File name `%s' begins "
477 "with a number (use `-p text' for safety)",
478 __func__, first_file->name);
482 dprompt_init(file_list);
483 /* Reads: label_size pbar_size pprompt aprompt dpv_nfiles */
484 /* Inits: dheight and dwidth */
486 /* Default localeconv(3) settings for dialog(3) status */
487 setlocale(LC_NUMERIC,
488 getenv("LC_ALL") == NULL && getenv("LC_NUMERIC") == NULL ?
489 LC_NUMERIC_DEFAULT : "");
492 /* Internally create the initial `--gauge' prompt text */
493 dprompt_recreate(file_list, (struct dpv_file_node *)NULL, 0);
495 /* Spawn [X]dialog(1) `--gauge', returning pipe descriptor */
498 dprompt_libprint(pprompt, aprompt, 0);
500 dprompt_sprint(init_prompt, pprompt, aprompt);
501 dialog_out = dialog_spawn_gauge(init_prompt, &pid);
502 dprompt_dprint(dialog_out, pprompt, aprompt, 0);
506 /* Seed the random(3) generator */
510 /* Set default/custom status line format */
511 if (dpv_nfiles > 1) {
512 snprintf(status_format_default, DPV_STATUS_FORMAT_MAX, "%s",
514 status_format_custom = config->status_many;
516 snprintf(status_format_default, DPV_STATUS_FORMAT_MAX, "%s",
518 status_format_custom = config->status_solo;
521 /* Add test mode identifier to default status line if enabled */
522 if (dialog_test && (strlen(status_format_default) + 12) <
523 DPV_STATUS_FORMAT_MAX)
524 strcat(status_format_default, " [TEST MODE]");
526 /* Verify custom status format */
527 status_fmt = fmtcheck(status_format_custom, status_format_default);
528 if (status_format_custom != NULL &&
529 status_fmt == status_format_default) {
530 warnx("WARNING! Invalid status_format configuration `%s'",
531 status_format_custom);
532 warnx("Default status_format `%s'", status_format_default);
535 /* Record when we started (used to prevent updating too quickly) */
536 (void)gettimeofday(&start, (struct timezone *)NULL);
538 /* Calculate number of microseconds in-between sub-second updates */
539 if (status_updates_per_second != 0)
540 status_update_usec = 1000000 / status_updates_per_second;
541 if (dialog_updates_per_second != 0)
542 dialog_update_usec = 1000000 / dialog_updates_per_second;
545 * Process the file list [serially] (one for each argument passed)
547 files_left = dpv_nfiles;
548 list_head = file_list;
549 for (curfile = file_list; curfile != NULL; curfile = curfile->next) {
561 /* Attempt to spawn output program for this file */
562 if (!dialog_test && output != NULL) {
566 switch (output_type) {
567 case DPV_OUTPUT_SHELL:
568 output_out = shell_spawn_pipecmd(output,
569 curfile->name, &output_pid);
571 case DPV_OUTPUT_FILE:
572 path_fmt = fmtcheck(output, "%s");
573 if (path_fmt == output)
574 len = snprintf(pathbuf,
575 PATH_MAX, output, curfile->name);
577 len = snprintf(pathbuf,
578 PATH_MAX, "%s", output);
579 if (len >= PATH_MAX) {
580 warnx("%s:%d:%s: pathbuf[%u] too small"
581 "to hold output argument",
582 __FILE__, __LINE__, __func__,
586 if ((output_out = open(pathbuf,
587 O_CREAT|O_WRONLY, DEFFILEMODE & ~mask))
598 while (!dpv_interrupt && keep_going) {
603 (int)(random() / 512 / dpv_nfiles);
604 /* 512 limits fake readout to Megabytes */
605 } else if (action != NULL)
606 pct = action(curfile, output_out);
608 if (no_overrun || dialog_test)
609 keep_going = (pct < 100);
611 status = curfile->status;
612 keep_going = (status == DPV_STATUS_RUNNING);
615 /* Get current time and calculate seconds elapsed */
616 gettimeofday(&now, (struct timezone *)NULL);
617 now.tv_sec = now.tv_sec - start.tv_sec;
618 now.tv_usec = now.tv_usec - start.tv_usec;
620 now.tv_sec--, now.tv_usec += 1000000;
621 seconds = now.tv_sec + (now.tv_usec / 1000000.0);
623 /* Update dialog (be it dialog(3), dialog(1), etc.) */
624 if ((dialog_updates_per_second != 0 &&
626 seconds != dialog_old_seconds ||
627 now.tv_usec - dialog_last_update >=
628 dialog_update_usec ||
629 nthfile != dialog_old_nthfile
632 /* Calculate overall progress (rounding up) */
633 overall = (100 * nthfile - 100 + pct) /
635 if (((100 * nthfile - 100 + pct) * 10 /
636 dpv_nfiles % 100) > 50)
639 dprompt_recreate(list_head, curfile, pct);
641 if (use_libdialog && !debug) {
642 /* Update dialog(3) widget */
643 dprompt_libprint(pprompt, aprompt,
646 /* stdout, dialog(1), or Xdialog(1) */
647 dprompt_dprint(dialog_out, pprompt,
651 dialog_old_seconds = seconds;
652 dialog_old_nthfile = nthfile;
653 dialog_last_update = now.tv_usec;
656 /* Update the status line */
657 if ((use_libdialog && !debug) &&
658 status_updates_per_second != 0 &&
660 keep_going != TRUE ||
661 seconds != status_old_seconds ||
662 now.tv_usec - status_last_update >=
663 status_update_usec ||
664 nthfile != status_old_nthfile
667 status_printf(status_fmt, dpv_overall_read,
668 (dpv_overall_read / (seconds == 0 ? 1 :
670 1, /* XXX until we add parallelism XXX */
672 status_old_seconds = seconds;
673 status_old_nthfile = nthfile;
674 status_last_update = now.tv_usec;
678 if (!dialog_test && output_out >= 0) {
680 waitpid(output_pid, (int *)NULL, 0);
686 /* Advance head of list when we hit the max display lines */
687 if (display_limit > 0 && nthfile % display_limit == 0)
688 list_head = curfile->next;
696 waitpid(pid, (int *)NULL, 0);
701 warnx("%s: %lli overall read", __func__, dpv_overall_read);
703 if (dpv_interrupt || dpv_abort)
710 * Free allocated items initialized by dpv()
717 dialog_maxsize_free();
718 if (aprompt != NULL) {
722 if (pprompt != NULL) {