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 "refs.h"
  14 #include "string-list.h"
  15 #include "quote.h"
  16
  17 static int force = -1; /* unset */
  18 static struct string_list del_list = STRING_LIST_INIT_DUP;
  19
  20 static const char *const builtin_clean_usage[] = {
  21         N_("git clean [-d] [-f] [-n] [-q] [-e <pattern>] [-x | -X] [--] <paths>..."),
  22         NULL
  23 };
  24
  25 static const char *msg_remove = N_("Removing %s\n");
  26 static const char *msg_would_remove = N_("Would remove %s\n");
  27 static const char *msg_skip_git_dir = N_("Skipping repository %s\n");
  28 static const char *msg_would_skip_git_dir = N_("Would skip repository %s\n");
  29 static const char *msg_warn_remove_failed = N_("failed to remove %s");
  30
  31 static int git_clean_config(const char *var, const char *value, void *cb)
  32 {
  33         if (!strcmp(var, "clean.requireforce"))
  34                 force = !git_config_bool(var, value);
  35         return git_default_config(var, value, cb);
  36 }
  37
  38 static int exclude_cb(const struct option *opt, const char *arg, int unset)
  39 {
  40         struct string_list *exclude_list = opt->value;
  41         string_list_append(exclude_list, arg);
  42         return 0;
  43 }
  44
  45 static int remove_dirs(struct strbuf *path, const char *prefix, int force_flag,
  46                 int dry_run, int quiet, int *dir_gone)
  47 {
  48         DIR *dir;
  49         struct strbuf quoted = STRBUF_INIT;
  50         struct dirent *e;
  51         int res = 0, ret = 0, gone = 1, original_len = path->len, len, i;
  52         unsigned char submodule_head[20];
  53         struct string_list dels = STRING_LIST_INIT_DUP;
  54
  55         *dir_gone = 1;
  56
  57         if ((force_flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
  58                         !resolve_gitlink_ref(path->buf, "HEAD", submodule_head)) {
  59                 if (!quiet) {
  60                         quote_path_relative(path->buf, prefix, &quoted);
  61                         printf(dry_run ?  _(msg_would_skip_git_dir) : _(msg_skip_git_dir),
  62                                         quoted.buf);
  63                 }
  64
  65                 *dir_gone = 0;
  66                 return 0;
  67         }
  68
  69         dir = opendir(path->buf);
  70         if (!dir) {
  71                 /* an empty dir could be removed even if it is unreadble */
  72                 res = dry_run ? 0 : rmdir(path->buf);
  73                 if (res) {
  74                         quote_path_relative(path->buf, prefix, &quoted);
  75                         warning(_(msg_warn_remove_failed), quoted.buf);
  76                         *dir_gone = 0;
  77                 }
  78                 return res;
  79         }
  80
  81         if (path->buf[original_len - 1] != '/')
  82                 strbuf_addch(path, '/');
  83
  84         len = path->len;
  85         while ((e = readdir(dir)) != NULL) {
  86                 struct stat st;
  87                 if (is_dot_or_dotdot(e->d_name))
  88                         continue;
  89
  90                 strbuf_setlen(path, len);
  91                 strbuf_addstr(path, e->d_name);
  92                 if (lstat(path->buf, &st))
  93                         ; /* fall thru */
  94                 else if (S_ISDIR(st.st_mode)) {
  95                         if (remove_dirs(path, prefix, force_flag, dry_run, quiet, &gone))
  96                                 ret = 1;
  97                         if (gone) {
  98                                 quote_path_relative(path->buf, prefix, &quoted);
  99                                 string_list_append(&dels, quoted.buf);
 100                         } else
 101                                 *dir_gone = 0;
 102                         continue;
 103                 } else {
 104                         res = dry_run ? 0 : unlink(path->buf);
 105                         if (!res) {
 106                                 quote_path_relative(path->buf, prefix, &quoted);
 107                                 string_list_append(&dels, quoted.buf);
 108                         } else {
 109                                 quote_path_relative(path->buf, prefix, &quoted);
 110                                 warning(_(msg_warn_remove_failed), quoted.buf);
 111                                 *dir_gone = 0;
 112                                 ret = 1;
 113                         }
 114                         continue;
 115                 }
 116
 117                 /* path too long, stat fails, or non-directory still exists */
 118                 *dir_gone = 0;
 119                 ret = 1;
 120                 break;
 121         }
 122         closedir(dir);
 123
 124         strbuf_setlen(path, original_len);
 125
 126         if (*dir_gone) {
 127                 res = dry_run ? 0 : rmdir(path->buf);
 128                 if (!res)
 129                         *dir_gone = 1;
 130                 else {
 131                         quote_path_relative(path->buf, prefix, &quoted);
 132                         warning(_(msg_warn_remove_failed), quoted.buf);
 133                         *dir_gone = 0;
 134                         ret = 1;
 135                 }
 136         }
 137
 138         if (!*dir_gone && !quiet) {
 139                 for (i = 0; i < dels.nr; i++)
 140                         printf(dry_run ?  _(msg_would_remove) : _(msg_remove), dels.items[i].string);
 141         }
 142         string_list_clear(&dels, 0);
 143         return ret;
 144 }
 145
 146 int cmd_clean(int argc, const char **argv, const char *prefix)
 147 {
 148         int i, res;
 149         int dry_run = 0, remove_directories = 0, quiet = 0, ignored = 0;
 150         int ignored_only = 0, config_set = 0, errors = 0, gone = 1;
 151         int rm_flags = REMOVE_DIR_KEEP_NESTED_GIT;
 152         struct strbuf abs_path = STRBUF_INIT;
 153         struct dir_struct dir;
 154         static const char **pathspec;
 155         struct strbuf buf = STRBUF_INIT;
 156         struct string_list exclude_list = STRING_LIST_INIT_NODUP;
 157         struct exclude_list *el;
 158         struct string_list_item *item;
 159         const char *qname;
 160         char *seen = NULL;
 161         struct option options[] = {
 162                 OPT__QUIET(&quiet, N_("do not print names of files removed")),
 163                 OPT__DRY_RUN(&dry_run, N_("dry run")),
 164                 OPT__FORCE(&force, N_("force")),
 165                 OPT_BOOLEAN('d', NULL, &remove_directories,
 166                                 N_("remove whole directories")),
 167                 { OPTION_CALLBACK, 'e', "exclude", &exclude_list, N_("pattern"),
 168                   N_("add <pattern> to ignore rules"), PARSE_OPT_NONEG, exclude_cb },
 169                 OPT_BOOLEAN('x', NULL, &ignored, N_("remove ignored files, too")),
 170                 OPT_BOOLEAN('X', NULL, &ignored_only,
 171                                 N_("remove only ignored files")),
 172                 OPT_END()
 173         };
 174
 175         git_config(git_clean_config, NULL);
 176         if (force < 0)
 177                 force = 0;
 178         else
 179                 config_set = 1;
 180
 181         argc = parse_options(argc, argv, prefix, options, builtin_clean_usage,
 182                              0);
 183
 184         memset(&dir, 0, sizeof(dir));
 185         if (ignored_only)
 186                 dir.flags |= DIR_SHOW_IGNORED;
 187
 188         if (ignored && ignored_only)
 189                 die(_("-x and -X cannot be used together"));
 190
 191         if (!dry_run && !force) {
 192                 if (config_set)
 193                         die(_("clean.requireForce set to true and neither -n nor -f given; "
 194                                   "refusing to clean"));
 195                 else
 196                         die(_("clean.requireForce defaults to true and neither -n nor -f given; "
 197                                   "refusing to clean"));
 198         }
 199
 200         if (force > 1)
 201                 rm_flags = 0;
 202
 203         dir.flags |= DIR_SHOW_OTHER_DIRECTORIES;
 204
 205         if (read_cache() < 0)
 206                 die(_("index file corrupt"));
 207
 208         if (!ignored)
 209                 setup_standard_excludes(&dir);
 210
 211         el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
 212         for (i = 0; i < exclude_list.nr; i++)
 213                 add_exclude(exclude_list.items[i].string, "", 0, el, -(i+1));
 214
 215         pathspec = get_pathspec(prefix, argv);
 216
 217         fill_directory(&dir, pathspec);
 218
 219         if (pathspec)
 220                 seen = xmalloc(argc > 0 ? argc : 1);
 221
 222         for (i = 0; i < dir.nr; i++) {
 223                 struct dir_entry *ent = dir.entries[i];
 224                 int len, pos;
 225                 int matches = 0;
 226                 struct cache_entry *ce;
 227                 struct stat st;
 228                 const char *rel;
 229
 230                 /*
 231                  * Remove the '/' at the end that directory
 232                  * walking adds for directory entries.
 233                  */
 234                 len = ent->len;
 235                 if (len && ent->name[len-1] == '/')
 236                         len--;
 237                 pos = cache_name_pos(ent->name, len);
 238                 if (0 <= pos)
 239                         continue;       /* exact match */
 240                 pos = -pos - 1;
 241                 if (pos < active_nr) {
 242                         ce = active_cache[pos];
 243                         if (ce_namelen(ce) == len &&
 244                             !memcmp(ce->name, ent->name, len))
 245                                 continue; /* Yup, this one exists unmerged */
 246                 }
 247
 248                 if (lstat(ent->name, &st))
 249                         die_errno("Cannot lstat '%s'", ent->name);
 250
 251                 if (pathspec) {
 252                         memset(seen, 0, argc > 0 ? argc : 1);
 253                         matches = match_pathspec(pathspec, ent->name, len,
 254                                                  0, seen);
 255                 }
 256
 257                 if (S_ISDIR(st.st_mode)) {
 258                         if (remove_directories || (matches == MATCHED_EXACTLY)) {
 259                                 rel = relative_path(ent->name, prefix, &buf);
 260                                 string_list_append(&del_list, rel);
 261                         }
 262                 } else {
 263                         if (pathspec && !matches)
 264                                 continue;
 265                         rel = relative_path(ent->name, prefix, &buf);
 266                         string_list_append(&del_list, rel);
 267                 }
 268         }
 269
 270         /* TODO: do interactive git-clean here, which will modify del_list */
 271
 272         for_each_string_list_item(item, &del_list) {
 273                 struct stat st;
 274
 275                 if (prefix)
 276                         strbuf_addstr(&abs_path, prefix);
 277
 278                 strbuf_addstr(&abs_path, item->string);
 279
 280                 /*
 281                  * we might have removed this as part of earlier
 282                  * recursive directory removal, so lstat() here could
 283                  * fail with ENOENT.
 284                  */
 285                 if (lstat(abs_path.buf, &st))
 286                         continue;
 287
 288                 if (S_ISDIR(st.st_mode)) {
 289                         if (remove_dirs(&abs_path, prefix, rm_flags, dry_run, quiet, &gone))
 290                                 errors++;
 291                         if (gone && !quiet) {
 292                                 qname = quote_path_relative(item->string, NULL, &buf);
 293                                 printf(dry_run ? _(msg_would_remove) : _(msg_remove), qname);
 294                         }
 295                 } else {
 296                         res = dry_run ? 0 : unlink(abs_path.buf);
 297                         if (res) {
 298                                 qname = quote_path_relative(item->string, NULL, &buf);
 299                                 warning(_(msg_warn_remove_failed), qname);
 300                                 errors++;
 301                         } else if (!quiet) {
 302                                 qname = quote_path_relative(item->string, NULL, &buf);
 303                                 printf(dry_run ? _(msg_would_remove) : _(msg_remove), qname);
 304                         }
 305                 }
 306                 strbuf_reset(&abs_path);
 307         }
 308         free(seen);
 309
 310         strbuf_release(&abs_path);
 311         strbuf_release(&buf);
 312         string_list_clear(&del_list, 0);
 313         string_list_clear(&exclude_list, 0);
 314         return (errors != 0);
 315 }