xref: /freebsd/lib/libc/gen/strtofflags.c (revision 7a7741af18d6c8a804cc643cb7ecda9d730c6aa6)
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 #include <sys/types.h>
33 #include <sys/stat.h>
34 
35 #include <stddef.h>
36 #include <stdlib.h>
37 #include <string.h>
38 #include <unistd.h>
39 
40 #define longestflaglen	12
41 static struct {
42 	char name[longestflaglen + 1];
43 	char invert;
44 	u_long flag;
45 } const mapping[] = {
46 	/* shorter names per flag first, all prefixed by "no" */
47 	{ "nosappnd",		0, SF_APPEND	},
48 	{ "nosappend",		0, SF_APPEND	},
49 	{ "noarch",		0, SF_ARCHIVED	},
50 	{ "noarchived",		0, SF_ARCHIVED	},
51 	{ "noschg",		0, SF_IMMUTABLE	},
52 	{ "noschange",		0, SF_IMMUTABLE	},
53 	{ "nosimmutable",	0, SF_IMMUTABLE	},
54 	{ "nosunlnk",		0, SF_NOUNLINK	},
55 	{ "nosunlink",		0, SF_NOUNLINK	},
56 #ifdef SF_SNAPSHOT
57 	{ "nosnapshot",		0, SF_SNAPSHOT	},
58 #endif
59 	{ "nouappnd",		0, UF_APPEND	},
60 	{ "nouappend",		0, UF_APPEND	},
61 	{ "nouarch", 		0, UF_ARCHIVE	},
62 	{ "nouarchive",		0, UF_ARCHIVE	},
63 	{ "nohidden",		0, UF_HIDDEN	},
64 	{ "nouhidden",		0, UF_HIDDEN	},
65 	{ "nouchg",		0, UF_IMMUTABLE	},
66 	{ "nouchange",		0, UF_IMMUTABLE	},
67 	{ "nouimmutable",	0, UF_IMMUTABLE	},
68 	{ "nodump",		1, UF_NODUMP	},
69 	{ "nouunlnk",		0, UF_NOUNLINK	},
70 	{ "nouunlink",		0, UF_NOUNLINK	},
71 	{ "nooffline",		0, UF_OFFLINE	},
72 	{ "nouoffline",		0, UF_OFFLINE	},
73 	{ "noopaque",		0, UF_OPAQUE	},
74 	{ "nordonly",		0, UF_READONLY	},
75 	{ "nourdonly",		0, UF_READONLY	},
76 	{ "noreadonly",		0, UF_READONLY	},
77 	{ "noureadonly",	0, UF_READONLY	},
78 	{ "noreparse",		0, UF_REPARSE	},
79 	{ "noureparse",		0, UF_REPARSE	},
80 	{ "nosparse",		0, UF_SPARSE	},
81 	{ "nousparse",		0, UF_SPARSE	},
82 	{ "nosystem",		0, UF_SYSTEM	},
83 	{ "nousystem",		0, UF_SYSTEM	}
84 };
85 #define nmappings	(sizeof(mapping) / sizeof(mapping[0]))
86 
87 /*
88  * fflagstostr --
89  *	Convert file flags to a comma-separated string.  If no flags
90  *	are set, return the empty string.
91  */
92 char *
93 fflagstostr(u_long flags)
94 {
95 	char *string;
96 	const char *sp;
97 	char *dp;
98 	u_long setflags;
99 	u_int i;
100 
101 	if ((string = (char *)malloc(nmappings * (longestflaglen + 1))) == NULL)
102 		return (NULL);
103 
104 	setflags = flags;
105 	dp = string;
106 	for (i = 0; i < nmappings; i++) {
107 		if (setflags & mapping[i].flag) {
108 			if (dp > string)
109 				*dp++ = ',';
110 			for (sp = mapping[i].invert ? mapping[i].name :
111 			    mapping[i].name + 2; *sp; *dp++ = *sp++) ;
112 			setflags &= ~mapping[i].flag;
113 		}
114 	}
115 	*dp = '\0';
116 	return (string);
117 }
118 
119 /*
120  * strtofflags --
121  *	Take string of arguments and return file flags.  Return 0 on
122  *	success, 1 on failure.  On failure, stringp is set to point
123  *	to the offending token.
124  */
125 int
126 strtofflags(char **stringp, u_long *setp, u_long *clrp)
127 {
128 	char *string, *p;
129 	int i;
130 
131 	if (setp)
132 		*setp = 0;
133 	if (clrp)
134 		*clrp = 0;
135 	string = *stringp;
136 	while ((p = strsep(&string, "\t ,")) != NULL) {
137 		*stringp = p;
138 		if (*p == '\0')
139 			continue;
140 		for (i = 0; i < nmappings; i++) {
141 			if (strcmp(p, mapping[i].name + 2) == 0) {
142 				if (mapping[i].invert) {
143 					if (clrp)
144 						*clrp |= mapping[i].flag;
145 				} else {
146 					if (setp)
147 						*setp |= mapping[i].flag;
148 				}
149 				break;
150 			} else if (strcmp(p, mapping[i].name) == 0) {
151 				if (mapping[i].invert) {
152 					if (setp)
153 						*setp |= mapping[i].flag;
154 				} else {
155 					if (clrp)
156 						*clrp |= mapping[i].flag;
157 				}
158 				break;
159 			}
160 		}
161 		if (i == nmappings)
162 			return 1;
163 	}
164 	return 0;
165 }
166