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
15static int force = -1; /* unset */
16
17static const char *const builtin_clean_usage[] = {
18 "git clean [-d] [-f] [-n] [-q] [-x | -X] [--] <paths>...",
19 NULL
20};
21
22static 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
29int 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 int rm_flags = REMOVE_DIR_KEEP_NESTED_GIT;
35 struct strbuf directory = STRBUF_INIT;
36 struct dir_struct dir;
37 static const char **pathspec;
38 struct strbuf buf = STRBUF_INIT;
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', "force", &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, prefix, options, builtin_clean_usage,
60 0);
61
62 memset(&dir, 0, sizeof(dir));
63 if (ignored_only)
64 dir.flags |= DIR_SHOW_IGNORED;
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 if (force > 1)
74 rm_flags = 0;
75
76 dir.flags |= DIR_SHOW_OTHER_DIRECTORIES;
77
78 if (read_cache() < 0)
79 die("index file corrupt");
80
81 if (!ignored)
82 setup_standard_excludes(&dir);
83
84 pathspec = get_pathspec(prefix, argv);
85
86 fill_directory(&dir, pathspec);
87
88 if (pathspec)
89 seen = xmalloc(argc > 0 ? argc : 1);
90
91 for (i = 0; i < dir.nr; i++) {
92 struct dir_entry *ent = dir.entries[i];
93 int len, pos;
94 int matches = 0;
95 struct cache_entry *ce;
96 struct stat st;
97
98 /*
99 * Remove the '/' at the end that directory
100 * walking adds for directory entries.
101 */
102 len = ent->len;
103 if (len && ent->name[len-1] == '/')
104 len--;
105 pos = cache_name_pos(ent->name, len);
106 if (0 <= pos)
107 continue; /* exact match */
108 pos = -pos - 1;
109 if (pos < active_nr) {
110 ce = active_cache[pos];
111 if (ce_namelen(ce) == len &&
112 !memcmp(ce->name, ent->name, len))
113 continue; /* Yup, this one exists unmerged */
114 }
115
116 /*
117 * we might have removed this as part of earlier
118 * recursive directory removal, so lstat() here could
119 * fail with ENOENT.
120 */
121 if (lstat(ent->name, &st))
122 continue;
123
124 if (pathspec) {
125 memset(seen, 0, argc > 0 ? argc : 1);
126 matches = match_pathspec(pathspec, ent->name, len,
127 baselen, seen);
128 }
129
130 if (S_ISDIR(st.st_mode)) {
131 strbuf_addstr(&directory, ent->name);
132 qname = quote_path_relative(directory.buf, directory.len, &buf, prefix);
133 if (show_only && (remove_directories ||
134 (matches == MATCHED_EXACTLY))) {
135 printf("Would remove %s\n", qname);
136 } else if (remove_directories ||
137 (matches == MATCHED_EXACTLY)) {
138 if (!quiet)
139 printf("Removing %s\n", qname);
140 if (remove_dir_recursively(&directory,
141 rm_flags) != 0) {
142 warning("failed to remove '%s'", qname);
143 errors++;
144 }
145 } else if (show_only) {
146 printf("Would not remove %s\n", qname);
147 } else {
148 printf("Not removing %s\n", qname);
149 }
150 strbuf_reset(&directory);
151 } else {
152 if (pathspec && !matches)
153 continue;
154 qname = quote_path_relative(ent->name, -1, &buf, prefix);
155 if (show_only) {
156 printf("Would remove %s\n", qname);
157 continue;
158 } else if (!quiet) {
159 printf("Removing %s\n", qname);
160 }
161 if (unlink(ent->name) != 0) {
162 warning("failed to remove '%s'", qname);
163 errors++;
164 }
165 }
166 }
167 free(seen);
168
169 strbuf_release(&directory);
170 return (errors != 0);
171}