1 /* install - copy files and set attributes
2 Copyright (C) 89, 90, 91, 1995-2005 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2, or (at your option)
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software Foundation,
16 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
18 /* Written by David MacKenzie <djm@gnu.ai.mit.edu> */
23 #include <sys/types.h>
29 #include "backupfile.h"
34 #include "filenamecat.h"
36 #include "modechange.h"
38 #include "stat-time.h"
42 /* The official name of this program (e.g., no `g' prefix). */
43 #define PROGRAM_NAME "install"
45 #define AUTHORS "David MacKenzie"
48 # include <sys/wait.h>
52 # define endgrent() ((void) 0)
56 # define endpwent() ((void) 0)
59 /* Initial number of entries in each hash table entry's table of inodes. */
60 #define INITIAL_HASH_MODULE 100
62 /* Initial number of entries in the inode hash table. */
63 #define INITIAL_ENTRY_TAB_SIZE 70
65 /* Number of bytes of a file to copy at a time. */
66 #define READ_SIZE (32 * 1024)
68 static bool change_timestamps (const char *from, const char *to);
69 static bool change_attributes (char const *name);
70 static bool copy_file (const char *from, const char *to,
71 const struct cp_options *x);
72 static bool install_file_in_file_parents (char const *from, char const *to,
73 struct cp_options const *x);
74 static bool install_file_in_dir (const char *from, const char *to_dir,
75 const struct cp_options *x);
76 static bool install_file_in_file (const char *from, const char *to,
77 const struct cp_options *x);
78 static void get_ids (void);
79 static void strip (char const *name);
80 void usage (int status);
82 /* The name this program was run with, for error messages. */
85 /* The user name that will own the files, or NULL to make the owner
86 the current user ID. */
87 static char *owner_name;
89 /* The user ID corresponding to `owner_name'. */
90 static uid_t owner_id;
92 /* The group name that will own the files, or NULL to make the group
93 the current group ID. */
94 static char *group_name;
96 /* The group ID corresponding to `group_name'. */
97 static gid_t group_id;
99 /* The permissions to which the files will be set. The umask has
101 static mode_t mode = S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH;
103 /* If true, strip executable files after copying them. */
104 static bool strip_files;
106 /* If true, install a directory instead of a regular file. */
109 static struct option const long_options[] =
111 {"backup", optional_argument, NULL, 'b'},
112 {"directory", no_argument, NULL, 'd'},
113 {"group", required_argument, NULL, 'g'},
114 {"mode", required_argument, NULL, 'm'},
115 {"no-target-directory", no_argument, NULL, 'T'},
116 {"owner", required_argument, NULL, 'o'},
117 {"preserve-timestamps", no_argument, NULL, 'p'},
118 {"strip", no_argument, NULL, 's'},
119 {"suffix", required_argument, NULL, 'S'},
120 {"target-directory", required_argument, NULL, 't'},
121 {"verbose", no_argument, NULL, 'v'},
122 {GETOPT_HELP_OPTION_DECL},
123 {GETOPT_VERSION_OPTION_DECL},
128 cp_option_init (struct cp_options *x)
130 x->copy_as_regular = true;
131 x->dereference = DEREF_ALWAYS;
132 x->unlink_dest_before_opening = true;
133 x->unlink_dest_after_failed_open = false;
134 x->hard_link = false;
135 x->interactive = I_UNSPECIFIED;
136 x->move_mode = false;
137 x->chown_privileges = chown_privileges ();
138 x->one_file_system = false;
139 x->preserve_ownership = false;
140 x->preserve_links = false;
141 x->preserve_mode = false;
142 x->preserve_timestamps = false;
143 x->require_preserve = false;
144 x->recursive = false;
145 x->sparse_mode = SPARSE_AUTO;
146 x->symbolic_link = false;
147 x->backup_type = no_backups;
149 /* Create destination files initially writable so we can run strip on them.
150 Although GNU strip works fine on read-only files, some others
153 x->mode = S_IRUSR | S_IWUSR;
154 x->stdin_tty = false;
163 /* FILE is the last operand of this command. Return true if FILE is a
164 directory. But report an error there is a problem accessing FILE,
165 or if FILE does not exist but would have to refer to an existing
166 directory if it referred to anything at all. */
169 target_directory_operand (char const *file)
171 char const *b = base_name (file);
172 size_t blen = strlen (b);
173 bool looks_like_a_dir = (blen == 0 || ISSLASH (b[blen - 1]));
175 int err = (stat (file, &st) == 0 ? 0 : errno);
176 bool is_a_dir = !err && S_ISDIR (st.st_mode);
177 if (err && err != ENOENT)
178 error (EXIT_FAILURE, err, _("accessing %s"), quote (file));
179 if (is_a_dir < looks_like_a_dir)
180 error (EXIT_FAILURE, err, _("target %s is not a directory"), quote (file));
185 main (int argc, char **argv)
189 const char *specified_mode = NULL;
190 bool make_backups = false;
191 char *backup_suffix_string;
192 char *version_control_string = NULL;
193 bool mkdir_and_install = false;
195 char const *target_directory = NULL;
196 bool no_target_directory = false;
200 initialize_main (&argc, &argv);
201 program_name = argv[0];
202 setlocale (LC_ALL, "");
203 bindtextdomain (PACKAGE, LOCALEDIR);
204 textdomain (PACKAGE);
206 atexit (close_stdout);
216 /* FIXME: consider not calling getenv for SIMPLE_BACKUP_SUFFIX unless
217 we'll actually use backup_suffix_string. */
218 backup_suffix_string = getenv ("SIMPLE_BACKUP_SUFFIX");
220 while ((optc = getopt_long (argc, argv, "bcsDdg:m:o:pt:TvS:", long_options,
228 version_control_string = optarg;
235 /* System V fork+wait does not work if SIGCHLD is ignored. */
236 signal (SIGCHLD, SIG_DFL);
243 mkdir_and_install = true;
252 specified_mode = optarg;
258 x.preserve_timestamps = true;
262 backup_suffix_string = optarg;
265 if (target_directory)
266 error (EXIT_FAILURE, 0,
267 _("multiple target directories specified"));
271 if (stat (optarg, &st) != 0)
272 error (EXIT_FAILURE, errno, _("accessing %s"), quote (optarg));
273 if (! S_ISDIR (st.st_mode))
274 error (EXIT_FAILURE, 0, _("target %s is not a directory"),
277 target_directory = optarg;
280 no_target_directory = true;
282 case_GETOPT_HELP_CHAR;
283 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
285 usage (EXIT_FAILURE);
289 /* Check for invalid combinations of arguments. */
290 if (dir_arg & strip_files)
291 error (EXIT_FAILURE, 0,
292 _("the strip option may not be used when installing a directory"));
293 if (dir_arg && target_directory)
294 error (EXIT_FAILURE, 0,
295 _("target directory not allowed when installing a directory"));
297 if (backup_suffix_string)
298 simple_backup_suffix = xstrdup (backup_suffix_string);
300 x.backup_type = (make_backups
301 ? xget_version (_("backup type"),
302 version_control_string)
305 n_files = argc - optind;
306 file = argv + optind;
308 if (n_files <= ! (dir_arg || target_directory))
311 error (0, 0, _("missing file operand"));
313 error (0, 0, _("missing destination file operand after %s"),
315 usage (EXIT_FAILURE);
318 if (no_target_directory)
320 if (target_directory)
321 error (EXIT_FAILURE, 0,
322 _("Cannot combine --target-directory (-t) "
323 "and --no-target-directory (-T)"));
326 error (0, 0, _("extra operand %s"), quote (file[2]));
327 usage (EXIT_FAILURE);
330 else if (! (dir_arg || target_directory))
332 if (2 <= n_files && target_directory_operand (file[n_files - 1]))
333 target_directory = file[--n_files];
334 else if (2 < n_files)
335 error (EXIT_FAILURE, 0, _("target %s is not a directory"),
336 quote (file[n_files - 1]));
341 struct mode_change *change = mode_compile (specified_mode);
343 error (EXIT_FAILURE, 0, _("invalid mode %s"), quote (specified_mode));
344 mode = mode_adjust (0, change, 0);
354 for (i = 0; i < n_files; i++)
356 if (cwd_errno != 0 && IS_RELATIVE_FILE_NAME (file[i]))
358 error (0, cwd_errno, _("cannot return to working directory"));
363 make_dir_parents (file[i], mode, mode, owner_id, group_id, false,
364 (x.verbose ? _("creating directory %s") : NULL),
370 /* FIXME: it's a little gross that this initialization is
371 required by copy.c::copy. */
374 if (!target_directory)
376 if (mkdir_and_install)
377 ok = install_file_in_file_parents (file[0], file[1], &x);
379 ok = install_file_in_file (file[0], file[1], &x);
385 for (i = 0; i < n_files; i++)
387 ok &= install_file_in_dir (file[i], target_directory, &x);
392 exit (ok ? EXIT_SUCCESS : EXIT_FAILURE);
395 /* Copy file FROM onto file TO, creating any missing parent directories of TO.
396 Return true if successful. */
399 install_file_in_file_parents (char const *from, char const *to,
400 struct cp_options const *x)
402 char *dest_dir = dir_name (to);
405 /* Make sure that the parent of the destination is a directory. */
406 if (! STREQ (dest_dir, "."))
408 /* Someone will probably ask for a new option or three to specify
409 owner, group, and permissions for parent directories. Remember
410 that this option is intended mainly to help installers when the
411 distribution doesn't provide proper install rules. */
412 mode_t dir_mode = S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH;
414 ok = make_dir_parents (dest_dir, dir_mode, dir_mode,
415 owner_id, group_id, true,
416 (x->verbose ? _("creating directory %s") : NULL),
418 if (ok && cwd_errno != 0
419 && (IS_RELATIVE_FILE_NAME (from) || IS_RELATIVE_FILE_NAME (to)))
421 error (0, cwd_errno, _("cannot return to current directory"));
429 ok = install_file_in_file (from, to, x);
434 /* Copy file FROM onto file TO and give TO the appropriate
436 Return true if successful. */
439 install_file_in_file (const char *from, const char *to,
440 const struct cp_options *x)
442 if (! copy_file (from, to, x))
446 if (! change_attributes (to))
448 if (x->preserve_timestamps)
449 return change_timestamps (from, to);
453 /* Copy file FROM into directory TO_DIR, keeping its same name,
454 and give the copy the appropriate attributes.
455 Return true if successful. */
458 install_file_in_dir (const char *from, const char *to_dir,
459 const struct cp_options *x)
461 const char *from_base = base_name (from);
462 char *to = file_name_concat (to_dir, from_base, NULL);
463 bool ret = install_file_in_file (from, to, x);
468 /* Copy file FROM onto file TO, creating TO if necessary.
469 Return true if successful. */
472 copy_file (const char *from, const char *to, const struct cp_options *x)
476 /* Allow installing from non-regular files like /dev/null.
477 Charles Karney reported that some Sun version of install allows that
478 and that sendmail's installation process relies on the behavior.
479 However, since !x->recursive, the call to "copy" will fail if FROM
482 return copy (from, to, false, x, ©_into_self, NULL);
485 /* Set the attributes of file or directory NAME.
486 Return true if successful. */
489 change_attributes (char const *name)
493 /* chown must precede chmod because on some systems,
494 chown clears the set[ug]id bits for non-superusers,
495 resulting in incorrect permissions.
496 On System V, users can give away files with chown and then not
497 be able to chmod them. So don't give files away.
499 We don't normally ignore errors from chown because the idea of
500 the install command is that the file is supposed to end up with
501 precisely the attributes that the user specified (or defaulted).
502 If the file doesn't end up with the group they asked for, they'll
503 want to know. But AFS returns EPERM when you try to change a
504 file's group; thus the kludge. */
506 if (chown (name, owner_id, group_id) != 0
512 error (0, errno, _("cannot change ownership of %s"), quote (name));
516 if (ok && chmod (name, mode) != 0)
518 error (0, errno, _("cannot change permissions of %s"), quote (name));
525 /* Set the timestamps of file TO to match those of file FROM.
526 Return true if successful. */
529 change_timestamps (const char *from, const char *to)
532 struct timespec timespec[2];
534 if (stat (from, &stb))
536 error (0, errno, _("cannot obtain time stamps for %s"), quote (from));
540 timespec[0] = get_stat_atime (&stb);
541 timespec[1] = get_stat_mtime (&stb);
542 if (utimens (to, timespec))
544 error (0, errno, _("cannot set time stamps for %s"), quote (to));
550 /* Strip the symbol table from the file NAME.
551 We could dig the magic number out of the file first to
552 determine whether to strip it, but the header files and
553 magic numbers vary so much from system to system that making
554 it portable would be very difficult. Not worth the effort. */
557 strip (char const *name)
565 error (EXIT_FAILURE, errno, _("fork system call failed"));
568 execlp ("strip", "strip", name, NULL);
569 error (EXIT_FAILURE, errno, _("cannot run strip"));
571 default: /* Parent. */
572 /* Parent process. */
573 while (pid != wait (&status)) /* Wait for kid to finish. */
576 error (EXIT_FAILURE, 0, _("strip failed"));
581 /* Initialize the user and group ownership of the files to install. */
591 pw = getpwnam (owner_name);
594 unsigned long int tmp;
595 if (xstrtoul (owner_name, NULL, 0, &tmp, NULL) != LONGINT_OK
597 error (EXIT_FAILURE, 0, _("invalid user %s"), quote (owner_name));
601 owner_id = pw->pw_uid;
605 owner_id = (uid_t) -1;
609 gr = getgrnam (group_name);
612 unsigned long int tmp;
613 if (xstrtoul (group_name, NULL, 0, &tmp, NULL) != LONGINT_OK
615 error (EXIT_FAILURE, 0, _("invalid group %s"), quote (group_name));
619 group_id = gr->gr_gid;
623 group_id = (gid_t) -1;
629 if (status != EXIT_SUCCESS)
630 fprintf (stderr, _("Try `%s --help' for more information.\n"),
635 Usage: %s [OPTION]... [-T] SOURCE DEST\n\
636 or: %s [OPTION]... SOURCE... DIRECTORY\n\
637 or: %s [OPTION]... -t DIRECTORY SOURCE...\n\
638 or: %s [OPTION]... -d DIRECTORY...\n\
640 program_name, program_name, program_name, program_name);
642 In the first three forms, copy SOURCE to DEST or multiple SOURCE(s) to\n\
643 the existing DIRECTORY, while setting permission modes and owner/group.\n\
644 In the 4th form, create all components of the given DIRECTORY(ies).\n\
648 Mandatory arguments to long options are mandatory for short options too.\n\
651 --backup[=CONTROL] make a backup of each existing destination file\n\
652 -b like --backup but does not accept an argument\n\
654 -d, --directory treat all arguments as directory names; create all\n\
655 components of the specified directories\n\
658 -D create all leading components of DEST except the last,\n\
659 then copy SOURCE to DEST\n\
660 -g, --group=GROUP set group ownership, instead of process' current group\n\
661 -m, --mode=MODE set permission mode (as in chmod), instead of rwxr-xr-x\n\
662 -o, --owner=OWNER set ownership (super-user only)\n\
665 -p, --preserve-timestamps apply access/modification times of SOURCE files\n\
666 to corresponding destination files\n\
667 -s, --strip strip symbol tables\n\
668 -S, --suffix=SUFFIX override the usual backup suffix\n\
669 -t, --target-directory=DIRECTORY copy all SOURCE arguments into DIRECTORY\n\
670 -T, --no-target-directory treat DEST as a normal file\n\
671 -v, --verbose print the name of each directory as it is created\n\
673 fputs (HELP_OPTION_DESCRIPTION, stdout);
674 fputs (VERSION_OPTION_DESCRIPTION, stdout);
677 The backup suffix is `~', unless set with --suffix or SIMPLE_BACKUP_SUFFIX.\n\
678 The version control method may be selected via the --backup option or through\n\
679 the VERSION_CONTROL environment variable. Here are the values:\n\
683 none, off never make backups (even if --backup is given)\n\
684 numbered, t make numbered backups\n\
685 existing, nil numbered if numbered backups exist, simple otherwise\n\
686 simple, never always make simple backups\n\
688 printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);