git.oblomov.eu Git - git/blob - builtin/rm.c

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