xref: /freebsd/lib/libdpv/dpv.c (revision 1d386b48)
1041394f3SDevin Teske /*-
21a5f047aSDevin Teske  * Copyright (c) 2013-2016 Devin Teske <dteske@FreeBSD.org>
3041394f3SDevin Teske  * All rights reserved.
4041394f3SDevin Teske  *
5041394f3SDevin Teske  * Redistribution and use in source and binary forms, with or without
6041394f3SDevin Teske  * modification, are permitted provided that the following conditions
7041394f3SDevin Teske  * are met:
8041394f3SDevin Teske  * 1. Redistributions of source code must retain the above copyright
9041394f3SDevin Teske  *    notice, this list of conditions and the following disclaimer.
10041394f3SDevin Teske  * 2. Redistributions in binary form must reproduce the above copyright
11041394f3SDevin Teske  *    notice, this list of conditions and the following disclaimer in the
12041394f3SDevin Teske  *    documentation and/or other materials provided with the distribution.
13041394f3SDevin Teske  *
14041394f3SDevin Teske  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15041394f3SDevin Teske  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16041394f3SDevin Teske  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17041394f3SDevin Teske  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18041394f3SDevin Teske  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19041394f3SDevin Teske  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20041394f3SDevin Teske  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21041394f3SDevin Teske  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22041394f3SDevin Teske  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23041394f3SDevin Teske  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24041394f3SDevin Teske  * SUCH DAMAGE.
25041394f3SDevin Teske  */
26041394f3SDevin Teske 
27041394f3SDevin Teske #include <sys/cdefs.h>
28041394f3SDevin Teske #include <sys/stat.h>
29041394f3SDevin Teske #include <sys/time.h>
30041394f3SDevin Teske #include <sys/types.h>
31041394f3SDevin Teske #include <sys/wait.h>
32041394f3SDevin Teske 
33041394f3SDevin Teske #include <ctype.h>
34041394f3SDevin Teske #include <dialog.h>
35041394f3SDevin Teske #include <err.h>
36041394f3SDevin Teske #include <limits.h>
379e35cfceSDevin Teske #include <locale.h>
38041394f3SDevin Teske #include <stdio.h>
39041394f3SDevin Teske #include <stdlib.h>
40041394f3SDevin Teske #include <string.h>
41041394f3SDevin Teske #include <string_m.h>
42041394f3SDevin Teske #include <unistd.h>
43041394f3SDevin Teske 
44041394f3SDevin Teske #include "dialog_util.h"
45041394f3SDevin Teske #include "dialogrc.h"
46041394f3SDevin Teske #include "dprompt.h"
47041394f3SDevin Teske #include "dpv.h"
48041394f3SDevin Teske #include "dpv_private.h"
49041394f3SDevin Teske #include "status.h"
50041394f3SDevin Teske #include "util.h"
51041394f3SDevin Teske 
52041394f3SDevin Teske /* Test Mechanics (Only used when dpv_config.options |= DPV_TEST_MODE) */
53041394f3SDevin Teske #define INCREMENT		1	/* Increment % per-pass test-mode */
54041394f3SDevin Teske #define XDIALOG_INCREMENT	15	/* different for slower Xdialog(1) */
55041394f3SDevin Teske static uint8_t increment = INCREMENT;
56041394f3SDevin Teske 
57041394f3SDevin Teske /* Debugging */
58041394f3SDevin Teske uint8_t debug = FALSE;
59041394f3SDevin Teske 
60041394f3SDevin Teske /* Data to process */
61041394f3SDevin Teske int dpv_interrupt = FALSE;
62041394f3SDevin Teske int dpv_abort = FALSE;
63041394f3SDevin Teske unsigned int dpv_nfiles = 0;
64041394f3SDevin Teske 
65041394f3SDevin Teske /* Data processing */
66041394f3SDevin Teske long long dpv_overall_read = 0;
67041394f3SDevin Teske static char pathbuf[PATH_MAX];
68041394f3SDevin Teske 
69041394f3SDevin Teske /* Extra display information */
7080f7300dSDevin Teske uint8_t keep_tite = FALSE;	/* dpv_config.keep_tite */
71041394f3SDevin Teske uint8_t no_labels = FALSE;	/* dpv_config.options & DPV_NO_LABELS */
72041394f3SDevin Teske uint8_t wide = FALSE;		/* dpv_config.options & DPV_WIDE_MODE */
73041394f3SDevin Teske char *aprompt = NULL;		/* dpv_config.aprompt */
74041394f3SDevin Teske char *msg_done = NULL;		/* dpv_config.msg_done */
75041394f3SDevin Teske char *msg_fail = NULL;		/* dpv_config.msg_fail */
76041394f3SDevin Teske char *msg_pending = NULL;	/* dpv_config.msg_pending */
77041394f3SDevin Teske char *pprompt = NULL;		/* dpv_config.pprompt */
78041394f3SDevin Teske 
79041394f3SDevin Teske /* Status-Line format for when using dialog(3) */
80492b8271SDevin Teske static const char *status_format_custom = NULL;
81492b8271SDevin Teske static char status_format_default[DPV_STATUS_FORMAT_MAX];
82041394f3SDevin Teske 
83041394f3SDevin Teske /*
84041394f3SDevin Teske  * Takes a pointer to a dpv_config structure containing layout details and
85041394f3SDevin Teske  * pointer to initial element in a linked-list of dpv_file_node structures,
86041394f3SDevin Teske  * each presenting a file to process. Executes the `action' function passed-in
87041394f3SDevin Teske  * as a member to the `config' structure argument.
88041394f3SDevin Teske  */
89041394f3SDevin Teske int
dpv(struct dpv_config * config,struct dpv_file_node * file_list)90041394f3SDevin Teske dpv(struct dpv_config *config, struct dpv_file_node *file_list)
91041394f3SDevin Teske {
92041394f3SDevin Teske 	char c;
93041394f3SDevin Teske 	uint8_t keep_going;
94041394f3SDevin Teske 	uint8_t nls = FALSE; /* See dialog_prompt_nlstate() */
95041394f3SDevin Teske 	uint8_t no_overrun = FALSE;
96041394f3SDevin Teske 	uint8_t pprompt_nls = FALSE; /* See dialog_prompt_nlstate() */
97041394f3SDevin Teske 	uint8_t shrink_label_size = FALSE;
98041394f3SDevin Teske 	mode_t mask;
99041394f3SDevin Teske 	uint16_t options;
100041394f3SDevin Teske 	char *cp;
101041394f3SDevin Teske 	char *fc;
102041394f3SDevin Teske 	char *last;
103041394f3SDevin Teske 	char *name;
104041394f3SDevin Teske 	char *output;
105041394f3SDevin Teske 	const char *status_fmt;
106041394f3SDevin Teske 	const char *path_fmt;
107041394f3SDevin Teske 	enum dpv_display display_type;
108041394f3SDevin Teske 	enum dpv_output output_type;
109041394f3SDevin Teske 	enum dpv_status status;
110041394f3SDevin Teske 	int (*action)(struct dpv_file_node *file, int out);
111041394f3SDevin Teske 	int backslash;
112041394f3SDevin Teske 	int dialog_last_update = 0;
113041394f3SDevin Teske 	int dialog_old_nthfile = 0;
114041394f3SDevin Teske 	int dialog_old_seconds = -1;
115041394f3SDevin Teske 	int dialog_out = STDOUT_FILENO;
116041394f3SDevin Teske 	int dialog_update_usec = 0;
117041394f3SDevin Teske 	int dialog_updates_per_second;
118041394f3SDevin Teske 	int files_left;
119041394f3SDevin Teske 	int max_cols;
120041394f3SDevin Teske 	int nthfile = 0;
121041394f3SDevin Teske 	int output_out;
122041394f3SDevin Teske 	int overall = 0;
123041394f3SDevin Teske 	int pct;
124041394f3SDevin Teske 	int res;
125041394f3SDevin Teske 	int seconds;
126041394f3SDevin Teske 	int status_last_update = 0;
127041394f3SDevin Teske 	int status_old_nthfile = 0;
128041394f3SDevin Teske 	int status_old_seconds = -1;
129041394f3SDevin Teske 	int status_update_usec = 0;
130041394f3SDevin Teske 	int status_updates_per_second;
131041394f3SDevin Teske 	pid_t output_pid;
132041394f3SDevin Teske 	pid_t pid;
133041394f3SDevin Teske 	size_t len;
134041394f3SDevin Teske 	struct dpv_file_node *curfile;
135041394f3SDevin Teske 	struct dpv_file_node *first_file;
136041394f3SDevin Teske 	struct dpv_file_node *list_head;
137041394f3SDevin Teske 	struct timeval now;
138041394f3SDevin Teske 	struct timeval start;
139041394f3SDevin Teske 	char init_prompt[PROMPT_MAX + 1] = "";
140041394f3SDevin Teske 
141041394f3SDevin Teske 	/* Initialize globals to default values */
142041394f3SDevin Teske 	aprompt		= NULL;
143041394f3SDevin Teske 	pprompt		= NULL;
144041394f3SDevin Teske 	options		= 0;
145041394f3SDevin Teske 	action		= NULL;
146041394f3SDevin Teske 	backtitle	= NULL;
147041394f3SDevin Teske 	debug		= FALSE;
148041394f3SDevin Teske 	dialog_test	= FALSE;
149041394f3SDevin Teske 	dialog_updates_per_second = DIALOG_UPDATES_PER_SEC;
150041394f3SDevin Teske 	display_limit	= DISPLAY_LIMIT_DEFAULT;
151041394f3SDevin Teske 	display_type	= DPV_DISPLAY_LIBDIALOG;
15280f7300dSDevin Teske 	keep_tite	= FALSE;
153041394f3SDevin Teske 	label_size	= LABEL_SIZE_DEFAULT;
154041394f3SDevin Teske 	msg_done	= NULL;
155041394f3SDevin Teske 	msg_fail	= NULL;
156041394f3SDevin Teske 	msg_pending	= NULL;
157041394f3SDevin Teske 	no_labels	= FALSE;
158041394f3SDevin Teske 	output		= NULL;
159041394f3SDevin Teske 	output_type	= DPV_OUTPUT_NONE;
160041394f3SDevin Teske 	pbar_size	= PBAR_SIZE_DEFAULT;
161041394f3SDevin Teske 	status_format_custom = NULL;
162041394f3SDevin Teske 	status_updates_per_second = STATUS_UPDATES_PER_SEC;
163041394f3SDevin Teske 	title		= NULL;
164041394f3SDevin Teske 	wide		= FALSE;
165041394f3SDevin Teske 
166041394f3SDevin Teske 	/* Process config options (overriding defaults) */
167041394f3SDevin Teske 	if (config != NULL) {
168041394f3SDevin Teske 		if (config->aprompt != NULL) {
169041394f3SDevin Teske 			if (aprompt == NULL) {
170041394f3SDevin Teske 				aprompt = malloc(DPV_APROMPT_MAX);
171041394f3SDevin Teske 				if (aprompt == NULL)
172041394f3SDevin Teske 					return (-1);
173041394f3SDevin Teske 			}
174041394f3SDevin Teske 			snprintf(aprompt, DPV_APROMPT_MAX, "%s",
175041394f3SDevin Teske 			    config->aprompt);
176041394f3SDevin Teske 		}
177041394f3SDevin Teske 		if (config->pprompt != NULL) {
178041394f3SDevin Teske 			if (pprompt == NULL) {
179041394f3SDevin Teske 				pprompt = malloc(DPV_PPROMPT_MAX + 2);
180041394f3SDevin Teske 				/* +2 is for implicit "\n" appended later */
181041394f3SDevin Teske 				if (pprompt == NULL)
182041394f3SDevin Teske 					return (-1);
183041394f3SDevin Teske 			}
184041394f3SDevin Teske 			snprintf(pprompt, DPV_APROMPT_MAX, "%s",
185041394f3SDevin Teske 			    config->pprompt);
186041394f3SDevin Teske 		}
187041394f3SDevin Teske 
188041394f3SDevin Teske 		options		= config->options;
189041394f3SDevin Teske 		action		= config->action;
190041394f3SDevin Teske 		backtitle	= config->backtitle;
191041394f3SDevin Teske 		debug		= config->debug;
192041394f3SDevin Teske 		dialog_test	= ((options & DPV_TEST_MODE) != 0);
193041394f3SDevin Teske 		dialog_updates_per_second = config->dialog_updates_per_second;
194041394f3SDevin Teske 		display_limit	= config->display_limit;
195041394f3SDevin Teske 		display_type	= config->display_type;
19680f7300dSDevin Teske 		keep_tite	= config->keep_tite;
197041394f3SDevin Teske 		label_size	= config->label_size;
198041394f3SDevin Teske 		msg_done	= (char *)config->msg_done;
199041394f3SDevin Teske 		msg_fail	= (char *)config->msg_fail;
200041394f3SDevin Teske 		msg_pending	= (char *)config->msg_pending;
201041394f3SDevin Teske 		no_labels	= ((options & DPV_NO_LABELS) != 0);
202041394f3SDevin Teske 		no_overrun	= ((options & DPV_NO_OVERRUN) != 0);
203041394f3SDevin Teske 		output          = config->output;
204041394f3SDevin Teske 		output_type	= config->output_type;
205041394f3SDevin Teske 		pbar_size	= config->pbar_size;
206041394f3SDevin Teske 		status_updates_per_second = config->status_updates_per_second;
207041394f3SDevin Teske 		title		= config->title;
208041394f3SDevin Teske 		wide		= ((options & DPV_WIDE_MODE) != 0);
209041394f3SDevin Teske 
210041394f3SDevin Teske 		/* Enforce some minimums (pedantic) */
211041394f3SDevin Teske 		if (display_limit < -1)
212041394f3SDevin Teske 			display_limit = -1;
213041394f3SDevin Teske 		if (label_size < -1)
214041394f3SDevin Teske 			label_size = -1;
215041394f3SDevin Teske 		if (pbar_size < -1)
216041394f3SDevin Teske 			pbar_size = -1;
217041394f3SDevin Teske 
218041394f3SDevin Teske 		/* For the mini-pbar, -1 means hide, zero is invalid unless
219041394f3SDevin Teske 		 * only one file is given */
220041394f3SDevin Teske 		if (pbar_size == 0) {
221041394f3SDevin Teske 			if (file_list == NULL || file_list->next == NULL)
222041394f3SDevin Teske 				pbar_size = -1;
223041394f3SDevin Teske 			else
224041394f3SDevin Teske 				pbar_size = PBAR_SIZE_DEFAULT;
225041394f3SDevin Teske 		}
226041394f3SDevin Teske 
227041394f3SDevin Teske 		/* For the label, -1 means auto-size, zero is invalid unless
228041394f3SDevin Teske 		 * specifically requested through the use of options flag */
229041394f3SDevin Teske 		if (label_size == 0 && no_labels == FALSE)
230041394f3SDevin Teske 			label_size = LABEL_SIZE_DEFAULT;
231041394f3SDevin Teske 
232041394f3SDevin Teske 		/* Status update should not be zero */
233041394f3SDevin Teske 		if (status_updates_per_second == 0)
234041394f3SDevin Teske 			status_updates_per_second = STATUS_UPDATES_PER_SEC;
235041394f3SDevin Teske 	} /* config != NULL */
236041394f3SDevin Teske 
237041394f3SDevin Teske 	/* Process the type of display we've been requested to produce */
238041394f3SDevin Teske 	switch (display_type) {
239041394f3SDevin Teske 	case DPV_DISPLAY_STDOUT:
240041394f3SDevin Teske 		debug		= TRUE;
241041394f3SDevin Teske 		use_color	= FALSE;
242041394f3SDevin Teske 		use_dialog	= FALSE;
243041394f3SDevin Teske 		use_libdialog	= FALSE;
244041394f3SDevin Teske 		use_xdialog	= FALSE;
245041394f3SDevin Teske 		break;
246041394f3SDevin Teske 	case DPV_DISPLAY_DIALOG:
247041394f3SDevin Teske 		use_color	= TRUE;
248041394f3SDevin Teske 		use_dialog	= TRUE;
249041394f3SDevin Teske 		use_libdialog	= FALSE;
250041394f3SDevin Teske 		use_xdialog	= FALSE;
251041394f3SDevin Teske 		break;
252041394f3SDevin Teske 	case DPV_DISPLAY_XDIALOG:
253041394f3SDevin Teske 		snprintf(dialog, PATH_MAX, XDIALOG);
254041394f3SDevin Teske 		use_color	= FALSE;
255041394f3SDevin Teske 		use_dialog	= FALSE;
256041394f3SDevin Teske 		use_libdialog	= FALSE;
257041394f3SDevin Teske 		use_xdialog	= TRUE;
258041394f3SDevin Teske 		break;
259041394f3SDevin Teske 	default:
260041394f3SDevin Teske 		use_color	= TRUE;
261041394f3SDevin Teske 		use_dialog	= FALSE;
262041394f3SDevin Teske 		use_libdialog	= TRUE;
263041394f3SDevin Teske 		use_xdialog	= FALSE;
264041394f3SDevin Teske 		break;
265041394f3SDevin Teske 	} /* display_type */
266041394f3SDevin Teske 
267041394f3SDevin Teske 	/* Enforce additional minimums that require knowing our display type */
268041394f3SDevin Teske 	if (dialog_updates_per_second == 0)
269041394f3SDevin Teske 		dialog_updates_per_second = use_xdialog ?
270041394f3SDevin Teske 			XDIALOG_UPDATES_PER_SEC : DIALOG_UPDATES_PER_SEC;
271041394f3SDevin Teske 
272041394f3SDevin Teske 	/* Allow forceful override of use_color */
273041394f3SDevin Teske 	if (config != NULL && (config->options & DPV_USE_COLOR) != 0)
274041394f3SDevin Teske 		use_color = TRUE;
275041394f3SDevin Teske 
276041394f3SDevin Teske 	/* Count the number of files in provided list of dpv_file_node's */
277041394f3SDevin Teske 	if (use_dialog && pprompt != NULL && *pprompt != '\0')
278041394f3SDevin Teske 		pprompt_nls = dialog_prompt_nlstate(pprompt);
279041394f3SDevin Teske 
280041394f3SDevin Teske 	max_cols = dialog_maxcols();
281041394f3SDevin Teske 	if (label_size == -1)
282041394f3SDevin Teske 		shrink_label_size = TRUE;
283041394f3SDevin Teske 
284041394f3SDevin Teske 	/* Process file arguments */
285041394f3SDevin Teske 	for (curfile = file_list; curfile != NULL; curfile = curfile->next) {
286041394f3SDevin Teske 		dpv_nfiles++;
287041394f3SDevin Teske 
288041394f3SDevin Teske 		/* dialog(3) only expands literal newlines */
289041394f3SDevin Teske 		if (use_libdialog) strexpandnl(curfile->name);
290041394f3SDevin Teske 
291041394f3SDevin Teske 		/* Optionally calculate label size for file */
292041394f3SDevin Teske 		if (shrink_label_size) {
293041394f3SDevin Teske 			nls = FALSE;
294041394f3SDevin Teske 			name = curfile->name;
295041394f3SDevin Teske 			if (curfile == file_list)
296041394f3SDevin Teske 				nls = pprompt_nls;
297041394f3SDevin Teske 			last = (char *)dialog_prompt_lastline(name, nls);
298041394f3SDevin Teske 			if (use_dialog) {
299041394f3SDevin Teske 				c = *last;
300041394f3SDevin Teske 				*last = '\0';
301041394f3SDevin Teske 				nls = dialog_prompt_nlstate(name);
302041394f3SDevin Teske 				*last = c;
303041394f3SDevin Teske 			}
304041394f3SDevin Teske 			len = dialog_prompt_longestline(last, nls);
305041394f3SDevin Teske 			if ((int)len > (label_size - 3)) {
306041394f3SDevin Teske 				if (label_size > 0)
307041394f3SDevin Teske 					label_size += 3;
308041394f3SDevin Teske 				label_size = len;
309041394f3SDevin Teske 				/* Room for ellipsis (unless NULL) */
310041394f3SDevin Teske 				if (label_size > 0)
311041394f3SDevin Teske 					label_size += 3;
312041394f3SDevin Teske 			}
313041394f3SDevin Teske 
314041394f3SDevin Teske 			if (max_cols > 0 && label_size > (max_cols - pbar_size
315041394f3SDevin Teske 			    - 9))
316041394f3SDevin Teske 				label_size = max_cols - pbar_size - 9;
317041394f3SDevin Teske 		}
318041394f3SDevin Teske 
319041394f3SDevin Teske 		if (debug)
320041394f3SDevin Teske 			warnx("label=[%s] path=[%s] size=%lli",
321041394f3SDevin Teske 			    curfile->name, curfile->path, curfile->length);
322041394f3SDevin Teske 	} /* file_list */
323041394f3SDevin Teske 
324041394f3SDevin Teske 	/* Optionally process the contents of DIALOGRC (~/.dialogrc) */
325041394f3SDevin Teske 	if (use_dialog) {
326041394f3SDevin Teske 		res = parse_dialogrc();
327041394f3SDevin Teske 		if (debug && res == 0) {
328041394f3SDevin Teske 			warnx("Successfully read `%s' config file", DIALOGRC);
329041394f3SDevin Teske 			warnx("use_shadow = %i (Boolean)", use_shadow);
330041394f3SDevin Teske 			warnx("use_colors = %i (Boolean)", use_colors);
331041394f3SDevin Teske 			warnx("gauge_color=[%s] (FBH)", gauge_color);
332041394f3SDevin Teske 		}
333041394f3SDevin Teske 	} else if (use_libdialog) {
334041394f3SDevin Teske 		init_dialog(stdin, stdout);
335041394f3SDevin Teske 		use_shadow = dialog_state.use_shadow;
336041394f3SDevin Teske 		use_colors = dialog_state.use_colors;
337041394f3SDevin Teske 		gauge_color[0] = 48 + dlg_color_table[GAUGE_ATTR].fg;
338041394f3SDevin Teske 		gauge_color[1] = 48 + dlg_color_table[GAUGE_ATTR].bg;
339041394f3SDevin Teske 		gauge_color[2] = dlg_color_table[GAUGE_ATTR].hilite ?
340041394f3SDevin Teske 		    'b' : 'B';
341041394f3SDevin Teske 		gauge_color[3] = '\0';
342041394f3SDevin Teske 		end_dialog();
343041394f3SDevin Teske 		if (debug) {
344041394f3SDevin Teske 			warnx("Finished initializing dialog(3) library");
345041394f3SDevin Teske 			warnx("use_shadow = %i (Boolean)", use_shadow);
346041394f3SDevin Teske 			warnx("use_colors = %i (Boolean)", use_colors);
347041394f3SDevin Teske 			warnx("gauge_color=[%s] (FBH)", gauge_color);
348041394f3SDevin Teske 		}
349041394f3SDevin Teske 	}
350041394f3SDevin Teske 
351041394f3SDevin Teske 	/* Enable mini progress bar automatically for stdin streams if unable
352041394f3SDevin Teske 	 * to calculate progress (missing `lines:' syntax). */
353041394f3SDevin Teske 	if (dpv_nfiles <= 1 && file_list != NULL && file_list->length < 0 &&
354041394f3SDevin Teske 	    !dialog_test)
355041394f3SDevin Teske 		pbar_size = PBAR_SIZE_DEFAULT;
356041394f3SDevin Teske 
357041394f3SDevin Teske 	/* If $USE_COLOR is set and non-NULL enable color; otherwise disable */
358041394f3SDevin Teske 	if ((cp = getenv(ENV_USE_COLOR)) != 0)
359041394f3SDevin Teske 		use_color = *cp != '\0' ? 1 : 0;
360041394f3SDevin Teske 
361041394f3SDevin Teske 	/* Print error and return `-1' if not given at least one name */
362041394f3SDevin Teske 	if (dpv_nfiles == 0) {
363041394f3SDevin Teske 		warnx("%s: no labels provided", __func__);
364041394f3SDevin Teske 		return (-1);
365041394f3SDevin Teske 	} else if (debug)
366041394f3SDevin Teske 		warnx("%s: %u label%s provided", __func__, dpv_nfiles,
367041394f3SDevin Teske 		    dpv_nfiles == 1 ? "" : "s");
368041394f3SDevin Teske 
369041394f3SDevin Teske 	/* If only one file and pbar size is zero, default to `-1' */
370041394f3SDevin Teske 	if (dpv_nfiles <= 1 && pbar_size == 0)
371041394f3SDevin Teske 		pbar_size = -1;
372041394f3SDevin Teske 
373041394f3SDevin Teske 	/* Print some debugging information */
374041394f3SDevin Teske 	if (debug) {
375041394f3SDevin Teske 		warnx("%s: %s(%i) max rows x cols = %i x %i",
376041394f3SDevin Teske 		    __func__, use_xdialog ? XDIALOG : DIALOG,
377041394f3SDevin Teske 		    use_libdialog ? 3 : 1, dialog_maxrows(),
378041394f3SDevin Teske 		    dialog_maxcols());
379041394f3SDevin Teske 	}
380041394f3SDevin Teske 
381041394f3SDevin Teske 	/* Xdialog(1) updates a lot slower than dialog(1) */
382041394f3SDevin Teske 	if (dialog_test && use_xdialog)
383041394f3SDevin Teske 		increment = XDIALOG_INCREMENT;
384041394f3SDevin Teske 
385041394f3SDevin Teske 	/* Always add implicit newline to pprompt (when specified) */
386041394f3SDevin Teske 	if (pprompt != NULL && *pprompt != '\0') {
387041394f3SDevin Teske 		len = strlen(pprompt);
388041394f3SDevin Teske 		/*
389041394f3SDevin Teske 		 * NOTE: pprompt = malloc(PPROMPT_MAX + 2)
390041394f3SDevin Teske 		 * NOTE: (see getopt(2) section above for pprompt allocation)
391041394f3SDevin Teske 		 */
392041394f3SDevin Teske 		pprompt[len++] = '\\';
393041394f3SDevin Teske 		pprompt[len++] = 'n';
394041394f3SDevin Teske 		pprompt[len++] = '\0';
395041394f3SDevin Teske 	}
396041394f3SDevin Teske 
397041394f3SDevin Teske 	/* Xdialog(1) requires newlines (a) escaped and (b) in triplicate */
398041394f3SDevin Teske 	if (use_xdialog && pprompt != NULL) {
399041394f3SDevin Teske 		/* Replace `\n' with `\n\\n\n' in pprompt */
400041394f3SDevin Teske 		len = strlen(pprompt);
401041394f3SDevin Teske 		len += strcount(pprompt, "\\n") * 2;
402041394f3SDevin Teske 		if (len > DPV_PPROMPT_MAX)
403041394f3SDevin Teske 			errx(EXIT_FAILURE, "%s: Oops, pprompt buffer overflow "
404041394f3SDevin Teske 			    "(%zu > %i)", __func__, len, DPV_PPROMPT_MAX);
405041394f3SDevin Teske 		if (replaceall(pprompt, "\\n", "\n\\n\n") < 0)
406041394f3SDevin Teske 			err(EXIT_FAILURE, "%s: replaceall()", __func__);
407041394f3SDevin Teske 	}
408041394f3SDevin Teske 	/* libdialog requires literal newlines */
409041394f3SDevin Teske 	else if (use_libdialog && pprompt != NULL)
410041394f3SDevin Teske 		strexpandnl(pprompt);
411041394f3SDevin Teske 
412041394f3SDevin Teske 	/* Xdialog(1) requires newlines (a) escaped and (b) in triplicate */
413041394f3SDevin Teske 	if (use_xdialog && aprompt != NULL) {
414041394f3SDevin Teske 		/* Replace `\n' with `\n\\n\n' in aprompt */
415041394f3SDevin Teske 		len = strlen(aprompt);
416041394f3SDevin Teske 		len += strcount(aprompt, "\\n") * 2;
417041394f3SDevin Teske 		if (len > DPV_APROMPT_MAX)
418041394f3SDevin Teske 			errx(EXIT_FAILURE, "%s: Oops, aprompt buffer overflow "
419041394f3SDevin Teske 			    " (%zu > %i)", __func__, len, DPV_APROMPT_MAX);
420041394f3SDevin Teske 		if (replaceall(aprompt, "\\n", "\n\\n\n") < 0)
421041394f3SDevin Teske 			err(EXIT_FAILURE, "%s: replaceall()", __func__);
422041394f3SDevin Teske 	}
423041394f3SDevin Teske 	/* libdialog requires literal newlines */
424041394f3SDevin Teske 	else if (use_libdialog && aprompt != NULL)
425041394f3SDevin Teske 		strexpandnl(aprompt);
426041394f3SDevin Teske 
427041394f3SDevin Teske 	/*
428041394f3SDevin Teske 	 * Warn user about an obscure dialog(1) bug (neither Xdialog(1) nor
429041394f3SDevin Teske 	 * libdialog are affected) in the `--gauge' widget. If the first non-
430041394f3SDevin Teske 	 * whitespace letter of "{new_prompt}" in "XXX\n{new_prompt}\nXXX\n"
431041394f3SDevin Teske 	 * is a number, the number can sometimes be mistaken for a percentage
432041394f3SDevin Teske 	 * to the overall progressbar. Other nasty side-effects such as the
433041394f3SDevin Teske 	 * entire prompt not displaying or displaying improperly are caused by
434041394f3SDevin Teske 	 * this bug too.
435041394f3SDevin Teske 	 *
436041394f3SDevin Teske 	 * NOTE: When we can use color, we have a work-around... prefix the
437041394f3SDevin Teske 	 * output with `\Zn' (used to terminate ANSI and reset to normal).
438041394f3SDevin Teske 	 */
439041394f3SDevin Teske 	if (use_dialog && !use_color) {
440041394f3SDevin Teske 		backslash = 0;
441041394f3SDevin Teske 
442041394f3SDevin Teske 		/* First, check pprompt (falls through if NULL) */
443041394f3SDevin Teske 		fc = pprompt;
444041394f3SDevin Teske 		while (fc != NULL && *fc != '\0') {
445041394f3SDevin Teske 			if (*fc == '\n') /* leading literal newline OK */
446041394f3SDevin Teske 				break;
447041394f3SDevin Teske 			if (!isspace(*fc) && *fc != '\\' && backslash == 0)
448041394f3SDevin Teske 				break;
449041394f3SDevin Teske 			else if (backslash > 0 && *fc != 'n')
450041394f3SDevin Teske 				break;
451041394f3SDevin Teske 			else if (*fc == '\\') {
452041394f3SDevin Teske 				backslash++;
453041394f3SDevin Teske 				if (backslash > 2)
454041394f3SDevin Teske 					break; /* we're safe */
455041394f3SDevin Teske 			}
456041394f3SDevin Teske 			fc++;
457041394f3SDevin Teske 		}
458041394f3SDevin Teske 		/* First non-whitespace character that dialog(1) will see */
459041394f3SDevin Teske 		if (fc != NULL && *fc >= '0' && *fc <= '9')
460041394f3SDevin Teske 			warnx("%s: WARNING! text argument to `-p' begins with "
461041394f3SDevin Teske 			    "a number (not recommended)", __func__);
462041394f3SDevin Teske 		else if (fc > pprompt)
463041394f3SDevin Teske 			warnx("%s: WARNING! text argument to `-p' begins with "
464041394f3SDevin Teske 			    "whitespace (not recommended)", __func__);
465041394f3SDevin Teske 
466041394f3SDevin Teske 		/*
467041394f3SDevin Teske 		 * If no pprompt or pprompt is all whitespace, check the first
468041394f3SDevin Teske 		 * file name provided to make sure it is alright too.
469041394f3SDevin Teske 		 */
470041394f3SDevin Teske 		if ((pprompt == NULL || *fc == '\0') && file_list != NULL) {
471041394f3SDevin Teske 			first_file = file_list;
472041394f3SDevin Teske 			fc = first_file->name;
473041394f3SDevin Teske 			while (fc != NULL && *fc != '\0' && isspace(*fc))
474041394f3SDevin Teske 				fc++;
475041394f3SDevin Teske 			/* First non-whitespace char that dialog(1) will see */
476041394f3SDevin Teske 			if (fc != NULL && *fc >= '0' && *fc <= '9')
477041394f3SDevin Teske 				warnx("%s: WARNING! File name `%s' begins "
478041394f3SDevin Teske 				    "with a number (use `-p text' for safety)",
479041394f3SDevin Teske 				    __func__, first_file->name);
480041394f3SDevin Teske 		}
481041394f3SDevin Teske 	}
482041394f3SDevin Teske 
483041394f3SDevin Teske 	dprompt_init(file_list);
484041394f3SDevin Teske 		/* Reads: label_size pbar_size pprompt aprompt dpv_nfiles */
485041394f3SDevin Teske 		/* Inits: dheight and dwidth */
486041394f3SDevin Teske 
4879e35cfceSDevin Teske 	/* Default localeconv(3) settings for dialog(3) status */
4889e35cfceSDevin Teske 	setlocale(LC_NUMERIC,
4899e35cfceSDevin Teske 		getenv("LC_ALL") == NULL && getenv("LC_NUMERIC") == NULL ?
4909e35cfceSDevin Teske 		LC_NUMERIC_DEFAULT : "");
4919e35cfceSDevin Teske 
492041394f3SDevin Teske 	if (!debug) {
493041394f3SDevin Teske 		/* Internally create the initial `--gauge' prompt text */
494041394f3SDevin Teske 		dprompt_recreate(file_list, (struct dpv_file_node *)NULL, 0);
495041394f3SDevin Teske 
496041394f3SDevin Teske 		/* Spawn [X]dialog(1) `--gauge', returning pipe descriptor */
497041394f3SDevin Teske 		if (use_libdialog) {
498041394f3SDevin Teske 			status_printf("");
499041394f3SDevin Teske 			dprompt_libprint(pprompt, aprompt, 0);
500041394f3SDevin Teske 		} else {
501041394f3SDevin Teske 			dprompt_sprint(init_prompt, pprompt, aprompt);
502041394f3SDevin Teske 			dialog_out = dialog_spawn_gauge(init_prompt, &pid);
503041394f3SDevin Teske 			dprompt_dprint(dialog_out, pprompt, aprompt, 0);
504041394f3SDevin Teske 		}
505041394f3SDevin Teske 	} /* !debug */
506041394f3SDevin Teske 
507041394f3SDevin Teske 	/* Seed the random(3) generator */
508041394f3SDevin Teske 	if (dialog_test)
509041394f3SDevin Teske 		srandom(0xf1eeface);
510041394f3SDevin Teske 
511041394f3SDevin Teske 	/* Set default/custom status line format */
512041394f3SDevin Teske 	if (dpv_nfiles > 1) {
513041394f3SDevin Teske 		snprintf(status_format_default, DPV_STATUS_FORMAT_MAX, "%s",
514041394f3SDevin Teske 		    DPV_STATUS_MANY);
515041394f3SDevin Teske 		status_format_custom = config->status_many;
516041394f3SDevin Teske 	} else {
517041394f3SDevin Teske 		snprintf(status_format_default, DPV_STATUS_FORMAT_MAX, "%s",
518041394f3SDevin Teske 		    DPV_STATUS_SOLO);
519041394f3SDevin Teske 		status_format_custom = config->status_solo;
520041394f3SDevin Teske 	}
521041394f3SDevin Teske 
522041394f3SDevin Teske 	/* Add test mode identifier to default status line if enabled */
523041394f3SDevin Teske 	if (dialog_test && (strlen(status_format_default) + 12) <
524041394f3SDevin Teske 	    DPV_STATUS_FORMAT_MAX)
525041394f3SDevin Teske 		strcat(status_format_default, " [TEST MODE]");
526041394f3SDevin Teske 
527041394f3SDevin Teske 	/* Verify custom status format */
528041394f3SDevin Teske 	status_fmt = fmtcheck(status_format_custom, status_format_default);
529041394f3SDevin Teske 	if (status_format_custom != NULL &&
530041394f3SDevin Teske 	    status_fmt == status_format_default) {
531041394f3SDevin Teske 		warnx("WARNING! Invalid status_format configuration `%s'",
532041394f3SDevin Teske 		      status_format_custom);
533041394f3SDevin Teske 		warnx("Default status_format `%s'", status_format_default);
534041394f3SDevin Teske 	}
535041394f3SDevin Teske 
536041394f3SDevin Teske 	/* Record when we started (used to prevent updating too quickly) */
537041394f3SDevin Teske 	(void)gettimeofday(&start, (struct timezone *)NULL);
538041394f3SDevin Teske 
539041394f3SDevin Teske 	/* Calculate number of microseconds in-between sub-second updates */
540041394f3SDevin Teske 	if (status_updates_per_second != 0)
541041394f3SDevin Teske 		status_update_usec = 1000000 / status_updates_per_second;
542041394f3SDevin Teske 	if (dialog_updates_per_second != 0)
543041394f3SDevin Teske 		dialog_update_usec = 1000000 / dialog_updates_per_second;
544041394f3SDevin Teske 
545041394f3SDevin Teske 	/*
546041394f3SDevin Teske 	 * Process the file list [serially] (one for each argument passed)
547041394f3SDevin Teske 	 */
548041394f3SDevin Teske 	files_left = dpv_nfiles;
549041394f3SDevin Teske 	list_head = file_list;
550041394f3SDevin Teske 	for (curfile = file_list; curfile != NULL; curfile = curfile->next) {
551041394f3SDevin Teske 		keep_going = TRUE;
552041394f3SDevin Teske 		output_out = -1;
553041394f3SDevin Teske 		pct = 0;
554041394f3SDevin Teske 		nthfile++;
555041394f3SDevin Teske 		files_left--;
556041394f3SDevin Teske 
557041394f3SDevin Teske 		if (dpv_interrupt)
558041394f3SDevin Teske 			break;
559041394f3SDevin Teske 		if (dialog_test)
560041394f3SDevin Teske 			pct = 0 - increment;
561041394f3SDevin Teske 
562041394f3SDevin Teske 		/* Attempt to spawn output program for this file */
563041394f3SDevin Teske 		if (!dialog_test && output != NULL) {
564041394f3SDevin Teske 			mask = umask(0022);
565041394f3SDevin Teske 			(void)umask(mask);
566041394f3SDevin Teske 
567041394f3SDevin Teske 			switch (output_type) {
568041394f3SDevin Teske 			case DPV_OUTPUT_SHELL:
569041394f3SDevin Teske 				output_out = shell_spawn_pipecmd(output,
570041394f3SDevin Teske 				    curfile->name, &output_pid);
571041394f3SDevin Teske 				break;
572041394f3SDevin Teske 			case DPV_OUTPUT_FILE:
573041394f3SDevin Teske 				path_fmt = fmtcheck(output, "%s");
574041394f3SDevin Teske 				if (path_fmt == output)
575041394f3SDevin Teske 					len = snprintf(pathbuf,
576041394f3SDevin Teske 					    PATH_MAX, output, curfile->name);
577041394f3SDevin Teske 				else
578041394f3SDevin Teske 					len = snprintf(pathbuf,
579041394f3SDevin Teske 					    PATH_MAX, "%s", output);
580041394f3SDevin Teske 				if (len >= PATH_MAX) {
581041394f3SDevin Teske 					warnx("%s:%d:%s: pathbuf[%u] too small"
582041394f3SDevin Teske 					    "to hold output argument",
583041394f3SDevin Teske 					    __FILE__, __LINE__, __func__,
584041394f3SDevin Teske 					    PATH_MAX);
585041394f3SDevin Teske 					return (-1);
586041394f3SDevin Teske 				}
587041394f3SDevin Teske 				if ((output_out = open(pathbuf,
588041394f3SDevin Teske 				    O_CREAT|O_WRONLY, DEFFILEMODE & ~mask))
589041394f3SDevin Teske 				    < 0) {
590041394f3SDevin Teske 					warn("%s", pathbuf);
591041394f3SDevin Teske 					return (-1);
592041394f3SDevin Teske 				}
593041394f3SDevin Teske 				break;
594041394f3SDevin Teske 			default:
595041394f3SDevin Teske 				break;
596041394f3SDevin Teske 			}
597041394f3SDevin Teske 		}
598041394f3SDevin Teske 
599041394f3SDevin Teske 		while (!dpv_interrupt && keep_going) {
600041394f3SDevin Teske 			if (dialog_test) {
601041394f3SDevin Teske 				usleep(50000);
602041394f3SDevin Teske 				pct += increment;
603041394f3SDevin Teske 				dpv_overall_read +=
604041394f3SDevin Teske 				    (int)(random() / 512 / dpv_nfiles);
605041394f3SDevin Teske 				    /* 512 limits fake readout to Megabytes */
606041394f3SDevin Teske 			} else if (action != NULL)
607041394f3SDevin Teske 				pct = action(curfile, output_out);
608041394f3SDevin Teske 
609041394f3SDevin Teske 			if (no_overrun || dialog_test)
610041394f3SDevin Teske 				keep_going = (pct < 100);
611041394f3SDevin Teske 			else {
612041394f3SDevin Teske 				status = curfile->status;
613041394f3SDevin Teske 				keep_going = (status == DPV_STATUS_RUNNING);
614041394f3SDevin Teske 			}
615041394f3SDevin Teske 
616041394f3SDevin Teske 			/* Get current time and calculate seconds elapsed */
617041394f3SDevin Teske 			gettimeofday(&now, (struct timezone *)NULL);
618041394f3SDevin Teske 			now.tv_sec = now.tv_sec - start.tv_sec;
619041394f3SDevin Teske 			now.tv_usec = now.tv_usec - start.tv_usec;
620041394f3SDevin Teske 			if (now.tv_usec < 0)
621041394f3SDevin Teske 				now.tv_sec--, now.tv_usec += 1000000;
622041394f3SDevin Teske 			seconds = now.tv_sec + (now.tv_usec / 1000000.0);
623041394f3SDevin Teske 
624041394f3SDevin Teske 			/* Update dialog (be it dialog(3), dialog(1), etc.) */
625041394f3SDevin Teske 			if ((dialog_updates_per_second != 0 &&
626041394f3SDevin Teske 			   (
627041394f3SDevin Teske 			    seconds != dialog_old_seconds ||
628041394f3SDevin Teske 			    now.tv_usec - dialog_last_update >=
629041394f3SDevin Teske 			        dialog_update_usec ||
630041394f3SDevin Teske 			    nthfile != dialog_old_nthfile
631041394f3SDevin Teske 			   )) || pct == 100
632041394f3SDevin Teske 			) {
633041394f3SDevin Teske 				/* Calculate overall progress (rounding up) */
634041394f3SDevin Teske 				overall = (100 * nthfile - 100 + pct) /
635041394f3SDevin Teske 				    dpv_nfiles;
636041394f3SDevin Teske 				if (((100 * nthfile - 100 + pct) * 10 /
637041394f3SDevin Teske 				    dpv_nfiles % 100) > 50)
638041394f3SDevin Teske 					overall++;
639041394f3SDevin Teske 
640041394f3SDevin Teske 				dprompt_recreate(list_head, curfile, pct);
641041394f3SDevin Teske 
642041394f3SDevin Teske 				if (use_libdialog && !debug) {
643041394f3SDevin Teske 					/* Update dialog(3) widget */
644041394f3SDevin Teske 					dprompt_libprint(pprompt, aprompt,
645041394f3SDevin Teske 					    overall);
646041394f3SDevin Teske 				} else {
647041394f3SDevin Teske 					/* stdout, dialog(1), or Xdialog(1) */
648041394f3SDevin Teske 					dprompt_dprint(dialog_out, pprompt,
649041394f3SDevin Teske 					    aprompt, overall);
650041394f3SDevin Teske 					fsync(dialog_out);
651041394f3SDevin Teske 				}
652041394f3SDevin Teske 				dialog_old_seconds = seconds;
653041394f3SDevin Teske 				dialog_old_nthfile = nthfile;
654041394f3SDevin Teske 				dialog_last_update = now.tv_usec;
655041394f3SDevin Teske 			}
656041394f3SDevin Teske 
657041394f3SDevin Teske 			/* Update the status line */
658041394f3SDevin Teske 			if ((use_libdialog && !debug) &&
659041394f3SDevin Teske 			    status_updates_per_second != 0 &&
660041394f3SDevin Teske 			   (
661041394f3SDevin Teske 			    keep_going != TRUE ||
662041394f3SDevin Teske 			    seconds != status_old_seconds ||
663041394f3SDevin Teske 			    now.tv_usec - status_last_update >=
664041394f3SDevin Teske 			        status_update_usec ||
665041394f3SDevin Teske 			    nthfile != status_old_nthfile
666041394f3SDevin Teske 			   )
667041394f3SDevin Teske 			) {
668041394f3SDevin Teske 				status_printf(status_fmt, dpv_overall_read,
669041394f3SDevin Teske 				    (dpv_overall_read / (seconds == 0 ? 1 :
670041394f3SDevin Teske 					seconds) * 1.0),
671041394f3SDevin Teske 				    1, /* XXX until we add parallelism XXX */
672041394f3SDevin Teske 				    files_left);
673041394f3SDevin Teske 				status_old_seconds = seconds;
674041394f3SDevin Teske 				status_old_nthfile = nthfile;
675041394f3SDevin Teske 				status_last_update = now.tv_usec;
676041394f3SDevin Teske 			}
677041394f3SDevin Teske 		}
678041394f3SDevin Teske 
679041394f3SDevin Teske 		if (!dialog_test && output_out >= 0) {
680041394f3SDevin Teske 			close(output_out);
681041394f3SDevin Teske 			waitpid(output_pid, (int *)NULL, 0);
682041394f3SDevin Teske 		}
683041394f3SDevin Teske 
684041394f3SDevin Teske 		if (dpv_abort)
685041394f3SDevin Teske 			break;
686041394f3SDevin Teske 
687041394f3SDevin Teske 		/* Advance head of list when we hit the max display lines */
688041394f3SDevin Teske 		if (display_limit > 0 && nthfile % display_limit == 0)
689041394f3SDevin Teske 			list_head = curfile->next;
690041394f3SDevin Teske 	}
691041394f3SDevin Teske 
692041394f3SDevin Teske 	if (!debug) {
693041394f3SDevin Teske 		if (use_libdialog)
694041394f3SDevin Teske 			end_dialog();
695041394f3SDevin Teske 		else {
696041394f3SDevin Teske 			close(dialog_out);
697041394f3SDevin Teske 			waitpid(pid, (int *)NULL, 0);
698041394f3SDevin Teske 		}
69980f7300dSDevin Teske 		if (!keep_tite && !dpv_interrupt)
700041394f3SDevin Teske 			printf("\n");
701041394f3SDevin Teske 	} else
702324c11a1SDevin Teske 		warnx("%s: %lli overall read", __func__, dpv_overall_read);
703041394f3SDevin Teske 
704041394f3SDevin Teske 	if (dpv_interrupt || dpv_abort)
705041394f3SDevin Teske 		return (-1);
706041394f3SDevin Teske 	else
707041394f3SDevin Teske 		return (0);
708041394f3SDevin Teske }
709041394f3SDevin Teske 
710041394f3SDevin Teske /*
711041394f3SDevin Teske  * Free allocated items initialized by dpv()
712041394f3SDevin Teske  */
713041394f3SDevin Teske void
dpv_free(void)714041394f3SDevin Teske dpv_free(void)
715041394f3SDevin Teske {
716041394f3SDevin Teske 	dialogrc_free();
717041394f3SDevin Teske 	dprompt_free();
718041394f3SDevin Teske 	dialog_maxsize_free();
719041394f3SDevin Teske 	if (aprompt != NULL) {
720041394f3SDevin Teske 		free(aprompt);
721041394f3SDevin Teske 		aprompt = NULL;
722041394f3SDevin Teske 	}
723041394f3SDevin Teske 	if (pprompt != NULL) {
724041394f3SDevin Teske 		free(pprompt);
725041394f3SDevin Teske 		pprompt = NULL;
726041394f3SDevin Teske 	}
727041394f3SDevin Teske 	status_free();
728041394f3SDevin Teske }
729