1 /* install - copy files and set attributes
2 Copyright (C) 89, 90, 91, 95, 96, 97, 1998 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
18 /* Copy files and set their permission modes and, if possible,
19 their owner and group. Used similarly to `cp'; typically
20 used in Makefiles to copy programs into their destination
21 directories. It can also be used to create the destination
22 directories and any leading directories, and to set the final
23 directory's modes. It refuses to copy files onto themselves.
27 Set the group ownership of the installed file or directory
28 to the group ID of GROUP (default is process's current
29 group). GROUP may also be a numeric group ID.
32 Set the permission mode for the installed file or directory
33 to MODE, which is an octal number (default is 0755).
36 If run as root, set the ownership of the installed file to
37 the user ID of OWNER (default is root). OWNER may also be
40 -c No effect. For compatibility with old Unix versions of install.
43 Strip the symbol tables from installed files.
45 -p, --preserve-timestamps
46 Retain creation and modification timestamps when installing files.
49 Create a directory and its leading directories, if they
50 do not already exist. Set the owner, group and mode
51 as given on the command line. Any leading directories
52 that are created are also given those attributes.
53 This is different from the SunOS 4.0 install, which gives
54 directories that it creates the default attributes.
57 Like the -d option, but a file is installed, along with the directory.
58 Useful when installing into a new directory, and the install
59 process doesn't properly comprehend making directories.
61 David MacKenzie <djm@gnu.ai.mit.edu> */
70 #include <sys/types.h>
75 #include "backupfile.h"
76 #include "modechange.h"
83 # include <sys/wait.h>
90 struct passwd *getpwnam ();
91 struct group *getgrnam ();
93 #ifndef _POSIX_VERSION
99 # define endgrent() ((void) 0)
103 # define endpwent() ((void) 0)
106 /* True if C is an ASCII octal digit. */
107 #define isodigit(c) ((c) >= '0' && c <= '7')
109 /* Number of bytes of a file to copy at a time. */
110 #define READ_SIZE (32 * 1024)
113 # define UID_T_MAX TYPE_MAXIMUM (uid_t)
117 # define GID_T_MAX TYPE_MAXIMUM (gid_t)
125 enum backup_type get_version ();
127 static int change_timestamps PARAMS ((const char *from, const char *to));
128 static int change_attributes PARAMS ((const char *path, int no_need_to_chown));
129 static int copy_file PARAMS ((const char *from, const char *to,
131 static int install_file_to_path PARAMS ((const char *from, const char *to));
132 static int install_file_in_dir PARAMS ((const char *from, const char *to_dir));
133 static int install_file_in_file PARAMS ((const char *from, const char *to));
134 static void get_ids PARAMS ((void));
135 static void strip PARAMS ((const char *path));
136 static void usage PARAMS ((int status));
138 /* The name this program was run with, for error messages. */
141 /* FIXME: document */
142 enum backup_type backup_type;
144 /* The user name that will own the files, or NULL to make the owner
145 the current user ID. */
146 static char *owner_name;
148 /* The user ID corresponding to `owner_name'. */
149 static uid_t owner_id;
151 /* The group name that will own the files, or NULL to make the group
152 the current group ID. */
153 static char *group_name;
155 /* The group ID corresponding to `group_name'. */
156 static gid_t group_id;
158 /* The permissions to which the files will be set. The umask has
162 /* If nonzero, strip executable files after copying them. */
163 static int strip_files;
165 /* If nonzero, preserve timestamps when installing files. */
166 static int preserve_timestamps;
168 /* If nonzero, install a directory instead of a regular file. */
171 /* If nonzero, show what we are doing. */
174 /* If nonzero, display usage information and exit. */
175 static int show_help;
177 /* If nonzero, print the version on standard output and exit. */
178 static int show_version;
180 static struct option const long_options[] =
182 {"strip", no_argument, NULL, 's'},
183 {"directory", no_argument, NULL, 'd'},
184 {"group", required_argument, NULL, 'g'},
185 {"mode", required_argument, NULL, 'm'},
186 {"owner", required_argument, NULL, 'o'},
187 {"preserve-timestamps", no_argument, NULL, 'p'},
188 {"backup", no_argument, NULL, 'b'},
189 {"version-control", required_argument, NULL, 'V'},
190 {"verbose", no_argument, NULL, 'v'},
191 {"help", no_argument, &show_help, 1},
192 {"version", no_argument, &show_version, 1},
197 main (int argc, char **argv)
201 char *symbolic_mode = NULL;
202 int make_backups = 0;
204 int mkdir_and_install = 0;
206 program_name = argv[0];
207 setlocale (LC_ALL, "");
208 bindtextdomain (PACKAGE, LOCALEDIR);
209 textdomain (PACKAGE);
215 preserve_timestamps = 0;
220 version = getenv ("SIMPLE_BACKUP_SUFFIX");
222 simple_backup_suffix = version;
223 version = getenv ("VERSION_CONTROL");
225 while ((optc = getopt_long (argc, argv, "bcsDdg:m:o:pvV:S:", long_options,
244 mkdir_and_install = 1;
253 symbolic_mode = optarg;
259 preserve_timestamps = 1;
262 simple_backup_suffix = optarg;
274 printf ("install (%s) %s\n", GNU_PACKAGE, VERSION);
282 /* Check for invalid combinations of arguments. */
283 if (dir_arg && strip_files)
285 _("the strip option may not be used when installing a directory"));
287 backup_type = (make_backups ? get_version (version) : none);
289 if (optind == argc || (optind == argc - 1 && !dir_arg))
291 error (0, 0, _("too few arguments"));
297 struct mode_change *change = mode_compile (symbolic_mode, 0);
298 if (change == MODE_INVALID)
299 error (1, 0, _("invalid mode `%s'"), symbolic_mode);
300 else if (change == MODE_MEMORY_EXHAUSTED)
301 error (1, 0, _("virtual memory exhausted"));
302 mode = mode_adjust (0, change);
309 for (; optind < argc; ++optind)
312 make_path (argv[optind], mode, mode, owner_id, group_id, 0,
313 (verbose ? "creating directory `%s'" : NULL));
318 if (optind == argc - 2)
320 if (mkdir_and_install)
321 errors = install_file_to_path (argv[argc - 2], argv[argc - 1]);
322 else if (!isdir (argv[argc - 1]))
323 errors = install_file_in_file (argv[argc - 2], argv[argc - 1]);
325 errors = install_file_in_dir (argv[argc - 2], argv[argc - 1]);
329 if (!isdir (argv[argc - 1]))
331 for (; optind < argc - 1; ++optind)
333 errors |= install_file_in_dir (argv[optind], argv[argc - 1]);
343 /* Copy file FROM onto file TO, creating any missing parent directories of TO.
344 Return 0 if successful, 1 if an error occurs */
347 install_file_to_path (const char *from, const char *to)
352 dest_dir = dirname (to);
354 /* check to make sure this is a path (not install a b ) */
355 if (!STREQ (dest_dir, ".")
356 && !isdir (dest_dir))
358 /* FIXME: Note that it's a little kludgey (even dangerous) that we
359 derive the permissions for parent directories from the permissions
360 specfied for the file, but since this option is intended mainly to
361 help installers when the distribution doesn't provide proper install
362 rules, it's not so bad. Maybe use something like this instead:
363 int parent_dir_mode = (mode | (S_IRUGO | S_IXUGO)) & (~SPECIAL_BITS);
365 fail = make_path (dest_dir, mode, mode, owner_id, group_id, 0,
366 (verbose ? _("creating directory `%s'") : NULL));
370 fail = install_file_in_file (from, to);
378 /* Copy file FROM onto file TO and give TO the appropriate
380 Return 0 if successful, 1 if an error occurs. */
383 install_file_in_file (const char *from, const char *to)
386 int no_need_to_chown;
388 if (copy_file (from, to, &to_created))
392 no_need_to_chown = (to_created
393 && owner_name == NULL
394 && group_name == NULL);
395 if (change_attributes (to, no_need_to_chown))
397 if (preserve_timestamps)
398 return change_timestamps (from, to);
402 /* Copy file FROM into directory TO_DIR, keeping its same name,
403 and give the copy the appropriate attributes.
404 Return 0 if successful, 1 if not. */
407 install_file_in_dir (const char *from, const char *to_dir)
413 from_base = base_name (from);
414 to = xmalloc ((unsigned) (strlen (to_dir) + strlen (from_base) + 2));
415 stpcpy (stpcpy (stpcpy (to, to_dir), "/"), from_base);
416 ret = install_file_in_file (from, to);
421 /* A chunk of a file being copied. */
422 static char buffer[READ_SIZE];
424 /* Copy file FROM onto file TO, creating TO if necessary.
425 Return 0 if the copy is successful, 1 if not. If the copy is
426 successful, set *TO_CREATED to nonzero if TO was created (if it did
427 not exist or did, but was unlinked) and to zero otherwise. If the
428 copy fails, don't modify *TO_CREATED. */
431 copy_file (const char *from, const char *to, int *to_created)
436 struct stat from_stats, to_stats;
437 int target_created = 1;
439 if (stat (from, &from_stats))
441 error (0, errno, "%s", from);
445 /* Allow installing from non-regular files like /dev/null.
446 Charles Karney reported that some Sun version of install allows that
447 and that sendmail's installation process relies on the behavior. */
448 if (S_ISDIR (from_stats.st_mode))
450 error (0, 0, _("`%s' is a directory"), from);
453 if (stat (to, &to_stats) == 0)
455 if (!S_ISREG (to_stats.st_mode))
457 error (0, 0, _("`%s' is not a regular file"), to);
460 if (from_stats.st_dev == to_stats.st_dev
461 && from_stats.st_ino == to_stats.st_ino)
463 error (0, 0, _("`%s' and `%s' are the same file"), from, to);
467 /* The destination file exists. Try to back it up if required. */
468 if (backup_type != none)
470 char *tmp_backup = find_backup_file_name (to, backup_type);
473 if (tmp_backup == NULL)
474 error (1, 0, "virtual memory exhausted");
475 dst_backup = (char *) alloca (strlen (tmp_backup) + 1);
476 strcpy (dst_backup, tmp_backup);
478 if (rename (to, dst_backup))
482 error (0, errno, "cannot backup `%s'", to);
488 /* If unlink fails, try to proceed anyway. */
493 /* Now it's the time to give some feedback if requested. */
495 printf ("copying `%s' to `%s'\n", from, to);
497 fromfd = open (from, O_RDONLY, 0);
500 error (0, errno, "%s", from);
504 /* Make sure to open the file in a mode that allows writing. */
505 tofd = open (to, O_WRONLY | O_CREAT | O_TRUNC, 0600);
508 error (0, errno, "%s", to);
513 while ((bytes = safe_read (fromfd, buffer, READ_SIZE)) > 0)
514 if (full_write (tofd, buffer, bytes) < 0)
516 error (0, errno, "%s", to);
522 error (0, errno, "%s", from);
526 if (close (fromfd) < 0)
528 error (0, errno, "%s", from);
531 if (close (tofd) < 0)
533 error (0, errno, "%s", to);
537 *to_created = target_created;
546 /* Set the attributes of file or directory PATH.
547 If NO_NEED_TO_CHOWN is nonzero, don't call chown.
548 Return 0 if successful, 1 if not. */
551 change_attributes (const char *path, int no_need_to_chown)
555 /* chown must precede chmod because on some systems,
556 chown clears the set[ug]id bits for non-superusers,
557 resulting in incorrect permissions.
558 On System V, users can give away files with chown and then not
559 be able to chmod them. So don't give files away.
561 We don't pass -1 to chown to mean "don't change the value"
562 because SVR3 and earlier non-BSD systems don't support that.
564 We don't normally ignore errors from chown because the idea of
565 the install command is that the file is supposed to end up with
566 precisely the attributes that the user specified (or defaulted).
567 If the file doesn't end up with the group they asked for, they'll
568 want to know. But AFS returns EPERM when you try to change a
569 file's group; thus the kludge. */
571 if (!no_need_to_chown && chown (path, owner_id, group_id)
577 if (chmod (path, mode))
581 error (0, err, "%s", path);
587 /* Set the timestamps of file TO to match those of file FROM.
588 Return 0 if successful, 1 if not. */
591 change_timestamps (const char *from, const char *to)
596 if (stat (from, &stb))
598 error (0, errno, "%s", from);
601 utb.actime = stb.st_atime;
602 utb.modtime = stb.st_mtime;
603 if (utime (to, &utb))
605 error (0, errno, "%s", to);
611 /* Strip the symbol table from the file PATH.
612 We could dig the magic number out of the file first to
613 determine whether to strip it, but the header files and
614 magic numbers vary so much from system to system that making
615 it portable would be very difficult. Not worth the effort. */
618 strip (const char *path)
626 error (1, errno, _("fork system call failed"));
629 execlp ("strip", "strip", path, NULL);
630 error (1, errno, _("cannot run strip"));
632 default: /* Parent. */
633 /* Parent process. */
634 while (pid != wait (&status)) /* Wait for kid to finish. */
640 /* Initialize the user and group ownership of the files to install. */
650 pw = getpwnam (owner_name);
654 if (xstrtol (owner_name, NULL, 0, &tmp_long, NULL) != LONGINT_OK
655 || tmp_long < 0 || tmp_long > UID_T_MAX)
656 error (1, 0, _("invalid user `%s'"), owner_name);
657 owner_id = (uid_t) tmp_long;
660 owner_id = pw->pw_uid;
664 owner_id = (uid_t) -1;
668 gr = getgrnam (group_name);
672 if (xstrtol (group_name, NULL, 0, &tmp_long, NULL) != LONGINT_OK
673 || tmp_long < 0 || tmp_long > GID_T_MAX)
674 error (1, 0, _("invalid group `%s'"), group_name);
675 group_id = (gid_t) tmp_long;
678 group_id = gr->gr_gid;
682 group_id = (gid_t) -1;
689 fprintf (stderr, _("Try `%s --help' for more information.\n"),
694 Usage: %s [OPTION]... SOURCE DEST (1st format)\n\
695 or: %s [OPTION]... SOURCE... DIRECTORY (2nd format)\n\
696 or: %s -d [OPTION]... DIRECTORY... (3rd format)\n\
698 program_name, program_name, program_name);
700 In the first two formats, copy SOURCE to DEST or multiple SOURCE(s) to\n\
701 the existing DIRECTORY, while setting permission modes and owner/group.\n\
702 In the third format, create all components of the given DIRECTORY(ies).\n\
704 -b, --backup make backup before removal\n\
706 -d, --directory treat all arguments as directory names; create all\n\
707 components of the specified directories\n\
708 -D create all leading components of DEST except the last,\n\
709 then copy SOURCE to DEST; useful in the 1st format\n\
710 -g, --group=GROUP set group ownership, instead of process' current group\n\
711 -m, --mode=MODE set permission mode (as in chmod), instead of rwxr-xr-x\n\
712 -o, --owner=OWNER set ownership (super-user only)\n\
713 -p, --preserve-timestamps apply access/modification times of SOURCE files\n\
714 to corresponding destination files\n\
715 -s, --strip strip symbol tables, only for 1st and 2nd formats\n\
716 -S, --suffix=SUFFIX override the usual backup suffix\n\
717 --verbose print the name of each directory as it is created\n\
718 -V, --version-control=WORD override the usual version control\n\
719 --help display this help and exit\n\
720 --version output version information and exit\n\
724 The backup suffix is ~, unless set with SIMPLE_BACKUP_SUFFIX. The\n\
725 version control may be set with VERSION_CONTROL, values are:\n\
727 t, numbered make numbered backups\n\
728 nil, existing numbered if numbered backups exist, simple otherwise\n\
729 never, simple always make simple backups\n\
731 puts (_("\nReport bugs to <fileutils-bugs@gnu.org>."));