builtin/rm.c

   1 /*
   2  * "git rm" builtin command
   3  *
   4  * Copyright (C) Linus Torvalds 2006
   5  */
   6 #define USE_THE_INDEX_VARIABLE
   7 #include "builtin.h"
   8 #include "alloc.h"
   9 #include "advice.h"
  10 #include "config.h"
  11 #include "lockfile.h"
  12 #include "dir.h"
  13 #include "cache-tree.h"
  14 #include "gettext.h"
  15 #include "tree-walk.h"
  16 #include "parse-options.h"
  17 #include "string-list.h"
  18 #include "setup.h"
  19 #include "submodule.h"
  20 #include "pathspec.h"
  21
  22 static const char * const builtin_rm_usage[] = {
  23         N_("git rm [-f | --force] [-n] [-r] [--cached] [--ignore-unmatch]\n"
  24            "       [--quiet] [--pathspec-from-file=<file> [--pathspec-file-nul]]\n"
  25            "       [--] [<pathspec>...]"),
  26         NULL
  27 };
  28
  29 static struct {
  30         int nr, alloc;
  31         struct {
  32                 const char *name;
  33                 char is_submodule;
  34         } *entry;
  35 } list;
  36
  37 static int get_ours_cache_pos(const char *path, int pos)
  38 {
  39         int i = -pos - 1;
  40
  41         while ((i < the_index.cache_nr) && !strcmp(the_index.cache[i]->name, path)) {
  42                 if (ce_stage(the_index.cache[i]) == 2)
  43                         return i;
  44                 i++;
  45         }
  46         return -1;
  47 }
  48
  49 static void print_error_files(struct string_list *files_list,
  50                               const char *main_msg,
  51                               const char *hints_msg,
  52                               int *errs)
  53 {
  54         if (files_list->nr) {
  55                 int i;
  56                 struct strbuf err_msg = STRBUF_INIT;
  57
  58                 strbuf_addstr(&err_msg, main_msg);
  59                 for (i = 0; i < files_list->nr; i++)
  60                         strbuf_addf(&err_msg,
  61                                     "\n    %s",
  62                                     files_list->items[i].string);
  63                 if (advice_enabled(ADVICE_RM_HINTS))
  64                         strbuf_addstr(&err_msg, hints_msg);
  65                 *errs = error("%s", err_msg.buf);
  66                 strbuf_release(&err_msg);
  67         }
  68 }
  69
  70 static void submodules_absorb_gitdir_if_needed(void)
  71 {
  72         int i;
  73         for (i = 0; i < list.nr; i++) {
  74                 const char *name = list.entry[i].name;
  75                 int pos;
  76                 const struct cache_entry *ce;
  77
  78                 pos = index_name_pos(&the_index, name, strlen(name));
  79                 if (pos < 0) {
  80                         pos = get_ours_cache_pos(name, pos);
  81                         if (pos < 0)
  82                                 continue;
  83                 }
  84                 ce = the_index.cache[pos];
  85
  86                 if (!S_ISGITLINK(ce->ce_mode) ||
  87                     !file_exists(ce->name) ||
  88                     is_empty_dir(name))
  89                         continue;
  90
  91                 if (!submodule_uses_gitfile(name))
  92                         absorb_git_dir_into_superproject(name, NULL);
  93         }
  94 }
  95
  96 static int check_local_mod(struct object_id *head, int index_only)
  97 {
  98         /*
  99          * Items in list are already sorted in the cache order,
 100          * so we could do this a lot more efficiently by using
 101          * tree_desc based traversal if we wanted to, but I am
 102          * lazy, and who cares if removal of files is a tad
 103          * slower than the theoretical maximum speed?
 104          */
 105         int i, no_head;
 106         int errs = 0;
 107         struct string_list files_staged = STRING_LIST_INIT_NODUP;
 108         struct string_list files_cached = STRING_LIST_INIT_NODUP;
 109         struct string_list files_local = STRING_LIST_INIT_NODUP;
 110
 111         no_head = is_null_oid(head);
 112         for (i = 0; i < list.nr; i++) {
 113                 struct stat st;
 114                 int pos;
 115                 const struct cache_entry *ce;
 116                 const char *name = list.entry[i].name;
 117                 struct object_id oid;
 118                 unsigned short mode;
 119                 int local_changes = 0;
 120                 int staged_changes = 0;
 121
 122                 pos = index_name_pos(&the_index, name, strlen(name));
 123                 if (pos < 0) {
 124                         /*
 125                          * Skip unmerged entries except for populated submodules
 126                          * that could lose history when removed.
 127                          */
 128                         pos = get_ours_cache_pos(name, pos);
 129                         if (pos < 0)
 130                                 continue;
 131
 132                         if (!S_ISGITLINK(the_index.cache[pos]->ce_mode) ||
 133                             is_empty_dir(name))
 134                                 continue;
 135                 }
 136                 ce = the_index.cache[pos];
 137
 138                 if (lstat(ce->name, &st) < 0) {
 139                         if (!is_missing_file_error(errno))
 140                                 warning_errno(_("failed to stat '%s'"), ce->name);
 141                         /* It already vanished from the working tree */
 142                         continue;
 143                 }
 144                 else if (S_ISDIR(st.st_mode)) {
 145                         /* if a file was removed and it is now a
 146                          * directory, that is the same as ENOENT as
 147                          * far as git is concerned; we do not track
 148                          * directories unless they are submodules.
 149                          */
 150                         if (!S_ISGITLINK(ce->ce_mode))
 151                                 continue;
 152                 }
 153
 154                 /*
 155                  * "rm" of a path that has changes need to be treated
 156                  * carefully not to allow losing local changes
 157                  * accidentally.  A local change could be (1) file in
 158                  * work tree is different since the index; and/or (2)
 159                  * the user staged a content that is different from
 160                  * the current commit in the index.
 161                  *
 162                  * In such a case, you would need to --force the
 163                  * removal.  However, "rm --cached" (remove only from
 164                  * the index) is safe if the index matches the file in
 165                  * the work tree or the HEAD commit, as it means that
 166                  * the content being removed is available elsewhere.
 167                  */
 168
 169                 /*
 170                  * Is the index different from the file in the work tree?
 171                  * If it's a submodule, is its work tree modified?
 172                  */
 173                 if (ie_match_stat(&the_index, ce, &st, 0) ||
 174                     (S_ISGITLINK(ce->ce_mode) &&
 175                      bad_to_remove_submodule(ce->name,
 176                                 SUBMODULE_REMOVAL_DIE_ON_ERROR |
 177                                 SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED)))
 178                         local_changes = 1;
 179
 180                 /*
 181                  * Is the index different from the HEAD commit?  By
 182                  * definition, before the very initial commit,
 183                  * anything staged in the index is treated by the same
 184                  * way as changed from the HEAD.
 185                  */
 186                 if (no_head
 187                      || get_tree_entry(the_repository, head, name, &oid, &mode)
 188                      || ce->ce_mode != create_ce_mode(mode)
 189                      || !oideq(&ce->oid, &oid))
 190                         staged_changes = 1;
 191
 192                 /*
 193                  * If the index does not match the file in the work
 194                  * tree and if it does not match the HEAD commit
 195                  * either, (1) "git rm" without --cached definitely
 196                  * will lose information; (2) "git rm --cached" will
 197                  * lose information unless it is about removing an
 198                  * "intent to add" entry.
 199                  */
 200                 if (local_changes && staged_changes) {
 201                         if (!index_only || !ce_intent_to_add(ce))
 202                                 string_list_append(&files_staged, name);
 203                 }
 204                 else if (!index_only) {
 205                         if (staged_changes)
 206                                 string_list_append(&files_cached, name);
 207                         if (local_changes)
 208                                 string_list_append(&files_local, name);
 209                 }
 210         }
 211         print_error_files(&files_staged,
 212                           Q_("the following file has staged content different "
 213                              "from both the\nfile and the HEAD:",
 214                              "the following files have staged content different"
 215                              " from both the\nfile and the HEAD:",
 216                              files_staged.nr),
 217                           _("\n(use -f to force removal)"),
 218                           &errs);
 219         string_list_clear(&files_staged, 0);
 220         print_error_files(&files_cached,
 221                           Q_("the following file has changes "
 222                              "staged in the index:",
 223                              "the following files have changes "
 224                              "staged in the index:", files_cached.nr),
 225                           _("\n(use --cached to keep the file,"
 226                             " or -f to force removal)"),
 227                           &errs);
 228         string_list_clear(&files_cached, 0);
 229
 230         print_error_files(&files_local,
 231                           Q_("the following file has local modifications:",
 232                              "the following files have local modifications:",
 233                              files_local.nr),
 234                           _("\n(use --cached to keep the file,"
 235                             " or -f to force removal)"),
 236                           &errs);
 237         string_list_clear(&files_local, 0);
 238
 239         return errs;
 240 }
 241
 242 static int show_only = 0, force = 0, index_only = 0, recursive = 0, quiet = 0;
 243 static int ignore_unmatch = 0, pathspec_file_nul;
 244 static int include_sparse;
 245 static char *pathspec_from_file;
 246
 247 static struct option builtin_rm_options[] = {
 248         OPT__DRY_RUN(&show_only, N_("dry run")),
 249         OPT__QUIET(&quiet, N_("do not list removed files")),
 250         OPT_BOOL( 0 , "cached",         &index_only, N_("only remove from the index")),
 251         OPT__FORCE(&force, N_("override the up-to-date check"), PARSE_OPT_NOCOMPLETE),
 252         OPT_BOOL('r', NULL,             &recursive,  N_("allow recursive removal")),
 253         OPT_BOOL( 0 , "ignore-unmatch", &ignore_unmatch,
 254                                 N_("exit with a zero status even if nothing matched")),
 255         OPT_BOOL(0, "sparse", &include_sparse, N_("allow updating entries outside of the sparse-checkout cone")),
 256         OPT_PATHSPEC_FROM_FILE(&pathspec_from_file),
 257         OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul),
 258         OPT_END(),
 259 };
 260
 261 int cmd_rm(int argc, const char **argv, const char *prefix)
 262 {
 263         struct lock_file lock_file = LOCK_INIT;
 264         int i, ret = 0;
 265         struct pathspec pathspec;
 266         char *seen;
 267
 268         git_config(git_default_config, NULL);
 269
 270         argc = parse_options(argc, argv, prefix, builtin_rm_options,
 271                              builtin_rm_usage, 0);
 272
 273         parse_pathspec(&pathspec, 0,
 274                        PATHSPEC_PREFER_CWD,
 275                        prefix, argv);
 276
 277         if (pathspec_from_file) {
 278                 if (pathspec.nr)
 279                         die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");
 280
 281                 parse_pathspec_file(&pathspec, 0,
 282                                     PATHSPEC_PREFER_CWD,
 283                                     prefix, pathspec_from_file, pathspec_file_nul);
 284         } else if (pathspec_file_nul) {
 285                 die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
 286         }
 287
 288         if (!pathspec.nr)
 289                 die(_("No pathspec was given. Which files should I remove?"));
 290
 291         if (!index_only)
 292                 setup_work_tree();
 293
 294         prepare_repo_settings(the_repository);
 295         the_repository->settings.command_requires_full_index = 0;
 296         repo_hold_locked_index(the_repository, &lock_file, LOCK_DIE_ON_ERROR);
 297
 298         if (repo_read_index(the_repository) < 0)
 299                 die(_("index file corrupt"));
 300
 301         refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, &pathspec, NULL, NULL);
 302
 303         seen = xcalloc(pathspec.nr, 1);
 304
 305         if (pathspec_needs_expanded_index(&the_index, &pathspec))
 306                 ensure_full_index(&the_index);
 307
 308         for (i = 0; i < the_index.cache_nr; i++) {
 309                 const struct cache_entry *ce = the_index.cache[i];
 310
 311                 if (!include_sparse &&
 312                     (ce_skip_worktree(ce) ||
 313                      !path_in_sparse_checkout(ce->name, &the_index)))
 314                         continue;
 315                 if (!ce_path_match(&the_index, ce, &pathspec, seen))
 316                         continue;
 317                 ALLOC_GROW(list.entry, list.nr + 1, list.alloc);
 318                 list.entry[list.nr].name = xstrdup(ce->name);
 319                 list.entry[list.nr].is_submodule = S_ISGITLINK(ce->ce_mode);
 320                 if (list.entry[list.nr++].is_submodule &&
 321                     !is_staging_gitmodules_ok(&the_index))
 322                         die(_("please stage your changes to .gitmodules or stash them to proceed"));
 323         }
 324
 325         if (pathspec.nr) {
 326                 const char *original;
 327                 int seen_any = 0;
 328                 char *skip_worktree_seen = NULL;
 329                 struct string_list only_match_skip_worktree = STRING_LIST_INIT_NODUP;
 330
 331                 for (i = 0; i < pathspec.nr; i++) {
 332                         original = pathspec.items[i].original;
 333                         if (seen[i])
 334                                 seen_any = 1;
 335                         else if (ignore_unmatch)
 336                                 continue;
 337                         else if (!include_sparse &&
 338                                  matches_skip_worktree(&pathspec, i, &skip_worktree_seen))
 339                                 string_list_append(&only_match_skip_worktree, original);
 340                         else
 341                                 die(_("pathspec '%s' did not match any files"), original);
 342
 343                         if (!recursive && seen[i] == MATCHED_RECURSIVELY)
 344                                 die(_("not removing '%s' recursively without -r"),
 345                                     *original ? original : ".");
 346                 }
 347
 348                 if (only_match_skip_worktree.nr) {
 349                         advise_on_updating_sparse_paths(&only_match_skip_worktree);
 350                         ret = 1;
 351                 }
 352                 free(skip_worktree_seen);
 353                 string_list_clear(&only_match_skip_worktree, 0);
 354
 355                 if (!seen_any)
 356                         exit(ret);
 357         }
 358         clear_pathspec(&pathspec);
 359         free(seen);
 360
 361         if (!index_only)
 362                 submodules_absorb_gitdir_if_needed();
 363
 364         /*
 365          * If not forced, the file, the index and the HEAD (if exists)
 366          * must match; but the file can already been removed, since
 367          * this sequence is a natural "novice" way:
 368          *
 369          *      rm F; git rm F
 370          *
 371          * Further, if HEAD commit exists, "diff-index --cached" must
 372          * report no changes unless forced.
 373          */
 374         if (!force) {
 375                 struct object_id oid;
 376                 if (get_oid("HEAD", &oid))
 377                         oidclr(&oid);
 378                 if (check_local_mod(&oid, index_only))
 379                         exit(1);
 380         }
 381
 382         /*
 383          * First remove the names from the index: we won't commit
 384          * the index unless all of them succeed.
 385          */
 386         for (i = 0; i < list.nr; i++) {
 387                 const char *path = list.entry[i].name;
 388                 if (!quiet)
 389                         printf("rm '%s'\n", path);
 390
 391                 if (remove_file_from_index(&the_index, path))
 392                         die(_("git rm: unable to remove %s"), path);
 393         }
 394
 395         if (show_only)
 396                 return 0;
 397
 398         /*
 399          * Then, unless we used "--cached", remove the filenames from
 400          * the workspace. If we fail to remove the first one, we
 401          * abort the "git rm" (but once we've successfully removed
 402          * any file at all, we'll go ahead and commit to it all:
 403          * by then we've already committed ourselves and can't fail
 404          * in the middle)
 405          */
 406         if (!index_only) {
 407                 int removed = 0, gitmodules_modified = 0;
 408                 struct strbuf buf = STRBUF_INIT;
 409                 int flag = force ? REMOVE_DIR_PURGE_ORIGINAL_CWD : 0;
 410                 for (i = 0; i < list.nr; i++) {
 411                         const char *path = list.entry[i].name;
 412                         if (list.entry[i].is_submodule) {
 413                                 strbuf_reset(&buf);
 414                                 strbuf_addstr(&buf, path);
 415                                 if (remove_dir_recursively(&buf, flag))
 416                                         die(_("could not remove '%s'"), path);
 417
 418                                 removed = 1;
 419                                 if (!remove_path_from_gitmodules(path))
 420                                         gitmodules_modified = 1;
 421                                 continue;
 422                         }
 423                         if (!remove_path(path)) {
 424                                 removed = 1;
 425                                 continue;
 426                         }
 427                         if (!removed)
 428                                 die_errno("git rm: '%s'", path);
 429                 }
 430                 strbuf_release(&buf);
 431                 if (gitmodules_modified)
 432                         stage_updated_gitmodules(&the_index);
 433         }
 434
 435         if (write_locked_index(&the_index, &lock_file,
 436                                COMMIT_LOCK | SKIP_IF_UNCHANGED))
 437                 die(_("Unable to write new index file"));
 438
 439         return ret;
 440 }