builtin/rm.c

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