2 * Copyright (c) 2003-2007 Tim Kientzle
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer
10 * in this position and unchanged.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #include "cpio_platform.h"
29 __FBSDID("$FreeBSD$");
52 * Short options for cpio. Please keep this sorted.
54 static const char *short_options = "0AaBC:cdE:F:f:H:hI:iJjLlmnO:opR:rtuvW:yZz";
57 * Long options for cpio. Please keep this sorted.
59 static const struct option {
61 int required; /* 1 if this option requires an argument */
62 int equivalent; /* Equivalent short option. */
65 { "extract", 0, 'i' },
69 { "insecure", 0, OPTION_INSECURE },
72 { "lzma", 0, OPTION_LZMA },
73 { "make-directories", 0, 'd' },
74 { "no-preserve-owner", 0, OPTION_NO_PRESERVE_OWNER },
76 { "numeric-uid-gid", 0, 'n' },
78 { "pass-through", 0, 'p' },
79 { "preserve-modification-time", 0, 'm' },
80 { "preserve-owner", 0, OPTION_PRESERVE_OWNER },
81 { "quiet", 0, OPTION_QUIET },
82 { "unconditional", 0, 'u' },
83 { "verbose", 0, 'v' },
84 { "version", 0, OPTION_VERSION },
90 * I used to try to select platform-provided getopt() or
91 * getopt_long(), but that caused a lot of headaches. In particular,
92 * I couldn't consistently use long options in the test harness
93 * because not all platforms have getopt_long(). That in turn led to
94 * overuse of the -W hack in the test harness, which made it rough to
95 * run the test harness against GNU cpio. (I periodically run the
96 * test harness here against GNU cpio as a sanity-check. Yes,
97 * I've found a couple of bugs in GNU cpio that way.)
100 cpio_getopt(struct cpio *cpio)
102 enum { state_start = 0, state_next_word, state_short, state_long };
103 static int state = state_start;
104 static char *opt_word;
106 const struct option *popt, *match = NULL, *match2 = NULL;
107 const char *p, *long_prefix = "--";
114 /* First time through, initialize everything. */
115 if (state == state_start) {
116 /* Skip program name. */
119 state = state_next_word;
123 * We're ready to look at the next word in argv.
125 if (state == state_next_word) {
126 /* No more arguments, so no more options. */
127 if (cpio->argv[0] == NULL)
129 /* Doesn't start with '-', so no more options. */
130 if (cpio->argv[0][0] != '-')
132 /* "--" marks end of options; consume it and return. */
133 if (strcmp(cpio->argv[0], "--") == 0) {
138 /* Get next word for parsing. */
139 opt_word = *cpio->argv++;
141 if (opt_word[1] == '-') {
142 /* Set up long option parser. */
144 opt_word += 2; /* Skip leading '--' */
146 /* Set up short option parser. */
148 ++opt_word; /* Skip leading '-' */
153 * We're parsing a group of POSIX-style single-character options.
155 if (state == state_short) {
156 /* Peel next option off of a group of short options. */
159 /* End of this group; recurse to get next option. */
160 state = state_next_word;
161 return cpio_getopt(cpio);
164 /* Does this option take an argument? */
165 p = strchr(short_options, opt);
171 /* If it takes an argument, parse that. */
173 /* If arg is run-in, opt_word already points to it. */
174 if (opt_word[0] == '\0') {
175 /* Otherwise, pick up the next word. */
176 opt_word = *cpio->argv;
177 if (opt_word == NULL) {
179 "Option -%c requires an argument",
188 long_prefix = "-W "; /* For clearer errors. */
190 state = state_next_word;
191 cpio->optarg = opt_word;
196 /* We're reading a long option, including -W long=arg convention. */
197 if (state == state_long) {
198 /* After this long option, we'll be starting a new word. */
199 state = state_next_word;
201 /* Option name ends at '=' if there is one. */
202 p = strchr(opt_word, '=');
204 optlength = (size_t)(p - opt_word);
205 cpio->optarg = (char *)(uintptr_t)(p + 1);
207 optlength = strlen(opt_word);
210 /* Search the table for an unambiguous match. */
211 for (popt = cpio_longopts; popt->name != NULL; popt++) {
212 /* Short-circuit if first chars don't match. */
213 if (popt->name[0] != opt_word[0])
215 /* If option is a prefix of name in table, record it.*/
216 if (strncmp(opt_word, popt->name, optlength) == 0) {
217 match2 = match; /* Record up to two matches. */
219 /* If it's an exact match, we're done. */
220 if (strlen(popt->name) == optlength) {
221 match2 = NULL; /* Forget the others. */
227 /* Fail if there wasn't a unique match. */
230 "Option %s%s is not supported",
231 long_prefix, opt_word);
234 if (match2 != NULL) {
236 "Ambiguous option %s%s (matches --%s and --%s)",
237 long_prefix, opt_word, match->name, match2->name);
241 /* We've found a unique match; does it need an argument? */
242 if (match->required) {
243 /* Argument required: get next word if necessary. */
244 if (cpio->optarg == NULL) {
245 cpio->optarg = *cpio->argv;
246 if (cpio->optarg == NULL) {
248 "Option %s%s requires an argument",
249 long_prefix, match->name);
256 /* Argument forbidden: fail if there is one. */
257 if (cpio->optarg != NULL) {
259 "Option %s%s does not allow an argument",
260 long_prefix, match->name);
264 return (match->equivalent);
272 * Parse the argument to the -R or --owner flag.
274 * The format is one of the following:
275 * <username|uid> - Override user but not group
276 * <username>: - Override both, group is user's default group
277 * <uid>: - Override user but not group
278 * <username|uid>:<groupname|gid> - Override both
279 * :<groupname|gid> - Override group but not user
281 * Where uid/gid are decimal representations and groupname/username
282 * are names to be looked up in system database. Note that we try
283 * to look up an argument as a name first, then try numeric parsing.
285 * A period can be used instead of the colon.
287 * Sets uid/gid return as appropriate, -1 indicates uid/gid not specified.
288 * TODO: If the spec uses uname/gname, then return those to the caller
289 * as well. If the spec provides uid/gid, just return names as NULL.
291 * Returns NULL if no error, otherwise returns error string for display.
295 owner_parse(const char *spec, int *uid, int *gid)
297 static char errbuff[128];
298 const char *u, *ue, *g;
304 return ("Invalid empty user/group spec");
307 * Split spec into [user][:.][group]
308 * u -> first char of username, NULL if no username
309 * ue -> first char after username (colon, period, or \0)
310 * g -> first char of group name
312 if (*spec == ':' || *spec == '.') {
313 /* If spec starts with ':' or '.', then just group. */
317 /* Otherwise, [user] or [user][:] or [user][:][group] */
319 while (*ue != ':' && *ue != '.' && *ue != '\0')
322 if (*g != '\0') /* Skip : or . to find first char of group. */
327 /* Look up user: ue is first char after end of user. */
329 struct passwd *pwent;
331 user = (char *)malloc(ue - u + 1);
333 return ("Couldn't allocate memory");
334 memcpy(user, u, ue - u);
336 if ((pwent = getpwnam(user)) != NULL) {
337 *uid = pwent->pw_uid;
339 *gid = pwent->pw_gid;
343 *uid = strtoul(user, &end, 10);
344 if (errno || *end != '\0') {
345 snprintf(errbuff, sizeof(errbuff),
346 "Couldn't lookup user ``%s''", user);
347 errbuff[sizeof(errbuff) - 1] = '\0';
356 if ((grp = getgrnam(g)) != NULL) {
361 *gid = strtoul(g, &end, 10);
362 if (errno || *end != '\0') {
363 snprintf(errbuff, sizeof(errbuff),
364 "Couldn't lookup group ``%s''", g);
365 errbuff[sizeof(errbuff) - 1] = '\0';