xref: /freebsd/lib/libc/gen/strtofflags.c (revision 58a0f0d00c0cc4a90ce584a61470290751bfcac7)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #if defined(LIBC_SCCS) && !defined(lint)
33 static char sccsid[] = "@(#)stat_flags.c	8.1 (Berkeley) 5/31/93";
34 #endif /* LIBC_SCCS and not lint */
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
37 
38 #include <sys/types.h>
39 #include <sys/stat.h>
40 
41 #include <stddef.h>
42 #include <stdlib.h>
43 #include <string.h>
44 #include <unistd.h>
45 
46 #define longestflaglen	12
47 static struct {
48 	char name[longestflaglen + 1];
49 	char invert;
50 	u_long flag;
51 } const mapping[] = {
52 	/* shorter names per flag first, all prefixed by "no" */
53 	{ "nosappnd",		0, SF_APPEND	},
54 	{ "nosappend",		0, SF_APPEND	},
55 	{ "noarch",		0, SF_ARCHIVED	},
56 	{ "noarchived",		0, SF_ARCHIVED	},
57 	{ "noschg",		0, SF_IMMUTABLE	},
58 	{ "noschange",		0, SF_IMMUTABLE	},
59 	{ "nosimmutable",	0, SF_IMMUTABLE	},
60 	{ "nosunlnk",		0, SF_NOUNLINK	},
61 	{ "nosunlink",		0, SF_NOUNLINK	},
62 #ifdef SF_SNAPSHOT
63 	{ "nosnapshot",		0, SF_SNAPSHOT	},
64 #endif
65 	{ "nouappnd",		0, UF_APPEND	},
66 	{ "nouappend",		0, UF_APPEND	},
67 	{ "nouarch", 		0, UF_ARCHIVE	},
68 	{ "nouarchive",		0, UF_ARCHIVE	},
69 	{ "nohidden",		0, UF_HIDDEN	},
70 	{ "nouhidden",		0, UF_HIDDEN	},
71 	{ "nouchg",		0, UF_IMMUTABLE	},
72 	{ "nouchange",		0, UF_IMMUTABLE	},
73 	{ "nouimmutable",	0, UF_IMMUTABLE	},
74 	{ "nodump",		1, UF_NODUMP	},
75 	{ "nouunlnk",		0, UF_NOUNLINK	},
76 	{ "nouunlink",		0, UF_NOUNLINK	},
77 	{ "nooffline",		0, UF_OFFLINE	},
78 	{ "nouoffline",		0, UF_OFFLINE	},
79 	{ "noopaque",		0, UF_OPAQUE	},
80 	{ "nordonly",		0, UF_READONLY	},
81 	{ "nourdonly",		0, UF_READONLY	},
82 	{ "noreadonly",		0, UF_READONLY	},
83 	{ "noureadonly",	0, UF_READONLY	},
84 	{ "noreparse",		0, UF_REPARSE	},
85 	{ "noureparse",		0, UF_REPARSE	},
86 	{ "nosparse",		0, UF_SPARSE	},
87 	{ "nousparse",		0, UF_SPARSE	},
88 	{ "nosystem",		0, UF_SYSTEM	},
89 	{ "nousystem",		0, UF_SYSTEM	}
90 };
91 #define nmappings	(sizeof(mapping) / sizeof(mapping[0]))
92 
93 /*
94  * fflagstostr --
95  *	Convert file flags to a comma-separated string.  If no flags
96  *	are set, return the empty string.
97  */
98 char *
99 fflagstostr(u_long flags)
100 {
101 	char *string;
102 	const char *sp;
103 	char *dp;
104 	u_long setflags;
105 	u_int i;
106 
107 	if ((string = (char *)malloc(nmappings * (longestflaglen + 1))) == NULL)
108 		return (NULL);
109 
110 	setflags = flags;
111 	dp = string;
112 	for (i = 0; i < nmappings; i++) {
113 		if (setflags & mapping[i].flag) {
114 			if (dp > string)
115 				*dp++ = ',';
116 			for (sp = mapping[i].invert ? mapping[i].name :
117 			    mapping[i].name + 2; *sp; *dp++ = *sp++) ;
118 			setflags &= ~mapping[i].flag;
119 		}
120 	}
121 	*dp = '\0';
122 	return (string);
123 }
124 
125 /*
126  * strtofflags --
127  *	Take string of arguments and return file flags.  Return 0 on
128  *	success, 1 on failure.  On failure, stringp is set to point
129  *	to the offending token.
130  */
131 int
132 strtofflags(char **stringp, u_long *setp, u_long *clrp)
133 {
134 	char *string, *p;
135 	int i;
136 
137 	if (setp)
138 		*setp = 0;
139 	if (clrp)
140 		*clrp = 0;
141 	string = *stringp;
142 	while ((p = strsep(&string, "\t ,")) != NULL) {
143 		*stringp = p;
144 		if (*p == '\0')
145 			continue;
146 		for (i = 0; i < nmappings; i++) {
147 			if (strcmp(p, mapping[i].name + 2) == 0) {
148 				if (mapping[i].invert) {
149 					if (clrp)
150 						*clrp |= mapping[i].flag;
151 				} else {
152 					if (setp)
153 						*setp |= mapping[i].flag;
154 				}
155 				break;
156 			} else if (strcmp(p, mapping[i].name) == 0) {
157 				if (mapping[i].invert) {
158 					if (setp)
159 						*setp |= mapping[i].flag;
160 				} else {
161 					if (clrp)
162 						*clrp |= mapping[i].flag;
163 				}
164 				break;
165 			}
166 		}
167 		if (i == nmappings)
168 			return 1;
169 	}
170 	return 0;
171 }
172