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;
  35         struct dir_struct dir;
  36         const char *path, *base;
  37         static const char **pathspec;
  38         struct strbuf buf;
  39         const char *qname;
  40         char *seen = NULL;
  41         struct option options[] = {
  42                 OPT__QUIET(&quiet),
  43                 OPT__DRY_RUN(&show_only),
  44                 OPT_BOOLEAN('f', NULL, &force, "force"),
  45                 OPT_BOOLEAN('d', NULL, &remove_directories,
  46                                 "remove whole directories"),
  47                 OPT_BOOLEAN('x', NULL, &ignored, "remove ignored files, too"),
  48                 OPT_BOOLEAN('X', NULL, &ignored_only,
  49                                 "remove only ignored files"),
  50                 OPT_END()
  51         };
  52
  53         git_config(git_clean_config, NULL);
  54         if (force < 0)
  55                 force = 0;
  56         else
  57                 config_set = 1;
  58
  59         argc = parse_options(argc, argv, options, builtin_clean_usage, 0);
  60
  61         strbuf_init(&buf, 0);
  62         memset(&dir, 0, sizeof(dir));
  63         if (ignored_only)
  64                 dir.show_ignored = 1;
  65
  66         if (ignored && ignored_only)
  67                 die("-x and -X cannot be used together");
  68
  69         if (!show_only && !force)
  70                 die("clean.requireForce%s set and -n or -f not given; "
  71                     "refusing to clean", config_set ? "" : " not");
  72
  73         dir.show_other_directories = 1;
  74
  75         if (!ignored)
  76                 setup_standard_excludes(&dir);
  77
  78         pathspec = get_pathspec(prefix, argv);
  79         read_cache();
  80
  81         /*
  82          * Calculate common prefix for the pathspec, and
  83          * use that to optimize the directory walk
  84          */
  85         baselen = common_prefix(pathspec);
  86         path = ".";
  87         base = "";
  88         if (baselen)
  89                 path = base = xmemdupz(*pathspec, baselen);
  90         read_directory(&dir, path, base, baselen, pathspec);
  91         strbuf_init(&directory, 0);
  92
  93         if (pathspec)
  94                 seen = xmalloc(argc > 0 ? argc : 1);
  95
  96         for (i = 0; i < dir.nr; i++) {
  97                 struct dir_entry *ent = dir.entries[i];
  98                 int len, pos;
  99                 int matches = 0;
 100                 struct cache_entry *ce;
 101                 struct stat st;
 102
 103                 /*
 104                  * Remove the '/' at the end that directory
 105                  * walking adds for directory entries.
 106                  */
 107                 len = ent->len;
 108                 if (len && ent->name[len-1] == '/')
 109                         len--;
 110                 pos = cache_name_pos(ent->name, len);
 111                 if (0 <= pos)
 112                         continue;       /* exact match */
 113                 pos = -pos - 1;
 114                 if (pos < active_nr) {
 115                         ce = active_cache[pos];
 116                         if (ce_namelen(ce) == len &&
 117                             !memcmp(ce->name, ent->name, len))
 118                                 continue; /* Yup, this one exists unmerged */
 119                 }
 120
 121                 /*
 122                  * we might have removed this as part of earlier
 123                  * recursive directory removal, so lstat() here could
 124                  * fail with ENOENT.
 125                  */
 126                 if (lstat(ent->name, &st))
 127                         continue;
 128
 129                 if (pathspec) {
 130                         memset(seen, 0, argc > 0 ? argc : 1);
 131                         matches = match_pathspec(pathspec, ent->name, len,
 132                                                  baselen, seen);
 133                 }
 134
 135                 if (S_ISDIR(st.st_mode)) {
 136                         strbuf_addstr(&directory, ent->name);
 137                         qname = quote_path_relative(directory.buf, directory.len, &buf, prefix);
 138                         if (show_only && (remove_directories ||
 139                             (matches == MATCHED_EXACTLY))) {
 140                                 printf("Would remove %s\n", qname);
 141                         } else if (remove_directories ||
 142                                    (matches == MATCHED_EXACTLY)) {
 143                                 if (!quiet)
 144                                         printf("Removing %s\n", qname);
 145                                 if (remove_dir_recursively(&directory, 0) != 0) {
 146                                         warning("failed to remove '%s'", qname);
 147                                         errors++;
 148                                 }
 149                         } else if (show_only) {
 150                                 printf("Would not remove %s\n", qname);
 151                         } else {
 152                                 printf("Not removing %s\n", qname);
 153                         }
 154                         strbuf_reset(&directory);
 155                 } else {
 156                         if (pathspec && !matches)
 157                                 continue;
 158                         qname = quote_path_relative(ent->name, -1, &buf, prefix);
 159                         if (show_only) {
 160                                 printf("Would remove %s\n", qname);
 161                                 continue;
 162                         } else if (!quiet) {
 163                                 printf("Removing %s\n", qname);
 164                         }
 165                         if (unlink(ent->name) != 0) {
 166                                 warning("failed to remove '%s'", qname);
 167                                 errors++;
 168                         }
 169                 }
 170         }
 171         free(seen);
 172
 173         strbuf_release(&directory);
 174         return (errors != 0);
 175 }