xref: /freebsd/lib/libc/gen/strtofflags.c (revision dece5b05f577fc4c6b89af7ad48dfbdf7cc4945c)
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 	/* Needed for some Linux cross-build that uses a stale stat.h. */
84 	{ "nousystem",		0, UF_SYSTEM	},
85 #ifdef UF_NOCACHE
86 	{ "nocache",		1, UF_NOCACHE	},
87 	{ "noucache",		1, UF_NOCACHE	}
88 #endif
89 };
90 #define nmappings	(sizeof(mapping) / sizeof(mapping[0]))
91 
92 /*
93  * fflagstostr --
94  *	Convert file flags to a comma-separated string.  If no flags
95  *	are set, return the empty string.
96  */
97 char *
98 fflagstostr(u_long flags)
99 {
100 	char *string;
101 	const char *sp;
102 	char *dp;
103 	u_long setflags;
104 	u_int i;
105 
106 	if ((string = (char *)malloc(nmappings * (longestflaglen + 1))) == NULL)
107 		return (NULL);
108 
109 	setflags = flags;
110 	dp = string;
111 	for (i = 0; i < nmappings; i++) {
112 		if (setflags & mapping[i].flag) {
113 			if (dp > string)
114 				*dp++ = ',';
115 			for (sp = mapping[i].invert ? mapping[i].name :
116 			    mapping[i].name + 2; *sp; *dp++ = *sp++) ;
117 			setflags &= ~mapping[i].flag;
118 		}
119 	}
120 	*dp = '\0';
121 	return (string);
122 }
123 
124 /*
125  * strtofflags --
126  *	Take string of arguments and return file flags.  Return 0 on
127  *	success, 1 on failure.  On failure, stringp is set to point
128  *	to the offending token.
129  */
130 int
131 strtofflags(char **stringp, u_long *setp, u_long *clrp)
132 {
133 	char *string, *p;
134 	int i;
135 
136 	if (setp)
137 		*setp = 0;
138 	if (clrp)
139 		*clrp = 0;
140 	string = *stringp;
141 	while ((p = strsep(&string, "\t ,")) != NULL) {
142 		*stringp = p;
143 		if (*p == '\0')
144 			continue;
145 		for (i = 0; i < nmappings; i++) {
146 			if (strcmp(p, mapping[i].name + 2) == 0) {
147 				if (mapping[i].invert) {
148 					if (clrp)
149 						*clrp |= mapping[i].flag;
150 				} else {
151 					if (setp)
152 						*setp |= mapping[i].flag;
153 				}
154 				break;
155 			} else if (strcmp(p, mapping[i].name) == 0) {
156 				if (mapping[i].invert) {
157 					if (setp)
158 						*setp |= mapping[i].flag;
159 				} else {
160 					if (clrp)
161 						*clrp |= mapping[i].flag;
162 				}
163 				break;
164 			}
165 		}
166 		if (i == nmappings)
167 			return 1;
168 	}
169 	return 0;
170 }
171