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#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#include "column.h"
17#include "color.h"
18#include "pathspec.h"
19static int force = -1; /* unset */
21static int interactive;
22static struct string_list del_list = STRING_LIST_INIT_DUP;
23static unsigned int colopts;
24static const char *const builtin_clean_usage[] = {
26 N_("git clean [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] <paths>..."),
27 NULL
28};
29static const char *msg_remove = N_("Removing %s\n");
31static const char *msg_would_remove = N_("Would remove %s\n");
32static const char *msg_skip_git_dir = N_("Skipping repository %s\n");
33static const char *msg_would_skip_git_dir = N_("Would skip repository %s\n");
34static const char *msg_warn_remove_failed = N_("failed to remove %s");
35static int clean_use_color = -1;
37static char clean_colors[][COLOR_MAXLEN] = {
38 GIT_COLOR_RESET,
39 GIT_COLOR_NORMAL, /* PLAIN */
40 GIT_COLOR_BOLD_BLUE, /* PROMPT */
41 GIT_COLOR_BOLD, /* HEADER */
42 GIT_COLOR_BOLD_RED, /* HELP */
43 GIT_COLOR_BOLD_RED, /* ERROR */
44};
45enum color_clean {
46 CLEAN_COLOR_RESET = 0,
47 CLEAN_COLOR_PLAIN = 1,
48 CLEAN_COLOR_PROMPT = 2,
49 CLEAN_COLOR_HEADER = 3,
50 CLEAN_COLOR_HELP = 4,
51 CLEAN_COLOR_ERROR = 5
52};
53#define MENU_OPTS_SINGLETON 01
55#define MENU_OPTS_IMMEDIATE 02
56#define MENU_OPTS_LIST_ONLY 04
57struct menu_opts {
59 const char *header;
60 const char *prompt;
61 int flags;
62};
63#define MENU_RETURN_NO_LOOP 10
65struct menu_item {
67 char hotkey;
68 const char *title;
69 int selected;
70 int (*fn)(void);
71};
72enum menu_stuff_type {
74 MENU_STUFF_TYPE_STRING_LIST = 1,
75 MENU_STUFF_TYPE_MENU_ITEM
76};
77struct menu_stuff {
79 enum menu_stuff_type type;
80 int nr;
81 void *stuff;
82};
83static int parse_clean_color_slot(const char *var)
85{
86 if (!strcasecmp(var, "reset"))
87 return CLEAN_COLOR_RESET;
88 if (!strcasecmp(var, "plain"))
89 return CLEAN_COLOR_PLAIN;
90 if (!strcasecmp(var, "prompt"))
91 return CLEAN_COLOR_PROMPT;
92 if (!strcasecmp(var, "header"))
93 return CLEAN_COLOR_HEADER;
94 if (!strcasecmp(var, "help"))
95 return CLEAN_COLOR_HELP;
96 if (!strcasecmp(var, "error"))
97 return CLEAN_COLOR_ERROR;
98 return -1;
99}
100static int git_clean_config(const char *var, const char *value, void *cb)
102{
103 const char *slot_name;
104 if (starts_with(var, "column."))
106 return git_column_config(var, value, "clean", &colopts);
107 /* honors the color.interactive* config variables which also
109 applied in git-add--interactive and git-stash */
110 if (!strcmp(var, "color.interactive")) {
111 clean_use_color = git_config_colorbool(var, value);
112 return 0;
113 }
114 if (skip_prefix(var, "color.interactive.", &slot_name)) {
115 int slot = parse_clean_color_slot(slot_name);
116 if (slot < 0)
117 return 0;
118 if (!value)
119 return config_error_nonbool(var);
120 color_parse(value, var, clean_colors[slot]);
121 return 0;
122 }
123 if (!strcmp(var, "clean.requireforce")) {
125 force = !git_config_bool(var, value);
126 return 0;
127 }
128 /* inspect the color.ui config variable and others */
130 return git_color_default_config(var, value, cb);
131}
132static const char *clean_get_color(enum color_clean ix)
134{
135 if (want_color(clean_use_color))
136 return clean_colors[ix];
137 return "";
138}
139static void clean_print_color(enum color_clean ix)
141{
142 printf("%s", clean_get_color(ix));
143}
144static int exclude_cb(const struct option *opt, const char *arg, int unset)
146{
147 struct string_list *exclude_list = opt->value;
148 string_list_append(exclude_list, arg);
149 return 0;
150}
151static int remove_dirs(struct strbuf *path, const char *prefix, int force_flag,
153 int dry_run, int quiet, int *dir_gone)
154{
155 DIR *dir;
156 struct strbuf quoted = STRBUF_INIT;
157 struct dirent *e;
158 int res = 0, ret = 0, gone = 1, original_len = path->len, len;
159 unsigned char submodule_head[20];
160 struct string_list dels = STRING_LIST_INIT_DUP;
161 *dir_gone = 1;
163 if ((force_flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
165 !resolve_gitlink_ref(path->buf, "HEAD", submodule_head)) {
166 if (!quiet) {
167 quote_path_relative(path->buf, prefix, "ed);
168 printf(dry_run ? _(msg_would_skip_git_dir) : _(msg_skip_git_dir),
169 quoted.buf);
170 }
171 *dir_gone = 0;
173 return 0;
174 }
175 dir = opendir(path->buf);
177 if (!dir) {
178 /* an empty dir could be removed even if it is unreadble */
179 res = dry_run ? 0 : rmdir(path->buf);
180 if (res) {
181 quote_path_relative(path->buf, prefix, "ed);
182 warning(_(msg_warn_remove_failed), quoted.buf);
183 *dir_gone = 0;
184 }
185 return res;
186 }
187 if (path->buf[original_len - 1] != '/')
189 strbuf_addch(path, '/');
190 len = path->len;
192 while ((e = readdir(dir)) != NULL) {
193 struct stat st;
194 if (is_dot_or_dotdot(e->d_name))
195 continue;
196 strbuf_setlen(path, len);
198 strbuf_addstr(path, e->d_name);
199 if (lstat(path->buf, &st))
200 ; /* fall thru */
201 else if (S_ISDIR(st.st_mode)) {
202 if (remove_dirs(path, prefix, force_flag, dry_run, quiet, &gone))
203 ret = 1;
204 if (gone) {
205 quote_path_relative(path->buf, prefix, "ed);
206 string_list_append(&dels, quoted.buf);
207 } else
208 *dir_gone = 0;
209 continue;
210 } else {
211 res = dry_run ? 0 : unlink(path->buf);
212 if (!res) {
213 quote_path_relative(path->buf, prefix, "ed);
214 string_list_append(&dels, quoted.buf);
215 } else {
216 quote_path_relative(path->buf, prefix, "ed);
217 warning(_(msg_warn_remove_failed), quoted.buf);
218 *dir_gone = 0;
219 ret = 1;
220 }
221 continue;
222 }
223 /* path too long, stat fails, or non-directory still exists */
225 *dir_gone = 0;
226 ret = 1;
227 break;
228 }
229 closedir(dir);
230 strbuf_setlen(path, original_len);
232 if (*dir_gone) {
234 res = dry_run ? 0 : rmdir(path->buf);
235 if (!res)
236 *dir_gone = 1;
237 else {
238 quote_path_relative(path->buf, prefix, "ed);
239 warning(_(msg_warn_remove_failed), quoted.buf);
240 *dir_gone = 0;
241 ret = 1;
242 }
243 }
244 if (!*dir_gone && !quiet) {
246 int i;
247 for (i = 0; i < dels.nr; i++)
248 printf(dry_run ? _(msg_would_remove) : _(msg_remove), dels.items[i].string);
249 }
250 string_list_clear(&dels, 0);
251 return ret;
252}
253static void pretty_print_dels(void)
255{
256 struct string_list list = STRING_LIST_INIT_DUP;
257 struct string_list_item *item;
258 struct strbuf buf = STRBUF_INIT;
259 const char *qname;
260 struct column_options copts;
261 for_each_string_list_item(item, &del_list) {
263 qname = quote_path_relative(item->string, NULL, &buf);
264 string_list_append(&list, qname);
265 }
266 /*
268 * always enable column display, we only consult column.*
269 * about layout strategy and stuff
270 */
271 colopts = (colopts & ~COL_ENABLE_MASK) | COL_ENABLED;
272 memset(&copts, 0, sizeof(copts));
273 copts.indent = " ";
274 copts.padding = 2;
275 print_columns(&list, colopts, &copts);
276 strbuf_release(&buf);
277 string_list_clear(&list, 0);
278}
279static void pretty_print_menus(struct string_list *menu_list)
281{
282 unsigned int local_colopts = 0;
283 struct column_options copts;
284 local_colopts = COL_ENABLED | COL_ROW;
286 memset(&copts, 0, sizeof(copts));
287 copts.indent = " ";
288 copts.padding = 2;
289 print_columns(menu_list, local_colopts, &copts);
290}
291static void prompt_help_cmd(int singleton)
293{
294 clean_print_color(CLEAN_COLOR_HELP);
295 printf_ln(singleton ?
296 _("Prompt help:\n"
297 "1 - select a numbered item\n"
298 "foo - select item based on unique prefix\n"
299 " - (empty) select nothing") :
300 _("Prompt help:\n"
301 "1 - select a single item\n"
302 "3-5 - select a range of items\n"
303 "2-3,6-9 - select multiple ranges\n"
304 "foo - select item based on unique prefix\n"
305 "-... - unselect specified items\n"
306 "* - choose all items\n"
307 " - (empty) finish selecting"));
308 clean_print_color(CLEAN_COLOR_RESET);
309}
310/*
312 * display menu stuff with number prefix and hotkey highlight
313 */
314static void print_highlight_menu_stuff(struct menu_stuff *stuff, int **chosen)
315{
316 struct string_list menu_list = STRING_LIST_INIT_DUP;
317 struct strbuf menu = STRBUF_INIT;
318 struct strbuf buf = STRBUF_INIT;
319 struct menu_item *menu_item;
320 struct string_list_item *string_list_item;
321 int i;
322 switch (stuff->type) {
324 default:
325 die("Bad type of menu_staff when print menu");
326 case MENU_STUFF_TYPE_MENU_ITEM:
327 menu_item = (struct menu_item *)stuff->stuff;
328 for (i = 0; i < stuff->nr; i++, menu_item++) {
329 const char *p;
330 int highlighted = 0;
331 p = menu_item->title;
333 if ((*chosen)[i] < 0)
334 (*chosen)[i] = menu_item->selected ? 1 : 0;
335 strbuf_addf(&menu, "%s%2d: ", (*chosen)[i] ? "*" : " ", i+1);
336 for (; *p; p++) {
337 if (!highlighted && *p == menu_item->hotkey) {
338 strbuf_addstr(&menu, clean_get_color(CLEAN_COLOR_PROMPT));
339 strbuf_addch(&menu, *p);
340 strbuf_addstr(&menu, clean_get_color(CLEAN_COLOR_RESET));
341 highlighted = 1;
342 } else {
343 strbuf_addch(&menu, *p);
344 }
345 }
346 string_list_append(&menu_list, menu.buf);
347 strbuf_reset(&menu);
348 }
349 break;
350 case MENU_STUFF_TYPE_STRING_LIST:
351 i = 0;
352 for_each_string_list_item(string_list_item, (struct string_list *)stuff->stuff) {
353 if ((*chosen)[i] < 0)
354 (*chosen)[i] = 0;
355 strbuf_addf(&menu, "%s%2d: %s",
356 (*chosen)[i] ? "*" : " ", i+1, string_list_item->string);
357 string_list_append(&menu_list, menu.buf);
358 strbuf_reset(&menu);
359 i++;
360 }
361 break;
362 }
363 pretty_print_menus(&menu_list);
365 strbuf_release(&menu);
367 strbuf_release(&buf);
368 string_list_clear(&menu_list, 0);
369}
370static int find_unique(const char *choice, struct menu_stuff *menu_stuff)
372{
373 struct menu_item *menu_item;
374 struct string_list_item *string_list_item;
375 int i, len, found = 0;
376 len = strlen(choice);
378 switch (menu_stuff->type) {
379 default:
380 die("Bad type of menu_stuff when parse choice");
381 case MENU_STUFF_TYPE_MENU_ITEM:
382 menu_item = (struct menu_item *)menu_stuff->stuff;
384 for (i = 0; i < menu_stuff->nr; i++, menu_item++) {
385 if (len == 1 && *choice == menu_item->hotkey) {
386 found = i + 1;
387 break;
388 }
389 if (!strncasecmp(choice, menu_item->title, len)) {
390 if (found) {
391 if (len == 1) {
392 /* continue for hotkey matching */
393 found = -1;
394 } else {
395 found = 0;
396 break;
397 }
398 } else {
399 found = i + 1;
400 }
401 }
402 }
403 break;
404 case MENU_STUFF_TYPE_STRING_LIST:
405 string_list_item = ((struct string_list *)menu_stuff->stuff)->items;
406 for (i = 0; i < menu_stuff->nr; i++, string_list_item++) {
407 if (!strncasecmp(choice, string_list_item->string, len)) {
408 if (found) {
409 found = 0;
410 break;
411 }
412 found = i + 1;
413 }
414 }
415 break;
416 }
417 return found;
418}
419/*
422 * Parse user input, and return choice(s) for menu (menu_stuff).
423 *
424 * Input
425 * (for single choice)
426 * 1 - select a numbered item
427 * foo - select item based on menu title
428 * - (empty) select nothing
429 *
430 * (for multiple choice)
431 * 1 - select a single item
432 * 3-5 - select a range of items
433 * 2-3,6-9 - select multiple ranges
434 * foo - select item based on menu title
435 * -... - unselect specified items
436 * * - choose all items
437 * - (empty) finish selecting
438 *
439 * The parse result will be saved in array **chosen, and
440 * return number of total selections.
441 */
442static int parse_choice(struct menu_stuff *menu_stuff,
443 int is_single,
444 struct strbuf input,
445 int **chosen)
446{
447 struct strbuf **choice_list, **ptr;
448 int nr = 0;
449 int i;
450 if (is_single) {
452 choice_list = strbuf_split_max(&input, '\n', 0);
453 } else {
454 char *p = input.buf;
455 do {
456 if (*p == ',')
457 *p = ' ';
458 } while (*p++);
459 choice_list = strbuf_split_max(&input, ' ', 0);
460 }
461 for (ptr = choice_list; *ptr; ptr++) {
463 char *p;
464 int choose = 1;
465 int bottom = 0, top = 0;
466 int is_range, is_number;
467 strbuf_trim(*ptr);
469 if (!(*ptr)->len)
470 continue;
471 /* Input that begins with '-'; unchoose */
473 if (*(*ptr)->buf == '-') {
474 choose = 0;
475 strbuf_remove((*ptr), 0, 1);
476 }
477 is_range = 0;
479 is_number = 1;
480 for (p = (*ptr)->buf; *p; p++) {
481 if ('-' == *p) {
482 if (!is_range) {
483 is_range = 1;
484 is_number = 0;
485 } else {
486 is_number = 0;
487 is_range = 0;
488 break;
489 }
490 } else if (!isdigit(*p)) {
491 is_number = 0;
492 is_range = 0;
493 break;
494 }
495 }
496 if (is_number) {
498 bottom = atoi((*ptr)->buf);
499 top = bottom;
500 } else if (is_range) {
501 bottom = atoi((*ptr)->buf);
502 /* a range can be specified like 5-7 or 5- */
503 if (!*(strchr((*ptr)->buf, '-') + 1))
504 top = menu_stuff->nr;
505 else
506 top = atoi(strchr((*ptr)->buf, '-') + 1);
507 } else if (!strcmp((*ptr)->buf, "*")) {
508 bottom = 1;
509 top = menu_stuff->nr;
510 } else {
511 bottom = find_unique((*ptr)->buf, menu_stuff);
512 top = bottom;
513 }
514 if (top <= 0 || bottom <= 0 || top > menu_stuff->nr || bottom > top ||
516 (is_single && bottom != top)) {
517 clean_print_color(CLEAN_COLOR_ERROR);
518 printf_ln(_("Huh (%s)?"), (*ptr)->buf);
519 clean_print_color(CLEAN_COLOR_RESET);
520 continue;
521 }
522 for (i = bottom; i <= top; i++)
524 (*chosen)[i-1] = choose;
525 }
526 strbuf_list_free(choice_list);
528 for (i = 0; i < menu_stuff->nr; i++)
530 nr += (*chosen)[i];
531 return nr;
532}
533/*
535 * Implement a git-add-interactive compatible UI, which is borrowed
536 * from git-add--interactive.perl.
537 *
538 * Return value:
539 *
540 * - Return an array of integers
541 * - , and it is up to you to free the allocated memory.
542 * - The array ends with EOF.
543 * - If user pressed CTRL-D (i.e. EOF), no selection returned.
544 */
545static int *list_and_choose(struct menu_opts *opts, struct menu_stuff *stuff)
546{
547 struct strbuf choice = STRBUF_INIT;
548 int *chosen, *result;
549 int nr = 0;
550 int eof = 0;
551 int i;
552 chosen = xmalloc(sizeof(int) * stuff->nr);
554 /* set chosen as uninitialized */
555 for (i = 0; i < stuff->nr; i++)
556 chosen[i] = -1;
557 for (;;) {
559 if (opts->header) {
560 printf_ln("%s%s%s",
561 clean_get_color(CLEAN_COLOR_HEADER),
562 _(opts->header),
563 clean_get_color(CLEAN_COLOR_RESET));
564 }
565 /* chosen will be initialized by print_highlight_menu_stuff */
567 print_highlight_menu_stuff(stuff, &chosen);
568 if (opts->flags & MENU_OPTS_LIST_ONLY)
570 break;
571 if (opts->prompt) {
573 printf("%s%s%s%s",
574 clean_get_color(CLEAN_COLOR_PROMPT),
575 _(opts->prompt),
576 opts->flags & MENU_OPTS_SINGLETON ? "> " : ">> ",
577 clean_get_color(CLEAN_COLOR_RESET));
578 }
579 if (strbuf_getline(&choice, stdin, '\n') != EOF) {
581 strbuf_trim(&choice);
582 } else {
583 eof = 1;
584 break;
585 }
586 /* help for prompt */
588 if (!strcmp(choice.buf, "?")) {
589 prompt_help_cmd(opts->flags & MENU_OPTS_SINGLETON);
590 continue;
591 }
592 /* for a multiple-choice menu, press ENTER (empty) will return back */
594 if (!(opts->flags & MENU_OPTS_SINGLETON) && !choice.len)
595 break;
596 nr = parse_choice(stuff,
598 opts->flags & MENU_OPTS_SINGLETON,
599 choice,
600 &chosen);
601 if (opts->flags & MENU_OPTS_SINGLETON) {
603 if (nr)
604 break;
605 } else if (opts->flags & MENU_OPTS_IMMEDIATE) {
606 break;
607 }
608 }
609 if (eof) {
611 result = xmalloc(sizeof(int));
612 *result = EOF;
613 } else {
614 int j = 0;
615 /*
617 * recalculate nr, if return back from menu directly with
618 * default selections.
619 */
620 if (!nr) {
621 for (i = 0; i < stuff->nr; i++)
622 nr += chosen[i];
623 }
624 result = xcalloc(nr + 1, sizeof(int));
626 for (i = 0; i < stuff->nr && j < nr; i++) {
627 if (chosen[i])
628 result[j++] = i;
629 }
630 result[j] = EOF;
631 }
632 free(chosen);
634 strbuf_release(&choice);
635 return result;
636}
637static int clean_cmd(void)
639{
640 return MENU_RETURN_NO_LOOP;
641}
642static int filter_by_patterns_cmd(void)
644{
645 struct dir_struct dir;
646 struct strbuf confirm = STRBUF_INIT;
647 struct strbuf **ignore_list;
648 struct string_list_item *item;
649 struct exclude_list *el;
650 int changed = -1, i;
651 for (;;) {
653 if (!del_list.nr)
654 break;
655 if (changed)
657 pretty_print_dels();
658 clean_print_color(CLEAN_COLOR_PROMPT);
660 printf(_("Input ignore patterns>> "));
661 clean_print_color(CLEAN_COLOR_RESET);
662 if (strbuf_getline(&confirm, stdin, '\n') != EOF)
663 strbuf_trim(&confirm);
664 else
665 putchar('\n');
666 /* quit filter_by_pattern mode if press ENTER or Ctrl-D */
668 if (!confirm.len)
669 break;
670 memset(&dir, 0, sizeof(dir));
672 el = add_exclude_list(&dir, EXC_CMDL, "manual exclude");
673 ignore_list = strbuf_split_max(&confirm, ' ', 0);
674 for (i = 0; ignore_list[i]; i++) {
676 strbuf_trim(ignore_list[i]);
677 if (!ignore_list[i]->len)
678 continue;
679 add_exclude(ignore_list[i]->buf, "", 0, el, -(i+1));
681 }
682 changed = 0;
684 for_each_string_list_item(item, &del_list) {
685 int dtype = DT_UNKNOWN;
686 if (is_excluded(&dir, item->string, &dtype)) {
688 *item->string = '\0';
689 changed++;
690 }
691 }
692 if (changed) {
694 string_list_remove_empty_items(&del_list, 0);
695 } else {
696 clean_print_color(CLEAN_COLOR_ERROR);
697 printf_ln(_("WARNING: Cannot find items matched by: %s"), confirm.buf);
698 clean_print_color(CLEAN_COLOR_RESET);
699 }
700 strbuf_list_free(ignore_list);
702 clear_directory(&dir);
703 }
704 strbuf_release(&confirm);
706 return 0;
707}
708static int select_by_numbers_cmd(void)
710{
711 struct menu_opts menu_opts;
712 struct menu_stuff menu_stuff;
713 struct string_list_item *items;
714 int *chosen;
715 int i, j;
716 menu_opts.header = NULL;
718 menu_opts.prompt = N_("Select items to delete");
719 menu_opts.flags = 0;
720 menu_stuff.type = MENU_STUFF_TYPE_STRING_LIST;
722 menu_stuff.stuff = &del_list;
723 menu_stuff.nr = del_list.nr;
724 chosen = list_and_choose(&menu_opts, &menu_stuff);
726 items = del_list.items;
727 for (i = 0, j = 0; i < del_list.nr; i++) {
728 if (i < chosen[j]) {
729 *(items[i].string) = '\0';
730 } else if (i == chosen[j]) {
731 /* delete selected item */
732 j++;
733 continue;
734 } else {
735 /* end of chosen (chosen[j] == EOF), won't delete */
736 *(items[i].string) = '\0';
737 }
738 }
739 string_list_remove_empty_items(&del_list, 0);
741 free(chosen);
743 return 0;
744}
745static int ask_each_cmd(void)
747{
748 struct strbuf confirm = STRBUF_INIT;
749 struct strbuf buf = STRBUF_INIT;
750 struct string_list_item *item;
751 const char *qname;
752 int changed = 0, eof = 0;
753 for_each_string_list_item(item, &del_list) {
755 /* Ctrl-D should stop removing files */
756 if (!eof) {
757 qname = quote_path_relative(item->string, NULL, &buf);
758 printf(_("remove %s? "), qname);
759 if (strbuf_getline(&confirm, stdin, '\n') != EOF) {
760 strbuf_trim(&confirm);
761 } else {
762 putchar('\n');
763 eof = 1;
764 }
765 }
766 if (!confirm.len || strncasecmp(confirm.buf, "yes", confirm.len)) {
767 *item->string = '\0';
768 changed++;
769 }
770 }
771 if (changed)
773 string_list_remove_empty_items(&del_list, 0);
774 strbuf_release(&buf);
776 strbuf_release(&confirm);
777 return MENU_RETURN_NO_LOOP;
778}
779static int quit_cmd(void)
781{
782 string_list_clear(&del_list, 0);
783 printf_ln(_("Bye."));
784 return MENU_RETURN_NO_LOOP;
785}
786static int help_cmd(void)
788{
789 clean_print_color(CLEAN_COLOR_HELP);
790 printf_ln(_(
791 "clean - start cleaning\n"
792 "filter by pattern - exclude items from deletion\n"
793 "select by numbers - select items to be deleted by numbers\n"
794 "ask each - confirm each deletion (like \"rm -i\")\n"
795 "quit - stop cleaning\n"
796 "help - this screen\n"
797 "? - help for prompt selection"
798 ));
799 clean_print_color(CLEAN_COLOR_RESET);
800 return 0;
801}
802static void interactive_main_loop(void)
804{
805 while (del_list.nr) {
806 struct menu_opts menu_opts;
807 struct menu_stuff menu_stuff;
808 struct menu_item menus[] = {
809 {'c', "clean", 0, clean_cmd},
810 {'f', "filter by pattern", 0, filter_by_patterns_cmd},
811 {'s', "select by numbers", 0, select_by_numbers_cmd},
812 {'a', "ask each", 0, ask_each_cmd},
813 {'q', "quit", 0, quit_cmd},
814 {'h', "help", 0, help_cmd},
815 };
816 int *chosen;
817 menu_opts.header = N_("*** Commands ***");
819 menu_opts.prompt = N_("What now");
820 menu_opts.flags = MENU_OPTS_SINGLETON;
821 menu_stuff.type = MENU_STUFF_TYPE_MENU_ITEM;
823 menu_stuff.stuff = menus;
824 menu_stuff.nr = sizeof(menus) / sizeof(struct menu_item);
825 clean_print_color(CLEAN_COLOR_HEADER);
827 printf_ln(Q_("Would remove the following item:",
828 "Would remove the following items:",
829 del_list.nr));
830 clean_print_color(CLEAN_COLOR_RESET);
831 pretty_print_dels();
833 chosen = list_and_choose(&menu_opts, &menu_stuff);
835 if (*chosen != EOF) {
837 int ret;
838 ret = menus[*chosen].fn();
839 if (ret != MENU_RETURN_NO_LOOP) {
840 free(chosen);
841 chosen = NULL;
842 if (!del_list.nr) {
843 clean_print_color(CLEAN_COLOR_ERROR);
844 printf_ln(_("No more files to clean, exiting."));
845 clean_print_color(CLEAN_COLOR_RESET);
846 break;
847 }
848 continue;
849 }
850 } else {
851 quit_cmd();
852 }
853 free(chosen);
855 chosen = NULL;
856 break;
857 }
858}
859int cmd_clean(int argc, const char **argv, const char *prefix)
861{
862 int i, res;
863 int dry_run = 0, remove_directories = 0, quiet = 0, ignored = 0;
864 int ignored_only = 0, config_set = 0, errors = 0, gone = 1;
865 int rm_flags = REMOVE_DIR_KEEP_NESTED_GIT;
866 struct strbuf abs_path = STRBUF_INIT;
867 struct dir_struct dir;
868 struct pathspec pathspec;
869 struct strbuf buf = STRBUF_INIT;
870 struct string_list exclude_list = STRING_LIST_INIT_NODUP;
871 struct exclude_list *el;
872 struct string_list_item *item;
873 const char *qname;
874 struct option options[] = {
875 OPT__QUIET(&quiet, N_("do not print names of files removed")),
876 OPT__DRY_RUN(&dry_run, N_("dry run")),
877 OPT__FORCE(&force, N_("force")),
878 OPT_BOOL('i', "interactive", &interactive, N_("interactive cleaning")),
879 OPT_BOOL('d', NULL, &remove_directories,
880 N_("remove whole directories")),
881 { OPTION_CALLBACK, 'e', "exclude", &exclude_list, N_("pattern"),
882 N_("add <pattern> to ignore rules"), PARSE_OPT_NONEG, exclude_cb },
883 OPT_BOOL('x', NULL, &ignored, N_("remove ignored files, too")),
884 OPT_BOOL('X', NULL, &ignored_only,
885 N_("remove only ignored files")),
886 OPT_END()
887 };
888 git_config(git_clean_config, NULL);
890 if (force < 0)
891 force = 0;
892 else
893 config_set = 1;
894 argc = parse_options(argc, argv, prefix, options, builtin_clean_usage,
896 0);
897 memset(&dir, 0, sizeof(dir));
899 if (ignored_only)
900 dir.flags |= DIR_SHOW_IGNORED;
901 if (ignored && ignored_only)
903 die(_("-x and -X cannot be used together"));
904 if (!interactive && !dry_run && !force) {
906 if (config_set)
907 die(_("clean.requireForce set to true and neither -i, -n, nor -f given; "
908 "refusing to clean"));
909 else
910 die(_("clean.requireForce defaults to true and neither -i, -n, nor -f given;"
911 " refusing to clean"));
912 }
913 if (force > 1)
915 rm_flags = 0;
916 dir.flags |= DIR_SHOW_OTHER_DIRECTORIES;
918 if (read_cache() < 0)
920 die(_("index file corrupt"));
921 if (!ignored)
923 setup_standard_excludes(&dir);
924 el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
926 for (i = 0; i < exclude_list.nr; i++)
927 add_exclude(exclude_list.items[i].string, "", 0, el, -(i+1));
928 parse_pathspec(&pathspec, 0,
930 PATHSPEC_PREFER_CWD,
931 prefix, argv);
932 fill_directory(&dir, &pathspec);
934 for (i = 0; i < dir.nr; i++) {
936 struct dir_entry *ent = dir.entries[i];
937 int matches = 0;
938 struct stat st;
939 const char *rel;
940 if (!cache_name_is_other(ent->name, ent->len))
942 continue;
943 if (lstat(ent->name, &st))
945 die_errno("Cannot lstat '%s'", ent->name);
946 if (pathspec.nr)
948 matches = dir_path_match(ent, &pathspec, 0, NULL);
949 if (pathspec.nr && !matches)
951 continue;
952 if (S_ISDIR(st.st_mode) && !remove_directories &&
954 matches != MATCHED_EXACTLY)
955 continue;
956 rel = relative_path(ent->name, prefix, &buf);
958 string_list_append(&del_list, rel);
959 }
960 if (interactive && del_list.nr > 0)
962 interactive_main_loop();
963 for_each_string_list_item(item, &del_list) {
965 struct stat st;
966 if (prefix)
968 strbuf_addstr(&abs_path, prefix);
969 strbuf_addstr(&abs_path, item->string);
971 /*
973 * we might have removed this as part of earlier
974 * recursive directory removal, so lstat() here could
975 * fail with ENOENT.
976 */
977 if (lstat(abs_path.buf, &st))
978 continue;
979 if (S_ISDIR(st.st_mode)) {
981 if (remove_dirs(&abs_path, prefix, rm_flags, dry_run, quiet, &gone))
982 errors++;
983 if (gone && !quiet) {
984 qname = quote_path_relative(item->string, NULL, &buf);
985 printf(dry_run ? _(msg_would_remove) : _(msg_remove), qname);
986 }
987 } else {
988 res = dry_run ? 0 : unlink(abs_path.buf);
989 if (res) {
990 qname = quote_path_relative(item->string, NULL, &buf);
991 warning(_(msg_warn_remove_failed), qname);
992 errors++;
993 } else if (!quiet) {
994 qname = quote_path_relative(item->string, NULL, &buf);
995 printf(dry_run ? _(msg_would_remove) : _(msg_remove), qname);
996 }
997 }
998 strbuf_reset(&abs_path);
999 }
1000 strbuf_release(&abs_path);
1002 strbuf_release(&buf);
1003 string_list_clear(&del_list, 0);
1004 string_list_clear(&exclude_list, 0);
1005 return (errors != 0);
1006}