1 /* mv -- move or rename files
2 Copyright (C) 1986, 1989-1991, 1995-2012 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 3 of the License, or
7 (at your option) any later version.
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, see <http://www.gnu.org/licenses/>. */
17 /* Written by Mike Parker, David MacKenzie, and Jim Meyering */
22 #include <sys/types.h>
24 #include <selinux/selinux.h>
27 #include "backupfile.h"
31 #include "filenamecat.h"
34 #include "root-dev-ino.h"
37 /* The official name of this program (e.g., no `g' prefix). */
38 #define PROGRAM_NAME "mv"
41 proper_name ("Mike Parker"), \
42 proper_name ("David MacKenzie"), \
43 proper_name ("Jim Meyering")
45 /* For long options that have no equivalent short option, use a
46 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
49 STRIP_TRAILING_SLASHES_OPTION
= CHAR_MAX
+ 1
52 /* Remove any trailing slashes from each SOURCE argument. */
53 static bool remove_trailing_slashes
;
55 static struct option
const long_options
[] =
57 {"backup", optional_argument
, NULL
, 'b'},
58 {"force", no_argument
, NULL
, 'f'},
59 {"interactive", no_argument
, NULL
, 'i'},
60 {"no-clobber", no_argument
, NULL
, 'n'},
61 {"no-target-directory", no_argument
, NULL
, 'T'},
62 {"strip-trailing-slashes", no_argument
, NULL
, STRIP_TRAILING_SLASHES_OPTION
},
63 {"suffix", required_argument
, NULL
, 'S'},
64 {"target-directory", required_argument
, NULL
, 't'},
65 {"update", no_argument
, NULL
, 'u'},
66 {"verbose", no_argument
, NULL
, 'v'},
67 {GETOPT_HELP_OPTION_DECL
},
68 {GETOPT_VERSION_OPTION_DECL
},
73 rm_option_init (struct rm_options
*x
)
75 x
->ignore_missing_files
= false;
77 x
->one_file_system
= false;
79 /* Should we prompt for removal, too? No. Prompting for the `move'
80 part is enough. It implies removal. */
81 x
->interactive
= RMI_NEVER
;
86 /* Since this program may well have to process additional command
87 line arguments after any call to `rm', that function must preserve
88 the initial working directory, in case one of those is a
90 x
->require_restore_cwd
= true;
93 static struct dev_ino dev_ino_buf
;
94 x
->root_dev_ino
= get_root_dev_ino (&dev_ino_buf
);
95 if (x
->root_dev_ino
== NULL
)
96 error (EXIT_FAILURE
, errno
, _("failed to get attributes of %s"),
102 cp_option_init (struct cp_options
*x
)
104 bool selinux_enabled
= (0 < is_selinux_enabled ());
106 cp_options_default (x
);
107 x
->copy_as_regular
= false; /* FIXME: maybe make this an option */
108 x
->reflink_mode
= REFLINK_NEVER
;
109 x
->dereference
= DEREF_NEVER
;
110 x
->unlink_dest_before_opening
= false;
111 x
->unlink_dest_after_failed_open
= false;
112 x
->hard_link
= false;
113 x
->interactive
= I_UNSPECIFIED
;
115 x
->one_file_system
= false;
116 x
->preserve_ownership
= true;
117 x
->preserve_links
= true;
118 x
->preserve_mode
= true;
119 x
->preserve_timestamps
= true;
120 x
->preserve_security_context
= selinux_enabled
;
121 x
->reduce_diagnostics
= false;
122 x
->data_copy_required
= true;
123 x
->require_preserve
= false; /* FIXME: maybe make this an option */
124 x
->require_preserve_context
= false;
125 x
->preserve_xattr
= true;
126 x
->require_preserve_xattr
= false;
128 x
->sparse_mode
= SPARSE_AUTO
; /* FIXME: maybe make this an option */
129 x
->symbolic_link
= false;
132 x
->stdin_tty
= isatty (STDIN_FILENO
);
134 x
->open_dangling_dest_symlink
= false;
141 /* FILE is the last operand of this command. Return true if FILE is a
142 directory. But report an error if there is a problem accessing FILE, other
143 than nonexistence (errno == ENOENT). */
146 target_directory_operand (char const *file
)
149 int err
= (stat (file
, &st
) == 0 ? 0 : errno
);
150 bool is_a_dir
= !err
&& S_ISDIR (st
.st_mode
);
151 if (err
&& err
!= ENOENT
)
152 error (EXIT_FAILURE
, err
, _("accessing %s"), quote (file
));
156 /* Move SOURCE onto DEST. Handles cross-file-system moves.
157 If SOURCE is a directory, DEST must not exist.
158 Return true if successful. */
161 do_move (const char *source
, const char *dest
, const struct cp_options
*x
)
164 bool rename_succeeded
;
165 bool ok
= copy (source
, dest
, false, x
, ©_into_self
, &rename_succeeded
);
169 char const *dir_to_remove
;
172 /* In general, when copy returns with copy_into_self set, SOURCE is
173 the same as, or a parent of DEST. In this case we know it's a
174 parent. It doesn't make sense to move a directory into itself, and
175 besides in some situations doing so would give highly nonintuitive
176 results. Run this `mkdir b; touch a c; mv * b' in an empty
177 directory. Here's the result of running echo `find b -print`:
178 b b/a b/b b/b/a b/c. Notice that only file `a' was copied
179 into b/b. Handle this by giving a diagnostic, removing the
180 copied-into-self directory, DEST (`b/b' in the example),
183 dir_to_remove
= NULL
;
186 else if (rename_succeeded
)
188 /* No need to remove anything. SOURCE was successfully
189 renamed to DEST. Or the user declined to rename a file. */
190 dir_to_remove
= NULL
;
194 /* This may mean SOURCE and DEST referred to different devices.
195 It may also conceivably mean that even though they referred
196 to the same device, rename wasn't implemented for that device.
198 E.g., (from Joel N. Weber),
199 [...] there might someday be cases where you can't rename
200 but you can copy where the device name is the same, especially
201 on Hurd. Consider an ftpfs with a primitive ftp server that
202 supports uploading, downloading and deleting, but not renaming.
204 Also, note that comparing device numbers is not a reliable
205 check for `can-rename'. Some systems can be set up so that
206 files from many different physical devices all have the same
207 st_dev field. This is a feature of some NFS mounting
210 We reach this point if SOURCE has been successfully copied
211 to DEST. Now we have to remove SOURCE.
213 This function used to resort to copying only when rename
214 failed and set errno to EXDEV. */
216 dir_to_remove
= source
;
219 if (dir_to_remove
!= NULL
)
221 struct rm_options rm_options
;
222 enum RM_status status
;
225 rm_option_init (&rm_options
);
226 rm_options
.verbose
= x
->verbose
;
227 dir
[0] = dir_to_remove
;
230 status
= rm ((void*) dir
, &rm_options
);
231 assert (VALID_STATUS (status
));
232 if (status
== RM_ERROR
)
240 /* Move file SOURCE onto DEST. Handles the case when DEST is a directory.
241 Treat DEST as a directory if DEST_IS_DIR.
242 Return true if successful. */
245 movefile (char *source
, char *dest
, bool dest_is_dir
,
246 const struct cp_options
*x
)
250 /* This code was introduced to handle the ambiguity in the semantics
251 of mv that is induced by the varying semantics of the rename function.
252 Some systems (e.g., GNU/Linux) have a rename function that honors a
253 trailing slash, while others (like Solaris 5,6,7) have a rename
254 function that ignores a trailing slash. I believe the GNU/Linux
255 rename semantics are POSIX and susv2 compliant. */
257 if (remove_trailing_slashes
)
258 strip_trailing_slashes (source
);
262 /* Treat DEST as a directory; build the full filename. */
263 char const *src_basename
= last_component (source
);
264 char *new_dest
= file_name_concat (dest
, src_basename
, NULL
);
265 strip_trailing_slashes (new_dest
);
266 ok
= do_move (source
, new_dest
, x
);
271 ok
= do_move (source
, dest
, x
);
280 if (status
!= EXIT_SUCCESS
)
285 Usage: %s [OPTION]... [-T] SOURCE DEST\n\
286 or: %s [OPTION]... SOURCE... DIRECTORY\n\
287 or: %s [OPTION]... -t DIRECTORY SOURCE...\n\
289 program_name
, program_name
, program_name
);
291 Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY.\n\
295 Mandatory arguments to long options are mandatory for short options too.\n\
298 --backup[=CONTROL] make a backup of each existing destination file\
300 -b like --backup but does not accept an argument\n\
301 -f, --force do not prompt before overwriting\n\
302 -i, --interactive prompt before overwrite\n\
303 -n, --no-clobber do not overwrite an existing file\n\
304 If you specify more than one of -i, -f, -n, only the final one takes effect.\n\
307 --strip-trailing-slashes remove any trailing slashes from each SOURCE\n\
309 -S, --suffix=SUFFIX override the usual backup suffix\n\
312 -t, --target-directory=DIRECTORY move all SOURCE arguments into DIRECTORY\n\
313 -T, --no-target-directory treat DEST as a normal file\n\
314 -u, --update move only when the SOURCE file is newer\n\
315 than the destination file or when the\n\
316 destination file is missing\n\
317 -v, --verbose explain what is being done\n\
319 fputs (HELP_OPTION_DESCRIPTION
, stdout
);
320 fputs (VERSION_OPTION_DESCRIPTION
, stdout
);
323 The backup suffix is `~', unless set with --suffix or SIMPLE_BACKUP_SUFFIX.\n\
324 The version control method may be selected via the --backup option or through\n\
325 the VERSION_CONTROL environment variable. Here are the values:\n\
329 none, off never make backups (even if --backup is given)\n\
330 numbered, t make numbered backups\n\
331 existing, nil numbered if numbered backups exist, simple otherwise\n\
332 simple, never always make simple backups\n\
334 emit_ancillary_info ();
340 main (int argc
, char **argv
)
344 bool make_backups
= false;
345 char *backup_suffix_string
;
346 char *version_control_string
= NULL
;
348 char *target_directory
= NULL
;
349 bool no_target_directory
= false;
353 initialize_main (&argc
, &argv
);
354 set_program_name (argv
[0]);
355 setlocale (LC_ALL
, "");
356 bindtextdomain (PACKAGE
, LOCALEDIR
);
357 textdomain (PACKAGE
);
359 atexit (close_stdin
);
363 /* Try to disable the ability to unlink a directory. */
364 priv_set_remove_linkdir ();
366 /* FIXME: consider not calling getenv for SIMPLE_BACKUP_SUFFIX unless
367 we'll actually use backup_suffix_string. */
368 backup_suffix_string
= getenv ("SIMPLE_BACKUP_SUFFIX");
370 while ((c
= getopt_long (argc
, argv
, "bfint:uvS:T", long_options
, NULL
))
378 version_control_string
= optarg
;
381 x
.interactive
= I_ALWAYS_YES
;
384 x
.interactive
= I_ASK_USER
;
387 x
.interactive
= I_ALWAYS_NO
;
389 case STRIP_TRAILING_SLASHES_OPTION
:
390 remove_trailing_slashes
= true;
393 if (target_directory
)
394 error (EXIT_FAILURE
, 0, _("multiple target directories specified"));
398 if (stat (optarg
, &st
) != 0)
399 error (EXIT_FAILURE
, errno
, _("accessing %s"), quote (optarg
));
400 if (! S_ISDIR (st
.st_mode
))
401 error (EXIT_FAILURE
, 0, _("target %s is not a directory"),
404 target_directory
= optarg
;
407 no_target_directory
= true;
417 backup_suffix_string
= optarg
;
419 case_GETOPT_HELP_CHAR
;
420 case_GETOPT_VERSION_CHAR (PROGRAM_NAME
, AUTHORS
);
422 usage (EXIT_FAILURE
);
426 n_files
= argc
- optind
;
427 file
= argv
+ optind
;
429 if (n_files
<= !target_directory
)
432 error (0, 0, _("missing file operand"));
434 error (0, 0, _("missing destination file operand after %s"),
436 usage (EXIT_FAILURE
);
439 if (no_target_directory
)
441 if (target_directory
)
442 error (EXIT_FAILURE
, 0,
443 _("cannot combine --target-directory (-t) "
444 "and --no-target-directory (-T)"));
447 error (0, 0, _("extra operand %s"), quote (file
[2]));
448 usage (EXIT_FAILURE
);
451 else if (!target_directory
)
453 assert (2 <= n_files
);
454 if (target_directory_operand (file
[n_files
- 1]))
455 target_directory
= file
[--n_files
];
456 else if (2 < n_files
)
457 error (EXIT_FAILURE
, 0, _("target %s is not a directory"),
458 quote (file
[n_files
- 1]));
461 if (make_backups
&& x
.interactive
== I_ALWAYS_NO
)
464 _("options --backup and --no-clobber are mutually exclusive"));
465 usage (EXIT_FAILURE
);
468 if (backup_suffix_string
)
469 simple_backup_suffix
= xstrdup (backup_suffix_string
);
471 x
.backup_type
= (make_backups
472 ? xget_version (_("backup type"),
473 version_control_string
)
478 if (target_directory
)
482 /* Initialize the hash table only if we'll need it.
483 The problem it is used to detect can arise only if there are
484 two or more files to move. */
489 for (i
= 0; i
< n_files
; ++i
)
490 ok
&= movefile (file
[i
], target_directory
, true, &x
);
493 ok
= movefile (file
[0], file
[1], false, &x
);
495 exit (ok
? EXIT_SUCCESS
: EXIT_FAILURE
);