builtin-clean.c

   1 /*
   2  * "git clean" builtin command
   3  *
   4  * Copyright (C) 2007 Shawn Bohrer
   5  *
   6  * Based on git-clean.sh by Pavel Roskin
   7  */
   8
   9 #include "builtin.h"
  10 #include "cache.h"
  11 #include "dir.h"
  12 #include "parse-options.h"
  13 #include "quote.h"
  14
  15 static int force = -1; /* unset */
  16
  17 static const char *const builtin_clean_usage[] = {
  18         "git clean [-d] [-f] [-n] [-q] [-x | -X] [--] <paths>...",
  19         NULL
  20 };
  21
  22 static int git_clean_config(const char *var, const char *value, void *cb)
  23 {
  24         if (!strcmp(var, "clean.requireforce"))
  25                 force = !git_config_bool(var, value);
  26         return git_default_config(var, value, cb);
  27 }
  28
  29 int cmd_clean(int argc, const char **argv, const char *prefix)
  30 {
  31         int i;
  32         int show_only = 0, remove_directories = 0, quiet = 0, ignored = 0;
  33         int ignored_only = 0, baselen = 0, config_set = 0, errors = 0;
  34         struct strbuf directory = STRBUF_INIT;
  35         struct dir_struct dir;
  36         static const char **pathspec;
  37         struct strbuf buf = STRBUF_INIT;
  38         const char *qname;
  39         char *seen = NULL;
  40         struct option options[] = {
  41                 OPT__QUIET(&quiet),
  42                 OPT__DRY_RUN(&show_only),
  43                 OPT_BOOLEAN('f', NULL, &force, "force"),
  44                 OPT_BOOLEAN('d', NULL, &remove_directories,
  45                                 "remove whole directories"),
  46                 OPT_BOOLEAN('x', NULL, &ignored, "remove ignored files, too"),
  47                 OPT_BOOLEAN('X', NULL, &ignored_only,
  48                                 "remove only ignored files"),
  49                 OPT_END()
  50         };
  51
  52         git_config(git_clean_config, NULL);
  53         if (force < 0)
  54                 force = 0;
  55         else
  56                 config_set = 1;
  57
  58         argc = parse_options(argc, argv, prefix, options, builtin_clean_usage,
  59                              0);
  60
  61         memset(&dir, 0, sizeof(dir));
  62         if (ignored_only)
  63                 dir.flags |= DIR_SHOW_IGNORED;
  64
  65         if (ignored && ignored_only)
  66                 die("-x and -X cannot be used together");
  67
  68         if (!show_only && !force)
  69                 die("clean.requireForce%s set and -n or -f not given; "
  70                     "refusing to clean", config_set ? "" : " not");
  71
  72         dir.flags |= DIR_SHOW_OTHER_DIRECTORIES;
  73
  74         if (!ignored)
  75                 setup_standard_excludes(&dir);
  76
  77         pathspec = get_pathspec(prefix, argv);
  78         read_cache();
  79
  80         fill_directory(&dir, pathspec);
  81
  82         if (pathspec)
  83                 seen = xmalloc(argc > 0 ? argc : 1);
  84
  85         for (i = 0; i < dir.nr; i++) {
  86                 struct dir_entry *ent = dir.entries[i];
  87                 int len, pos;
  88                 int matches = 0;
  89                 struct cache_entry *ce;
  90                 struct stat st;
  91
  92                 /*
  93                  * Remove the '/' at the end that directory
  94                  * walking adds for directory entries.
  95                  */
  96                 len = ent->len;
  97                 if (len && ent->name[len-1] == '/')
  98                         len--;
  99                 pos = cache_name_pos(ent->name, len);
 100                 if (0 <= pos)
 101                         continue;       /* exact match */
 102                 pos = -pos - 1;
 103                 if (pos < active_nr) {
 104                         ce = active_cache[pos];
 105                         if (ce_namelen(ce) == len &&
 106                             !memcmp(ce->name, ent->name, len))
 107                                 continue; /* Yup, this one exists unmerged */
 108                 }
 109
 110                 /*
 111                  * we might have removed this as part of earlier
 112                  * recursive directory removal, so lstat() here could
 113                  * fail with ENOENT.
 114                  */
 115                 if (lstat(ent->name, &st))
 116                         continue;
 117
 118                 if (pathspec) {
 119                         memset(seen, 0, argc > 0 ? argc : 1);
 120                         matches = match_pathspec(pathspec, ent->name, len,
 121                                                  baselen, seen);
 122                 }
 123
 124                 if (S_ISDIR(st.st_mode)) {
 125                         strbuf_addstr(&directory, ent->name);
 126                         qname = quote_path_relative(directory.buf, directory.len, &buf, prefix);
 127                         if (show_only && (remove_directories ||
 128                             (matches == MATCHED_EXACTLY))) {
 129                                 printf("Would remove %s\n", qname);
 130                         } else if (remove_directories ||
 131                                    (matches == MATCHED_EXACTLY)) {
 132                                 if (!quiet)
 133                                         printf("Removing %s\n", qname);
 134                                 if (remove_dir_recursively(&directory, 0) != 0) {
 135                                         warning("failed to remove '%s'", qname);
 136                                         errors++;
 137                                 }
 138                         } else if (show_only) {
 139                                 printf("Would not remove %s\n", qname);
 140                         } else {
 141                                 printf("Not removing %s\n", qname);
 142                         }
 143                         strbuf_reset(&directory);
 144                 } else {
 145                         if (pathspec && !matches)
 146                                 continue;
 147                         qname = quote_path_relative(ent->name, -1, &buf, prefix);
 148                         if (show_only) {
 149                                 printf("Would remove %s\n", qname);
 150                                 continue;
 151                         } else if (!quiet) {
 152                                 printf("Removing %s\n", qname);
 153                         }
 154                         if (unlink(ent->name) != 0) {
 155                                 warning("failed to remove '%s'", qname);
 156                                 errors++;
 157                         }
 158                 }
 159         }
 160         free(seen);
 161
 162         strbuf_release(&directory);
 163         return (errors != 0);
 164 }