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