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>
45 #include "dialog_util.h"
49 #include "dpv_private.h"
53 /* Test Mechanics (Only used when dpv_config.options |= DPV_TEST_MODE) */
54 #define INCREMENT 1 /* Increment % per-pass test-mode */
55 #define XDIALOG_INCREMENT 15 /* different for slower Xdialog(1) */
56 static uint8_t increment = INCREMENT;
59 uint8_t debug = FALSE;
62 int dpv_interrupt = FALSE;
63 int dpv_abort = FALSE;
64 unsigned int dpv_nfiles = 0;
67 long long dpv_overall_read = 0;
68 static char pathbuf[PATH_MAX];
70 /* Extra display information */
71 uint8_t no_labels = FALSE; /* dpv_config.options & DPV_NO_LABELS */
72 uint8_t wide = FALSE; /* dpv_config.options & DPV_WIDE_MODE */
73 char *aprompt = NULL; /* dpv_config.aprompt */
74 char *msg_done = NULL; /* dpv_config.msg_done */
75 char *msg_fail = NULL; /* dpv_config.msg_fail */
76 char *msg_pending = NULL; /* dpv_config.msg_pending */
77 char *pprompt = NULL; /* dpv_config.pprompt */
79 /* Status-Line format for when using dialog(3) */
80 static const char *status_format_custom = NULL;
81 static char status_format_default[DPV_STATUS_FORMAT_MAX];
84 * Takes a pointer to a dpv_config structure containing layout details and
85 * pointer to initial element in a linked-list of dpv_file_node structures,
86 * each presenting a file to process. Executes the `action' function passed-in
87 * as a member to the `config' structure argument.
90 dpv(struct dpv_config *config, struct dpv_file_node *file_list)
94 uint8_t nls = FALSE; /* See dialog_prompt_nlstate() */
95 uint8_t no_overrun = FALSE;
96 uint8_t pprompt_nls = FALSE; /* See dialog_prompt_nlstate() */
97 uint8_t shrink_label_size = FALSE;
105 const char *status_fmt;
106 const char *path_fmt;
107 enum dpv_display display_type;
108 enum dpv_output output_type;
109 enum dpv_status status;
110 int (*action)(struct dpv_file_node *file, int out);
112 int dialog_last_update = 0;
113 int dialog_old_nthfile = 0;
114 int dialog_old_seconds = -1;
115 int dialog_out = STDOUT_FILENO;
116 int dialog_update_usec = 0;
117 int dialog_updates_per_second;
126 int status_last_update = 0;
127 int status_old_nthfile = 0;
128 int status_old_seconds = -1;
129 int status_update_usec = 0;
130 int status_updates_per_second;
134 struct dpv_file_node *curfile;
135 struct dpv_file_node *first_file;
136 struct dpv_file_node *list_head;
138 struct timeval start;
139 char init_prompt[PROMPT_MAX + 1] = "";
141 /* Initialize globals to default values */
149 dialog_updates_per_second = DIALOG_UPDATES_PER_SEC;
150 display_limit = DISPLAY_LIMIT_DEFAULT;
151 display_type = DPV_DISPLAY_LIBDIALOG;
152 label_size = LABEL_SIZE_DEFAULT;
158 output_type = DPV_OUTPUT_NONE;
159 pbar_size = PBAR_SIZE_DEFAULT;
160 status_format_custom = NULL;
161 status_updates_per_second = STATUS_UPDATES_PER_SEC;
165 /* Process config options (overriding defaults) */
166 if (config != NULL) {
167 if (config->aprompt != NULL) {
168 if (aprompt == NULL) {
169 aprompt = malloc(DPV_APROMPT_MAX);
173 snprintf(aprompt, DPV_APROMPT_MAX, "%s",
176 if (config->pprompt != NULL) {
177 if (pprompt == NULL) {
178 pprompt = malloc(DPV_PPROMPT_MAX + 2);
179 /* +2 is for implicit "\n" appended later */
183 snprintf(pprompt, DPV_APROMPT_MAX, "%s",
187 options = config->options;
188 action = config->action;
189 backtitle = config->backtitle;
190 debug = config->debug;
191 dialog_test = ((options & DPV_TEST_MODE) != 0);
192 dialog_updates_per_second = config->dialog_updates_per_second;
193 display_limit = config->display_limit;
194 display_type = config->display_type;
195 label_size = config->label_size;
196 msg_done = (char *)config->msg_done;
197 msg_fail = (char *)config->msg_fail;
198 msg_pending = (char *)config->msg_pending;
199 no_labels = ((options & DPV_NO_LABELS) != 0);
200 no_overrun = ((options & DPV_NO_OVERRUN) != 0);
201 output = config->output;
202 output_type = config->output_type;
203 pbar_size = config->pbar_size;
204 status_updates_per_second = config->status_updates_per_second;
205 title = config->title;
206 wide = ((options & DPV_WIDE_MODE) != 0);
208 /* Enforce some minimums (pedantic) */
209 if (display_limit < -1)
216 /* For the mini-pbar, -1 means hide, zero is invalid unless
217 * only one file is given */
218 if (pbar_size == 0) {
219 if (file_list == NULL || file_list->next == NULL)
222 pbar_size = PBAR_SIZE_DEFAULT;
225 /* For the label, -1 means auto-size, zero is invalid unless
226 * specifically requested through the use of options flag */
227 if (label_size == 0 && no_labels == FALSE)
228 label_size = LABEL_SIZE_DEFAULT;
230 /* Status update should not be zero */
231 if (status_updates_per_second == 0)
232 status_updates_per_second = STATUS_UPDATES_PER_SEC;
233 } /* config != NULL */
235 /* Process the type of display we've been requested to produce */
236 switch (display_type) {
237 case DPV_DISPLAY_STDOUT:
241 use_libdialog = FALSE;
244 case DPV_DISPLAY_DIALOG:
247 use_libdialog = FALSE;
250 case DPV_DISPLAY_XDIALOG:
251 snprintf(dialog, PATH_MAX, XDIALOG);
254 use_libdialog = FALSE;
260 use_libdialog = TRUE;
265 /* Enforce additional minimums that require knowing our display type */
266 if (dialog_updates_per_second == 0)
267 dialog_updates_per_second = use_xdialog ?
268 XDIALOG_UPDATES_PER_SEC : DIALOG_UPDATES_PER_SEC;
270 /* Allow forceful override of use_color */
271 if (config != NULL && (config->options & DPV_USE_COLOR) != 0)
274 /* Count the number of files in provided list of dpv_file_node's */
275 if (use_dialog && pprompt != NULL && *pprompt != '\0')
276 pprompt_nls = dialog_prompt_nlstate(pprompt);
278 max_cols = dialog_maxcols();
279 if (label_size == -1)
280 shrink_label_size = TRUE;
282 /* Process file arguments */
283 for (curfile = file_list; curfile != NULL; curfile = curfile->next) {
286 /* dialog(3) only expands literal newlines */
287 if (use_libdialog) strexpandnl(curfile->name);
289 /* Optionally calculate label size for file */
290 if (shrink_label_size) {
292 name = curfile->name;
293 if (curfile == file_list)
295 last = (char *)dialog_prompt_lastline(name, nls);
299 nls = dialog_prompt_nlstate(name);
302 len = dialog_prompt_longestline(last, nls);
303 if ((int)len > (label_size - 3)) {
307 /* Room for ellipsis (unless NULL) */
312 if (max_cols > 0 && label_size > (max_cols - pbar_size
314 label_size = max_cols - pbar_size - 9;
318 warnx("label=[%s] path=[%s] size=%lli",
319 curfile->name, curfile->path, curfile->length);
322 /* Optionally process the contents of DIALOGRC (~/.dialogrc) */
324 res = parse_dialogrc();
325 if (debug && res == 0) {
326 warnx("Successfully read `%s' config file", DIALOGRC);
327 warnx("use_shadow = %i (Boolean)", use_shadow);
328 warnx("use_colors = %i (Boolean)", use_colors);
329 warnx("gauge_color=[%s] (FBH)", gauge_color);
331 } else if (use_libdialog) {
332 init_dialog(stdin, stdout);
333 use_shadow = dialog_state.use_shadow;
334 use_colors = dialog_state.use_colors;
335 gauge_color[0] = 48 + dlg_color_table[GAUGE_ATTR].fg;
336 gauge_color[1] = 48 + dlg_color_table[GAUGE_ATTR].bg;
337 gauge_color[2] = dlg_color_table[GAUGE_ATTR].hilite ?
339 gauge_color[3] = '\0';
342 warnx("Finished initializing dialog(3) library");
343 warnx("use_shadow = %i (Boolean)", use_shadow);
344 warnx("use_colors = %i (Boolean)", use_colors);
345 warnx("gauge_color=[%s] (FBH)", gauge_color);
349 /* Enable mini progress bar automatically for stdin streams if unable
350 * to calculate progress (missing `lines:' syntax). */
351 if (dpv_nfiles <= 1 && file_list != NULL && file_list->length < 0 &&
353 pbar_size = PBAR_SIZE_DEFAULT;
355 /* If $USE_COLOR is set and non-NULL enable color; otherwise disable */
356 if ((cp = getenv(ENV_USE_COLOR)) != 0)
357 use_color = *cp != '\0' ? 1 : 0;
359 /* Print error and return `-1' if not given at least one name */
360 if (dpv_nfiles == 0) {
361 warnx("%s: no labels provided", __func__);
364 warnx("%s: %u label%s provided", __func__, dpv_nfiles,
365 dpv_nfiles == 1 ? "" : "s");
367 /* If only one file and pbar size is zero, default to `-1' */
368 if (dpv_nfiles <= 1 && pbar_size == 0)
371 /* Print some debugging information */
373 warnx("%s: %s(%i) max rows x cols = %i x %i",
374 __func__, use_xdialog ? XDIALOG : DIALOG,
375 use_libdialog ? 3 : 1, dialog_maxrows(),
379 /* Xdialog(1) updates a lot slower than dialog(1) */
380 if (dialog_test && use_xdialog)
381 increment = XDIALOG_INCREMENT;
383 /* Always add implicit newline to pprompt (when specified) */
384 if (pprompt != NULL && *pprompt != '\0') {
385 len = strlen(pprompt);
387 * NOTE: pprompt = malloc(PPROMPT_MAX + 2)
388 * NOTE: (see getopt(2) section above for pprompt allocation)
390 pprompt[len++] = '\\';
391 pprompt[len++] = 'n';
392 pprompt[len++] = '\0';
395 /* Xdialog(1) requires newlines (a) escaped and (b) in triplicate */
396 if (use_xdialog && pprompt != NULL) {
397 /* Replace `\n' with `\n\\n\n' in pprompt */
398 len = strlen(pprompt);
399 len += strcount(pprompt, "\\n") * 2;
400 if (len > DPV_PPROMPT_MAX)
401 errx(EXIT_FAILURE, "%s: Oops, pprompt buffer overflow "
402 "(%zu > %i)", __func__, len, DPV_PPROMPT_MAX);
403 if (replaceall(pprompt, "\\n", "\n\\n\n") < 0)
404 err(EXIT_FAILURE, "%s: replaceall()", __func__);
406 /* libdialog requires literal newlines */
407 else if (use_libdialog && pprompt != NULL)
408 strexpandnl(pprompt);
410 /* Xdialog(1) requires newlines (a) escaped and (b) in triplicate */
411 if (use_xdialog && aprompt != NULL) {
412 /* Replace `\n' with `\n\\n\n' in aprompt */
413 len = strlen(aprompt);
414 len += strcount(aprompt, "\\n") * 2;
415 if (len > DPV_APROMPT_MAX)
416 errx(EXIT_FAILURE, "%s: Oops, aprompt buffer overflow "
417 " (%zu > %i)", __func__, len, DPV_APROMPT_MAX);
418 if (replaceall(aprompt, "\\n", "\n\\n\n") < 0)
419 err(EXIT_FAILURE, "%s: replaceall()", __func__);
421 /* libdialog requires literal newlines */
422 else if (use_libdialog && aprompt != NULL)
423 strexpandnl(aprompt);
426 * Warn user about an obscure dialog(1) bug (neither Xdialog(1) nor
427 * libdialog are affected) in the `--gauge' widget. If the first non-
428 * whitespace letter of "{new_prompt}" in "XXX\n{new_prompt}\nXXX\n"
429 * is a number, the number can sometimes be mistaken for a percentage
430 * to the overall progressbar. Other nasty side-effects such as the
431 * entire prompt not displaying or displaying improperly are caused by
434 * NOTE: When we can use color, we have a work-around... prefix the
435 * output with `\Zn' (used to terminate ANSI and reset to normal).
437 if (use_dialog && !use_color) {
440 /* First, check pprompt (falls through if NULL) */
442 while (fc != NULL && *fc != '\0') {
443 if (*fc == '\n') /* leading literal newline OK */
445 if (!isspace(*fc) && *fc != '\\' && backslash == 0)
447 else if (backslash > 0 && *fc != 'n')
449 else if (*fc == '\\') {
452 break; /* we're safe */
456 /* First non-whitespace character that dialog(1) will see */
457 if (fc != NULL && *fc >= '0' && *fc <= '9')
458 warnx("%s: WARNING! text argument to `-p' begins with "
459 "a number (not recommended)", __func__);
460 else if (fc > pprompt)
461 warnx("%s: WARNING! text argument to `-p' begins with "
462 "whitespace (not recommended)", __func__);
465 * If no pprompt or pprompt is all whitespace, check the first
466 * file name provided to make sure it is alright too.
468 if ((pprompt == NULL || *fc == '\0') && file_list != NULL) {
469 first_file = file_list;
470 fc = first_file->name;
471 while (fc != NULL && *fc != '\0' && isspace(*fc))
473 /* First non-whitespace char that dialog(1) will see */
474 if (fc != NULL && *fc >= '0' && *fc <= '9')
475 warnx("%s: WARNING! File name `%s' begins "
476 "with a number (use `-p text' for safety)",
477 __func__, first_file->name);
481 dprompt_init(file_list);
482 /* Reads: label_size pbar_size pprompt aprompt dpv_nfiles */
483 /* Inits: dheight and dwidth */
486 /* Internally create the initial `--gauge' prompt text */
487 dprompt_recreate(file_list, (struct dpv_file_node *)NULL, 0);
489 /* Spawn [X]dialog(1) `--gauge', returning pipe descriptor */
492 dprompt_libprint(pprompt, aprompt, 0);
494 dprompt_sprint(init_prompt, pprompt, aprompt);
495 dialog_out = dialog_spawn_gauge(init_prompt, &pid);
496 dprompt_dprint(dialog_out, pprompt, aprompt, 0);
500 /* Seed the random(3) generator */
504 /* Set default/custom status line format */
505 if (dpv_nfiles > 1) {
506 snprintf(status_format_default, DPV_STATUS_FORMAT_MAX, "%s",
508 status_format_custom = config->status_many;
510 snprintf(status_format_default, DPV_STATUS_FORMAT_MAX, "%s",
512 status_format_custom = config->status_solo;
515 /* Add test mode identifier to default status line if enabled */
516 if (dialog_test && (strlen(status_format_default) + 12) <
517 DPV_STATUS_FORMAT_MAX)
518 strcat(status_format_default, " [TEST MODE]");
520 /* Verify custom status format */
521 status_fmt = fmtcheck(status_format_custom, status_format_default);
522 if (status_format_custom != NULL &&
523 status_fmt == status_format_default) {
524 warnx("WARNING! Invalid status_format configuration `%s'",
525 status_format_custom);
526 warnx("Default status_format `%s'", status_format_default);
529 /* Record when we started (used to prevent updating too quickly) */
530 (void)gettimeofday(&start, (struct timezone *)NULL);
532 /* Calculate number of microseconds in-between sub-second updates */
533 if (status_updates_per_second != 0)
534 status_update_usec = 1000000 / status_updates_per_second;
535 if (dialog_updates_per_second != 0)
536 dialog_update_usec = 1000000 / dialog_updates_per_second;
539 * Process the file list [serially] (one for each argument passed)
541 files_left = dpv_nfiles;
542 list_head = file_list;
543 for (curfile = file_list; curfile != NULL; curfile = curfile->next) {
555 /* Attempt to spawn output program for this file */
556 if (!dialog_test && output != NULL) {
560 switch (output_type) {
561 case DPV_OUTPUT_SHELL:
562 output_out = shell_spawn_pipecmd(output,
563 curfile->name, &output_pid);
565 case DPV_OUTPUT_FILE:
566 path_fmt = fmtcheck(output, "%s");
567 if (path_fmt == output)
568 len = snprintf(pathbuf,
569 PATH_MAX, output, curfile->name);
571 len = snprintf(pathbuf,
572 PATH_MAX, "%s", output);
573 if (len >= PATH_MAX) {
574 warnx("%s:%d:%s: pathbuf[%u] too small"
575 "to hold output argument",
576 __FILE__, __LINE__, __func__,
580 if ((output_out = open(pathbuf,
581 O_CREAT|O_WRONLY, DEFFILEMODE & ~mask))
592 while (!dpv_interrupt && keep_going) {
597 (int)(random() / 512 / dpv_nfiles);
598 /* 512 limits fake readout to Megabytes */
599 } else if (action != NULL)
600 pct = action(curfile, output_out);
602 if (no_overrun || dialog_test)
603 keep_going = (pct < 100);
605 status = curfile->status;
606 keep_going = (status == DPV_STATUS_RUNNING);
609 /* Get current time and calculate seconds elapsed */
610 gettimeofday(&now, (struct timezone *)NULL);
611 now.tv_sec = now.tv_sec - start.tv_sec;
612 now.tv_usec = now.tv_usec - start.tv_usec;
614 now.tv_sec--, now.tv_usec += 1000000;
615 seconds = now.tv_sec + (now.tv_usec / 1000000.0);
617 /* Update dialog (be it dialog(3), dialog(1), etc.) */
618 if ((dialog_updates_per_second != 0 &&
620 seconds != dialog_old_seconds ||
621 now.tv_usec - dialog_last_update >=
622 dialog_update_usec ||
623 nthfile != dialog_old_nthfile
626 /* Calculate overall progress (rounding up) */
627 overall = (100 * nthfile - 100 + pct) /
629 if (((100 * nthfile - 100 + pct) * 10 /
630 dpv_nfiles % 100) > 50)
633 dprompt_recreate(list_head, curfile, pct);
635 if (use_libdialog && !debug) {
636 /* Update dialog(3) widget */
637 dprompt_libprint(pprompt, aprompt,
640 /* stdout, dialog(1), or Xdialog(1) */
641 dprompt_dprint(dialog_out, pprompt,
645 dialog_old_seconds = seconds;
646 dialog_old_nthfile = nthfile;
647 dialog_last_update = now.tv_usec;
650 /* Update the status line */
651 if ((use_libdialog && !debug) &&
652 status_updates_per_second != 0 &&
654 keep_going != TRUE ||
655 seconds != status_old_seconds ||
656 now.tv_usec - status_last_update >=
657 status_update_usec ||
658 nthfile != status_old_nthfile
661 status_printf(status_fmt, dpv_overall_read,
662 (dpv_overall_read / (seconds == 0 ? 1 :
664 1, /* XXX until we add parallelism XXX */
666 status_old_seconds = seconds;
667 status_old_nthfile = nthfile;
668 status_last_update = now.tv_usec;
672 if (!dialog_test && output_out >= 0) {
674 waitpid(output_pid, (int *)NULL, 0);
680 /* Advance head of list when we hit the max display lines */
681 if (display_limit > 0 && nthfile % display_limit == 0)
682 list_head = curfile->next;
690 waitpid(pid, (int *)NULL, 0);
695 warnx("%s: %lli lines read", __func__, dpv_overall_read);
697 if (dpv_interrupt || dpv_abort)
704 * Free allocated items initialized by dpv()
711 dialog_maxsize_free();
712 if (aprompt != NULL) {
716 if (pprompt != NULL) {