xref: /openbsd-src/bin/pax/gen_subs.c (revision 9a584187e4c4816927eda2f40fed4c501b95e0ea)
1*9a584187Sflorian /*	$OpenBSD: gen_subs.c,v 1.34 2024/04/27 19:49:42 florian Exp $	*/
2df930be7Sderaadt /*	$NetBSD: gen_subs.c,v 1.5 1995/03/21 09:07:26 cgd Exp $	*/
3df930be7Sderaadt 
4df930be7Sderaadt /*-
5df930be7Sderaadt  * Copyright (c) 1992 Keith Muller.
6df930be7Sderaadt  * Copyright (c) 1992, 1993
7df930be7Sderaadt  *	The Regents of the University of California.  All rights reserved.
8df930be7Sderaadt  *
9df930be7Sderaadt  * This code is derived from software contributed to Berkeley by
10df930be7Sderaadt  * Keith Muller of the University of California, San Diego.
11df930be7Sderaadt  *
12df930be7Sderaadt  * Redistribution and use in source and binary forms, with or without
13df930be7Sderaadt  * modification, are permitted provided that the following conditions
14df930be7Sderaadt  * are met:
15df930be7Sderaadt  * 1. Redistributions of source code must retain the above copyright
16df930be7Sderaadt  *    notice, this list of conditions and the following disclaimer.
17df930be7Sderaadt  * 2. Redistributions in binary form must reproduce the above copyright
18df930be7Sderaadt  *    notice, this list of conditions and the following disclaimer in the
19df930be7Sderaadt  *    documentation and/or other materials provided with the distribution.
2029295d1cSmillert  * 3. Neither the name of the University nor the names of its contributors
21df930be7Sderaadt  *    may be used to endorse or promote products derived from this software
22df930be7Sderaadt  *    without specific prior written permission.
23df930be7Sderaadt  *
24df930be7Sderaadt  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25df930be7Sderaadt  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26df930be7Sderaadt  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27df930be7Sderaadt  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28df930be7Sderaadt  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29df930be7Sderaadt  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30df930be7Sderaadt  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31df930be7Sderaadt  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32df930be7Sderaadt  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33df930be7Sderaadt  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34df930be7Sderaadt  * SUCH DAMAGE.
35df930be7Sderaadt  */
36df930be7Sderaadt 
37df930be7Sderaadt #include <sys/types.h>
38df930be7Sderaadt #include <sys/stat.h>
394c043852Sguenther #include <grp.h>
404c043852Sguenther #include <pwd.h>
41df930be7Sderaadt #include <stdio.h>
42df930be7Sderaadt #include <stdlib.h>
43df930be7Sderaadt #include <string.h>
443055081cSguenther #include <time.h>
454c043852Sguenther #include <unistd.h>
464c043852Sguenther #include <utmp.h>
47c5738c9aSmillert #include <vis.h>
484c043852Sguenther 
49df930be7Sderaadt #include "pax.h"
50df930be7Sderaadt #include "extern.h"
51df930be7Sderaadt 
52df930be7Sderaadt /*
53df930be7Sderaadt  * a collection of general purpose subroutines used by pax
54df930be7Sderaadt  */
55df930be7Sderaadt 
56df930be7Sderaadt /*
57df930be7Sderaadt  * constants used by ls_list() when printing out archive members
58df930be7Sderaadt  */
59df930be7Sderaadt #define MODELEN 20
60df930be7Sderaadt #define DATELEN 64
61f7055df5Smillert #define SECSPERDAY	(24 * 60 * 60)
62f7055df5Smillert #define SIXMONTHS	(SECSPERDAY * 365 / 2)
63df930be7Sderaadt #define CURFRMT		"%b %e %H:%M"
64df930be7Sderaadt #define OLDFRMT		"%b %e  %Y"
65b11685ceSdanh #define NAME_WIDTH	8
669c38e9f3Sguenther #define	TIMEFMT(t, now) \
679c38e9f3Sguenther 	(((t) + SIXMONTHS <= (now) || (t) > (now)) ? OLDFRMT : CURFRMT)
68df930be7Sderaadt 
69df930be7Sderaadt /*
70df930be7Sderaadt  * ls_list()
71df930be7Sderaadt  *	list the members of an archive in ls format
72df930be7Sderaadt  */
73df930be7Sderaadt 
74df930be7Sderaadt void
ls_list(ARCHD * arcn,time_t now,FILE * fp)75be87792eSmillert ls_list(ARCHD *arcn, time_t now, FILE *fp)
76df930be7Sderaadt {
77be87792eSmillert 	struct stat *sbp;
78a782b597Sflorian 	struct tm *tm;
79df930be7Sderaadt 	char f_mode[MODELEN];
80df930be7Sderaadt 	char f_date[DATELEN];
819cd57097Smillert 	int term;
829cd57097Smillert 
839cd57097Smillert 	term = zeroflag ? '\0' : '\n';	/* path termination character */
84df930be7Sderaadt 
85df930be7Sderaadt 	/*
86df930be7Sderaadt 	 * if not verbose, just print the file name
87df930be7Sderaadt 	 */
88df930be7Sderaadt 	if (!vflag) {
899cd57097Smillert 		if (zeroflag)
909cd57097Smillert 			(void)fputs(arcn->name, fp);
919cd57097Smillert 		else
92c5738c9aSmillert 			safe_print(arcn->name, fp);
939cd57097Smillert 		(void)putc(term, fp);
94f2d26cdcSmillert 		(void)fflush(fp);
95df930be7Sderaadt 		return;
96df930be7Sderaadt 	}
97df930be7Sderaadt 
98df930be7Sderaadt 	/*
99df930be7Sderaadt 	 * user wants long mode
100df930be7Sderaadt 	 */
101df930be7Sderaadt 	sbp = &(arcn->sb);
102df930be7Sderaadt 	strmode(sbp->st_mode, f_mode);
103df930be7Sderaadt 
104df930be7Sderaadt 	/*
105df930be7Sderaadt 	 * print file mode, link count, uid, gid and time
106df930be7Sderaadt 	 */
107a782b597Sflorian 	if ((tm = localtime(&(sbp->st_mtime))) == NULL)
108a782b597Sflorian 		f_date[0] = '\0';
109a782b597Sflorian 	else if (strftime(f_date, sizeof(f_date), TIMEFMT(sbp->st_mtime, now),
110a782b597Sflorian 	    tm) == 0)
111df930be7Sderaadt 		f_date[0] = '\0';
112b11685ceSdanh 	(void)fprintf(fp, "%s%2u %-*.*s %-*.*s ", f_mode, sbp->st_nlink,
1134c043852Sguenther 		NAME_WIDTH, UT_NAMESIZE, user_from_uid(sbp->st_uid, 0),
1144c043852Sguenther 		NAME_WIDTH, UT_NAMESIZE, group_from_gid(sbp->st_gid, 0));
115df930be7Sderaadt 
116df930be7Sderaadt 	/*
117df930be7Sderaadt 	 * print device id's for devices, or sizes for other nodes
118df930be7Sderaadt 	 */
119df930be7Sderaadt 	if ((arcn->type == PAX_CHR) || (arcn->type == PAX_BLK))
12028071059Sguenther 		(void)fprintf(fp, "%4lu, %4lu ",
12128071059Sguenther 		    (unsigned long)MAJOR(sbp->st_rdev),
12242cf9836Stholo 		    (unsigned long)MINOR(sbp->st_rdev));
123df930be7Sderaadt 	else {
12428071059Sguenther 		(void)fprintf(fp, "%9llu ", sbp->st_size);
125df930be7Sderaadt 	}
126df930be7Sderaadt 
127df930be7Sderaadt 	/*
128df930be7Sderaadt 	 * print name and link info for hard and soft links
129df930be7Sderaadt 	 */
130c5738c9aSmillert 	(void)fputs(f_date, fp);
131c5738c9aSmillert 	(void)putc(' ', fp);
132c5738c9aSmillert 	safe_print(arcn->name, fp);
1335316f7a4Sguenther 	if (PAX_IS_HARDLINK(arcn->type)) {
134c5738c9aSmillert 		fputs(" == ", fp);
135c5738c9aSmillert 		safe_print(arcn->ln_name, fp);
136c5738c9aSmillert 	} else if (arcn->type == PAX_SLK) {
1379c55a15bSmillert 		fputs(" -> ", fp);
138c5738c9aSmillert 		safe_print(arcn->ln_name, fp);
139c5738c9aSmillert 	}
1409cd57097Smillert 	(void)putc(term, fp);
141f2d26cdcSmillert 	(void)fflush(fp);
142df930be7Sderaadt }
143df930be7Sderaadt 
144df930be7Sderaadt /*
145df930be7Sderaadt  * tty_ls()
146df930be7Sderaadt  *	print a short summary of file to tty.
147df930be7Sderaadt  */
148df930be7Sderaadt 
149df930be7Sderaadt void
ls_tty(ARCHD * arcn)150be87792eSmillert ls_tty(ARCHD *arcn)
151df930be7Sderaadt {
152a782b597Sflorian 	struct tm *tm;
153df930be7Sderaadt 	char f_date[DATELEN];
154df930be7Sderaadt 	char f_mode[MODELEN];
1559c38e9f3Sguenther 	time_t now = time(NULL);
156df930be7Sderaadt 
157df930be7Sderaadt 	/*
158df930be7Sderaadt 	 * convert time to string, and print
159df930be7Sderaadt 	 */
160a782b597Sflorian 	if ((tm = localtime(&(arcn->sb.st_mtime))) == NULL)
161a782b597Sflorian 		f_date[0] = '\0';
162a782b597Sflorian 	else if (strftime(f_date, DATELEN, TIMEFMT(arcn->sb.st_mtime, now),
163a782b597Sflorian 	    tm) == 0)
164df930be7Sderaadt 		f_date[0] = '\0';
165df930be7Sderaadt 	strmode(arcn->sb.st_mode, f_mode);
166df930be7Sderaadt 	tty_prnt("%s%s %s\n", f_mode, f_date, arcn->name);
167df930be7Sderaadt }
168df930be7Sderaadt 
169c5738c9aSmillert void
safe_print(const char * str,FILE * fp)1707097cf92Smillert safe_print(const char *str, FILE *fp)
171c5738c9aSmillert {
172c5738c9aSmillert 	char visbuf[5];
1737097cf92Smillert 	const char *cp;
174c5738c9aSmillert 
175c5738c9aSmillert 	/*
176c5738c9aSmillert 	 * if printing to a tty, use vis(3) to print special characters.
177c5738c9aSmillert 	 */
178c5738c9aSmillert 	if (isatty(fileno(fp))) {
179c5738c9aSmillert 		for (cp = str; *cp; cp++) {
180c5738c9aSmillert 			(void)vis(visbuf, cp[0], VIS_CSTYLE, cp[1]);
181c5738c9aSmillert 			(void)fputs(visbuf, fp);
182c5738c9aSmillert 		}
183c5738c9aSmillert 	} else {
184c5738c9aSmillert 		(void)fputs(str, fp);
185c5738c9aSmillert 	}
186c5738c9aSmillert }
187c5738c9aSmillert 
188df930be7Sderaadt /*
189df930be7Sderaadt  * asc_ul()
190df930be7Sderaadt  *	convert hex/octal character string into a u_long. We do not have to
191df930be7Sderaadt  *	check for overflow! (the headers in all supported formats are not large
192df930be7Sderaadt  *	enough to create an overflow).
193df930be7Sderaadt  *	NOTE: strings passed to us are NOT TERMINATED.
194df930be7Sderaadt  * Return:
195df930be7Sderaadt  *	unsigned long value
196df930be7Sderaadt  */
197df930be7Sderaadt 
198df930be7Sderaadt u_long
asc_ul(char * str,int len,int base)199be87792eSmillert asc_ul(char *str, int len, int base)
200df930be7Sderaadt {
201be87792eSmillert 	char *stop;
202df930be7Sderaadt 	u_long tval = 0;
203df930be7Sderaadt 
204df930be7Sderaadt 	stop = str + len;
205df930be7Sderaadt 
206df930be7Sderaadt 	/*
207df930be7Sderaadt 	 * skip over leading blanks and zeros
208df930be7Sderaadt 	 */
209df930be7Sderaadt 	while ((str < stop) && ((*str == ' ') || (*str == '0')))
210df930be7Sderaadt 		++str;
211df930be7Sderaadt 
212df930be7Sderaadt 	/*
213df930be7Sderaadt 	 * for each valid digit, shift running value (tval) over to next digit
214df930be7Sderaadt 	 * and add next digit
215df930be7Sderaadt 	 */
216df930be7Sderaadt 	if (base == HEX) {
217df930be7Sderaadt 		while (str < stop) {
218df930be7Sderaadt 			if ((*str >= '0') && (*str <= '9'))
219df930be7Sderaadt 				tval = (tval << 4) + (*str++ - '0');
220df930be7Sderaadt 			else if ((*str >= 'A') && (*str <= 'F'))
221df930be7Sderaadt 				tval = (tval << 4) + 10 + (*str++ - 'A');
222df930be7Sderaadt 			else if ((*str >= 'a') && (*str <= 'f'))
223df930be7Sderaadt 				tval = (tval << 4) + 10 + (*str++ - 'a');
224df930be7Sderaadt 			else
225df930be7Sderaadt 				break;
226df930be7Sderaadt 		}
227df930be7Sderaadt 	} else {
228df930be7Sderaadt 		while ((str < stop) && (*str >= '0') && (*str <= '7'))
229df930be7Sderaadt 			tval = (tval << 3) + (*str++ - '0');
230df930be7Sderaadt 	}
231df930be7Sderaadt 	return(tval);
232df930be7Sderaadt }
233df930be7Sderaadt 
234df930be7Sderaadt /*
235df930be7Sderaadt  * ul_asc()
236df930be7Sderaadt  *	convert an unsigned long into an hex/oct ascii string. pads with LEADING
237df930be7Sderaadt  *	ascii 0's to fill string completely
238df930be7Sderaadt  *	NOTE: the string created is NOT TERMINATED.
239df930be7Sderaadt  */
240df930be7Sderaadt 
241df930be7Sderaadt int
ul_asc(u_long val,char * str,int len,int base)242be87792eSmillert ul_asc(u_long val, char *str, int len, int base)
243df930be7Sderaadt {
244be87792eSmillert 	char *pt;
245df930be7Sderaadt 	u_long digit;
246df930be7Sderaadt 
247df930be7Sderaadt 	/*
248df930be7Sderaadt 	 * WARNING str is not '\0' terminated by this routine
249df930be7Sderaadt 	 */
250df930be7Sderaadt 	pt = str + len - 1;
251df930be7Sderaadt 
252df930be7Sderaadt 	/*
253df930be7Sderaadt 	 * do a tailwise conversion (start at right most end of string to place
254df930be7Sderaadt 	 * least significant digit). Keep shifting until conversion value goes
255df930be7Sderaadt 	 * to zero (all digits were converted)
256df930be7Sderaadt 	 */
257df930be7Sderaadt 	if (base == HEX) {
258df930be7Sderaadt 		while (pt >= str) {
259df930be7Sderaadt 			if ((digit = (val & 0xf)) < 10)
260df930be7Sderaadt 				*pt-- = '0' + (char)digit;
261df930be7Sderaadt 			else
262df930be7Sderaadt 				*pt-- = 'a' + (char)(digit - 10);
263f37d86feSguenther 			val >>= 4;
264f37d86feSguenther 			if (val == 0)
265df930be7Sderaadt 				break;
266df930be7Sderaadt 		}
267df930be7Sderaadt 	} else {
268df930be7Sderaadt 		while (pt >= str) {
269df930be7Sderaadt 			*pt-- = '0' + (char)(val & 0x7);
270f37d86feSguenther 			val >>= 3;
271f37d86feSguenther 			if (val == 0)
272df930be7Sderaadt 				break;
273df930be7Sderaadt 		}
274df930be7Sderaadt 	}
275df930be7Sderaadt 
276df930be7Sderaadt 	/*
277df930be7Sderaadt 	 * pad with leading ascii ZEROS. We return -1 if we ran out of space.
278df930be7Sderaadt 	 */
279df930be7Sderaadt 	while (pt >= str)
280df930be7Sderaadt 		*pt-- = '0';
281f37d86feSguenther 	if (val != 0)
282df930be7Sderaadt 		return(-1);
283df930be7Sderaadt 	return(0);
284df930be7Sderaadt }
285df930be7Sderaadt 
286df930be7Sderaadt /*
287f37d86feSguenther  * asc_ull()
288f37d86feSguenther  *	Convert hex/octal character string into a unsigned long long.
289f37d86feSguenther  *	We do not have to check for overflow!  (The headers in all
290f37d86feSguenther  *	supported formats are not large enough to create an overflow).
291df930be7Sderaadt  *	NOTE: strings passed to us are NOT TERMINATED.
292df930be7Sderaadt  * Return:
293f37d86feSguenther  *	unsigned long long value
294df930be7Sderaadt  */
295df930be7Sderaadt 
296f37d86feSguenther unsigned long long
asc_ull(char * str,int len,int base)297f37d86feSguenther asc_ull(char *str, int len, int base)
298df930be7Sderaadt {
299be87792eSmillert 	char *stop;
300f37d86feSguenther 	unsigned long long tval = 0;
301df930be7Sderaadt 
302df930be7Sderaadt 	stop = str + len;
303df930be7Sderaadt 
304df930be7Sderaadt 	/*
305df930be7Sderaadt 	 * skip over leading blanks and zeros
306df930be7Sderaadt 	 */
307df930be7Sderaadt 	while ((str < stop) && ((*str == ' ') || (*str == '0')))
308df930be7Sderaadt 		++str;
309df930be7Sderaadt 
310df930be7Sderaadt 	/*
311df930be7Sderaadt 	 * for each valid digit, shift running value (tval) over to next digit
312df930be7Sderaadt 	 * and add next digit
313df930be7Sderaadt 	 */
314df930be7Sderaadt 	if (base == HEX) {
315df930be7Sderaadt 		while (str < stop) {
316df930be7Sderaadt 			if ((*str >= '0') && (*str <= '9'))
317df930be7Sderaadt 				tval = (tval << 4) + (*str++ - '0');
318df930be7Sderaadt 			else if ((*str >= 'A') && (*str <= 'F'))
319df930be7Sderaadt 				tval = (tval << 4) + 10 + (*str++ - 'A');
320df930be7Sderaadt 			else if ((*str >= 'a') && (*str <= 'f'))
321df930be7Sderaadt 				tval = (tval << 4) + 10 + (*str++ - 'a');
322df930be7Sderaadt 			else
323df930be7Sderaadt 				break;
324df930be7Sderaadt 		}
325df930be7Sderaadt 	} else {
326df930be7Sderaadt 		while ((str < stop) && (*str >= '0') && (*str <= '7'))
327df930be7Sderaadt 			tval = (tval << 3) + (*str++ - '0');
328df930be7Sderaadt 	}
329df930be7Sderaadt 	return(tval);
330df930be7Sderaadt }
331df930be7Sderaadt 
332df930be7Sderaadt /*
333f37d86feSguenther  * ull_asc()
334f37d86feSguenther  *	Convert an unsigned long long into a hex/oct ascii string.
335f37d86feSguenther  *	Pads with LEADING ascii 0's to fill string completely
336df930be7Sderaadt  *	NOTE: the string created is NOT TERMINATED.
337df930be7Sderaadt  */
338df930be7Sderaadt 
339df930be7Sderaadt int
ull_asc(unsigned long long val,char * str,int len,int base)340f37d86feSguenther ull_asc(unsigned long long val, char *str, int len, int base)
341df930be7Sderaadt {
342be87792eSmillert 	char *pt;
343f37d86feSguenther 	unsigned long long digit;
344df930be7Sderaadt 
345df930be7Sderaadt 	/*
346df930be7Sderaadt 	 * WARNING str is not '\0' terminated by this routine
347df930be7Sderaadt 	 */
348df930be7Sderaadt 	pt = str + len - 1;
349df930be7Sderaadt 
350df930be7Sderaadt 	/*
351df930be7Sderaadt 	 * do a tailwise conversion (start at right most end of string to place
352df930be7Sderaadt 	 * least significant digit). Keep shifting until conversion value goes
353df930be7Sderaadt 	 * to zero (all digits were converted)
354df930be7Sderaadt 	 */
355df930be7Sderaadt 	if (base == HEX) {
356df930be7Sderaadt 		while (pt >= str) {
357df930be7Sderaadt 			if ((digit = (val & 0xf)) < 10)
358df930be7Sderaadt 				*pt-- = '0' + (char)digit;
359df930be7Sderaadt 			else
360df930be7Sderaadt 				*pt-- = 'a' + (char)(digit - 10);
361f37d86feSguenther 			val >>= 4;
362f37d86feSguenther 			if (val == 0)
363df930be7Sderaadt 				break;
364df930be7Sderaadt 		}
365df930be7Sderaadt 	} else {
366df930be7Sderaadt 		while (pt >= str) {
367df930be7Sderaadt 			*pt-- = '0' + (char)(val & 0x7);
368f37d86feSguenther 			val >>= 3;
369f37d86feSguenther 			if (val == 0)
370df930be7Sderaadt 				break;
371df930be7Sderaadt 		}
372df930be7Sderaadt 	}
373df930be7Sderaadt 
374df930be7Sderaadt 	/*
375df930be7Sderaadt 	 * pad with leading ascii ZEROS. We return -1 if we ran out of space.
376df930be7Sderaadt 	 */
377df930be7Sderaadt 	while (pt >= str)
378df930be7Sderaadt 		*pt-- = '0';
379f37d86feSguenther 	if (val != 0)
380df930be7Sderaadt 		return(-1);
381df930be7Sderaadt 	return(0);
382df930be7Sderaadt }
38364e70991Sotto 
38464e70991Sotto /*
38564e70991Sotto  * Copy at max min(bufz, fieldsz) chars from field to buf, stopping
38664e70991Sotto  * at the first NUL char. NUL terminate buf if there is room left.
38764e70991Sotto  */
38864e70991Sotto size_t
fieldcpy(char * buf,size_t bufsz,const char * field,size_t fieldsz)38964e70991Sotto fieldcpy(char *buf, size_t bufsz, const char *field, size_t fieldsz)
39064e70991Sotto {
39164e70991Sotto 	char *p = buf;
39264e70991Sotto 	const char *q = field;
39364e70991Sotto 	size_t i = 0;
39464e70991Sotto 
39564e70991Sotto 	if (fieldsz > bufsz)
39664e70991Sotto 		fieldsz = bufsz;
39764e70991Sotto 	while (i < fieldsz && *q != '\0') {
39864e70991Sotto 		*p++ = *q++;
39964e70991Sotto 		i++;
40064e70991Sotto 	}
40164e70991Sotto 	if (i < bufsz)
40264e70991Sotto 		*p = '\0';
40364e70991Sotto 	return(i);
40464e70991Sotto }
405