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 "config.h"
12#include "dir.h"
13#include "parse-options.h"
14#include "string-list.h"
15#include "quote.h"
16#include "column.h"
17#include "color.h"
18#include "pathspec.h"
19#include "help.h"
20static int force = -1; /* unset */
22static int interactive;
23static struct string_list del_list = STRING_LIST_INIT_DUP;
24static unsigned int colopts;
25static const char *const builtin_clean_usage[] = {
27 N_("git clean [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] <paths>..."),
28 NULL
29};
30static const char *msg_remove = N_("Removing %s\n");
32static const char *msg_would_remove = N_("Would remove %s\n");
33static const char *msg_skip_git_dir = N_("Skipping repository %s\n");
34static const char *msg_would_skip_git_dir = N_("Would skip repository %s\n");
35static const char *msg_warn_remove_failed = N_("failed to remove %s");
36enum color_clean {
38 CLEAN_COLOR_RESET = 0,
39 CLEAN_COLOR_PLAIN = 1,
40 CLEAN_COLOR_PROMPT = 2,
41 CLEAN_COLOR_HEADER = 3,
42 CLEAN_COLOR_HELP = 4,
43 CLEAN_COLOR_ERROR = 5
44};
45static const char *color_interactive_slots[] = {
47 [CLEAN_COLOR_ERROR] = "error",
48 [CLEAN_COLOR_HEADER] = "header",
49 [CLEAN_COLOR_HELP] = "help",
50 [CLEAN_COLOR_PLAIN] = "plain",
51 [CLEAN_COLOR_PROMPT] = "prompt",
52 [CLEAN_COLOR_RESET] = "reset",
53};
54static int clean_use_color = -1;
56static char clean_colors[][COLOR_MAXLEN] = {
57 [CLEAN_COLOR_ERROR] = GIT_COLOR_BOLD_RED,
58 [CLEAN_COLOR_HEADER] = GIT_COLOR_BOLD,
59 [CLEAN_COLOR_HELP] = GIT_COLOR_BOLD_RED,
60 [CLEAN_COLOR_PLAIN] = GIT_COLOR_NORMAL,
61 [CLEAN_COLOR_PROMPT] = GIT_COLOR_BOLD_BLUE,
62 [CLEAN_COLOR_RESET] = GIT_COLOR_RESET,
63};
64#define MENU_OPTS_SINGLETON 01
66#define MENU_OPTS_IMMEDIATE 02
67#define MENU_OPTS_LIST_ONLY 04
68struct menu_opts {
70 const char *header;
71 const char *prompt;
72 int flags;
73};
74#define MENU_RETURN_NO_LOOP 10
76struct menu_item {
78 char hotkey;
79 const char *title;
80 int selected;
81 int (*fn)(void);
82};
83enum menu_stuff_type {
85 MENU_STUFF_TYPE_STRING_LIST = 1,
86 MENU_STUFF_TYPE_MENU_ITEM
87};
88struct menu_stuff {
90 enum menu_stuff_type type;
91 int nr;
92 void *stuff;
93};
94define_list_config_array(color_interactive_slots);
96static int git_clean_config(const char *var, const char *value, void *cb)
98{
99 const char *slot_name;
100 if (starts_with(var, "column."))
102 return git_column_config(var, value, "clean", &colopts);
103 /* honors the color.interactive* config variables which also
105 applied in git-add--interactive and git-stash */
106 if (!strcmp(var, "color.interactive")) {
107 clean_use_color = git_config_colorbool(var, value);
108 return 0;
109 }
110 if (skip_prefix(var, "color.interactive.", &slot_name)) {
111 int slot = LOOKUP_CONFIG(color_interactive_slots, slot_name);
112 if (slot < 0)
113 return 0;
114 if (!value)
115 return config_error_nonbool(var);
116 return color_parse(value, clean_colors[slot]);
117 }
118 if (!strcmp(var, "clean.requireforce")) {
120 force = !git_config_bool(var, value);
121 return 0;
122 }
123 /* inspect the color.ui config variable and others */
125 return git_color_default_config(var, value, cb);
126}
127static const char *clean_get_color(enum color_clean ix)
129{
130 if (want_color(clean_use_color))
131 return clean_colors[ix];
132 return "";
133}
134static void clean_print_color(enum color_clean ix)
136{
137 printf("%s", clean_get_color(ix));
138}
139static int exclude_cb(const struct option *opt, const char *arg, int unset)
141{
142 struct string_list *exclude_list = opt->value;
143 string_list_append(exclude_list, arg);
144 return 0;
145}
146static int remove_dirs(struct strbuf *path, const char *prefix, int force_flag,
148 int dry_run, int quiet, int *dir_gone)
149{
150 DIR *dir;
151 struct strbuf quoted = STRBUF_INIT;
152 struct dirent *e;
153 int res = 0, ret = 0, gone = 1, original_len = path->len, len;
154 struct string_list dels = STRING_LIST_INIT_DUP;
155 *dir_gone = 1;
157 if ((force_flag & REMOVE_DIR_KEEP_NESTED_GIT) && is_nonbare_repository_dir(path)) {
159 if (!quiet) {
160 quote_path_relative(path->buf, prefix, "ed);
161 printf(dry_run ? _(msg_would_skip_git_dir) : _(msg_skip_git_dir),
162 quoted.buf);
163 }
164 *dir_gone = 0;
166 goto out;
167 }
168 dir = opendir(path->buf);
170 if (!dir) {
171 /* an empty dir could be removed even if it is unreadble */
172 res = dry_run ? 0 : rmdir(path->buf);
173 if (res) {
174 int saved_errno = errno;
175 quote_path_relative(path->buf, prefix, "ed);
176 errno = saved_errno;
177 warning_errno(_(msg_warn_remove_failed), quoted.buf);
178 *dir_gone = 0;
179 }
180 ret = res;
181 goto out;
182 }
183 strbuf_complete(path, '/');
185 len = path->len;
187 while ((e = readdir(dir)) != NULL) {
188 struct stat st;
189 if (is_dot_or_dotdot(e->d_name))
190 continue;
191 strbuf_setlen(path, len);
193 strbuf_addstr(path, e->d_name);
194 if (lstat(path->buf, &st))
195 ; /* fall thru */
196 else if (S_ISDIR(st.st_mode)) {
197 if (remove_dirs(path, prefix, force_flag, dry_run, quiet, &gone))
198 ret = 1;
199 if (gone) {
200 quote_path_relative(path->buf, prefix, "ed);
201 string_list_append(&dels, quoted.buf);
202 } else
203 *dir_gone = 0;
204 continue;
205 } else {
206 res = dry_run ? 0 : unlink(path->buf);
207 if (!res) {
208 quote_path_relative(path->buf, prefix, "ed);
209 string_list_append(&dels, quoted.buf);
210 } else {
211 int saved_errno = errno;
212 quote_path_relative(path->buf, prefix, "ed);
213 errno = saved_errno;
214 warning_errno(_(msg_warn_remove_failed), quoted.buf);
215 *dir_gone = 0;
216 ret = 1;
217 }
218 continue;
219 }
220 /* path too long, stat fails, or non-directory still exists */
222 *dir_gone = 0;
223 ret = 1;
224 break;
225 }
226 closedir(dir);
227 strbuf_setlen(path, original_len);
229 if (*dir_gone) {
231 res = dry_run ? 0 : rmdir(path->buf);
232 if (!res)
233 *dir_gone = 1;
234 else {
235 int saved_errno = errno;
236 quote_path_relative(path->buf, prefix, "ed);
237 errno = saved_errno;
238 warning_errno(_(msg_warn_remove_failed), quoted.buf);
239 *dir_gone = 0;
240 ret = 1;
241 }
242 }
243 if (!*dir_gone && !quiet) {
245 int i;
246 for (i = 0; i < dels.nr; i++)
247 printf(dry_run ? _(msg_would_remove) : _(msg_remove), dels.items[i].string);
248 }
249out:
250 strbuf_release("ed);
251 string_list_clear(&dels, 0);
252 return ret;
253}
254static void pretty_print_dels(void)
256{
257 struct string_list list = STRING_LIST_INIT_DUP;
258 struct string_list_item *item;
259 struct strbuf buf = STRBUF_INIT;
260 const char *qname;
261 struct column_options copts;
262 for_each_string_list_item(item, &del_list) {
264 qname = quote_path_relative(item->string, NULL, &buf);
265 string_list_append(&list, qname);
266 }
267 /*
269 * always enable column display, we only consult column.*
270 * about layout strategy and stuff
271 */
272 colopts = (colopts & ~COL_ENABLE_MASK) | COL_ENABLED;
273 memset(&copts, 0, sizeof(copts));
274 copts.indent = " ";
275 copts.padding = 2;
276 print_columns(&list, colopts, &copts);
277 strbuf_release(&buf);
278 string_list_clear(&list, 0);
279}
280static void pretty_print_menus(struct string_list *menu_list)
282{
283 unsigned int local_colopts = 0;
284 struct column_options copts;
285 local_colopts = COL_ENABLED | COL_ROW;
287 memset(&copts, 0, sizeof(copts));
288 copts.indent = " ";
289 copts.padding = 2;
290 print_columns(menu_list, local_colopts, &copts);
291}
292static void prompt_help_cmd(int singleton)
294{
295 clean_print_color(CLEAN_COLOR_HELP);
296 printf(singleton ?
297 _("Prompt help:\n"
298 "1 - select a numbered item\n"
299 "foo - select item based on unique prefix\n"
300 " - (empty) select nothing\n") :
301 _("Prompt help:\n"
302 "1 - select a single item\n"
303 "3-5 - select a range of items\n"
304 "2-3,6-9 - select multiple ranges\n"
305 "foo - select item based on unique prefix\n"
306 "-... - unselect specified items\n"
307 "* - choose all items\n"
308 " - (empty) finish selecting\n"));
309 clean_print_color(CLEAN_COLOR_RESET);
310}
311/*
313 * display menu stuff with number prefix and hotkey highlight
314 */
315static void print_highlight_menu_stuff(struct menu_stuff *stuff, int **chosen)
316{
317 struct string_list menu_list = STRING_LIST_INIT_DUP;
318 struct strbuf menu = 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_stuff 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 string_list_clear(&menu_list, 0);
368}
369static int find_unique(const char *choice, struct menu_stuff *menu_stuff)
371{
372 struct menu_item *menu_item;
373 struct string_list_item *string_list_item;
374 int i, len, found = 0;
375 len = strlen(choice);
377 switch (menu_stuff->type) {
378 default:
379 die("Bad type of menu_stuff when parse choice");
380 case MENU_STUFF_TYPE_MENU_ITEM:
381 menu_item = (struct menu_item *)menu_stuff->stuff;
383 for (i = 0; i < menu_stuff->nr; i++, menu_item++) {
384 if (len == 1 && *choice == menu_item->hotkey) {
385 found = i + 1;
386 break;
387 }
388 if (!strncasecmp(choice, menu_item->title, len)) {
389 if (found) {
390 if (len == 1) {
391 /* continue for hotkey matching */
392 found = -1;
393 } else {
394 found = 0;
395 break;
396 }
397 } else {
398 found = i + 1;
399 }
400 }
401 }
402 break;
403 case MENU_STUFF_TYPE_STRING_LIST:
404 string_list_item = ((struct string_list *)menu_stuff->stuff)->items;
405 for (i = 0; i < menu_stuff->nr; i++, string_list_item++) {
406 if (!strncasecmp(choice, string_list_item->string, len)) {
407 if (found) {
408 found = 0;
409 break;
410 }
411 found = i + 1;
412 }
413 }
414 break;
415 }
416 return found;
417}
418/*
421 * Parse user input, and return choice(s) for menu (menu_stuff).
422 *
423 * Input
424 * (for single choice)
425 * 1 - select a numbered item
426 * foo - select item based on menu title
427 * - (empty) select nothing
428 *
429 * (for multiple choice)
430 * 1 - select a single item
431 * 3-5 - select a range of items
432 * 2-3,6-9 - select multiple ranges
433 * foo - select item based on menu title
434 * -... - unselect specified items
435 * * - choose all items
436 * - (empty) finish selecting
437 *
438 * The parse result will be saved in array **chosen, and
439 * return number of total selections.
440 */
441static int parse_choice(struct menu_stuff *menu_stuff,
442 int is_single,
443 struct strbuf input,
444 int **chosen)
445{
446 struct strbuf **choice_list, **ptr;
447 int nr = 0;
448 int i;
449 if (is_single) {
451 choice_list = strbuf_split_max(&input, '\n', 0);
452 } else {
453 char *p = input.buf;
454 do {
455 if (*p == ',')
456 *p = ' ';
457 } while (*p++);
458 choice_list = strbuf_split_max(&input, ' ', 0);
459 }
460 for (ptr = choice_list; *ptr; ptr++) {
462 char *p;
463 int choose = 1;
464 int bottom = 0, top = 0;
465 int is_range, is_number;
466 strbuf_trim(*ptr);
468 if (!(*ptr)->len)
469 continue;
470 /* Input that begins with '-'; unchoose */
472 if (*(*ptr)->buf == '-') {
473 choose = 0;
474 strbuf_remove((*ptr), 0, 1);
475 }
476 is_range = 0;
478 is_number = 1;
479 for (p = (*ptr)->buf; *p; p++) {
480 if ('-' == *p) {
481 if (!is_range) {
482 is_range = 1;
483 is_number = 0;
484 } else {
485 is_number = 0;
486 is_range = 0;
487 break;
488 }
489 } else if (!isdigit(*p)) {
490 is_number = 0;
491 is_range = 0;
492 break;
493 }
494 }
495 if (is_number) {
497 bottom = atoi((*ptr)->buf);
498 top = bottom;
499 } else if (is_range) {
500 bottom = atoi((*ptr)->buf);
501 /* a range can be specified like 5-7 or 5- */
502 if (!*(strchr((*ptr)->buf, '-') + 1))
503 top = menu_stuff->nr;
504 else
505 top = atoi(strchr((*ptr)->buf, '-') + 1);
506 } else if (!strcmp((*ptr)->buf, "*")) {
507 bottom = 1;
508 top = menu_stuff->nr;
509 } else {
510 bottom = find_unique((*ptr)->buf, menu_stuff);
511 top = bottom;
512 }
513 if (top <= 0 || bottom <= 0 || top > menu_stuff->nr || bottom > top ||
515 (is_single && bottom != top)) {
516 clean_print_color(CLEAN_COLOR_ERROR);
517 printf(_("Huh (%s)?\n"), (*ptr)->buf);
518 clean_print_color(CLEAN_COLOR_RESET);
519 continue;
520 }
521 for (i = bottom; i <= top; i++)
523 (*chosen)[i-1] = choose;
524 }
525 strbuf_list_free(choice_list);
527 for (i = 0; i < menu_stuff->nr; i++)
529 nr += (*chosen)[i];
530 return nr;
531}
532/*
534 * Implement a git-add-interactive compatible UI, which is borrowed
535 * from git-add--interactive.perl.
536 *
537 * Return value:
538 *
539 * - Return an array of integers
540 * - , and it is up to you to free the allocated memory.
541 * - The array ends with EOF.
542 * - If user pressed CTRL-D (i.e. EOF), no selection returned.
543 */
544static int *list_and_choose(struct menu_opts *opts, struct menu_stuff *stuff)
545{
546 struct strbuf choice = STRBUF_INIT;
547 int *chosen, *result;
548 int nr = 0;
549 int eof = 0;
550 int i;
551 ALLOC_ARRAY(chosen, stuff->nr);
553 /* set chosen as uninitialized */
554 for (i = 0; i < stuff->nr; i++)
555 chosen[i] = -1;
556 for (;;) {
558 if (opts->header) {
559 printf_ln("%s%s%s",
560 clean_get_color(CLEAN_COLOR_HEADER),
561 _(opts->header),
562 clean_get_color(CLEAN_COLOR_RESET));
563 }
564 /* chosen will be initialized by print_highlight_menu_stuff */
566 print_highlight_menu_stuff(stuff, &chosen);
567 if (opts->flags & MENU_OPTS_LIST_ONLY)
569 break;
570 if (opts->prompt) {
572 printf("%s%s%s%s",
573 clean_get_color(CLEAN_COLOR_PROMPT),
574 _(opts->prompt),
575 opts->flags & MENU_OPTS_SINGLETON ? "> " : ">> ",
576 clean_get_color(CLEAN_COLOR_RESET));
577 }
578 if (strbuf_getline_lf(&choice, stdin) != EOF) {
580 strbuf_trim(&choice);
581 } else {
582 eof = 1;
583 break;
584 }
585 /* help for prompt */
587 if (!strcmp(choice.buf, "?")) {
588 prompt_help_cmd(opts->flags & MENU_OPTS_SINGLETON);
589 continue;
590 }
591 /* for a multiple-choice menu, press ENTER (empty) will return back */
593 if (!(opts->flags & MENU_OPTS_SINGLETON) && !choice.len)
594 break;
595 nr = parse_choice(stuff,
597 opts->flags & MENU_OPTS_SINGLETON,
598 choice,
599 &chosen);
600 if (opts->flags & MENU_OPTS_SINGLETON) {
602 if (nr)
603 break;
604 } else if (opts->flags & MENU_OPTS_IMMEDIATE) {
605 break;
606 }
607 }
608 if (eof) {
610 result = xmalloc(sizeof(int));
611 *result = EOF;
612 } else {
613 int j = 0;
614 /*
616 * recalculate nr, if return back from menu directly with
617 * default selections.
618 */
619 if (!nr) {
620 for (i = 0; i < stuff->nr; i++)
621 nr += chosen[i];
622 }
623 result = xcalloc(st_add(nr, 1), sizeof(int));
625 for (i = 0; i < stuff->nr && j < nr; i++) {
626 if (chosen[i])
627 result[j++] = i;
628 }
629 result[j] = EOF;
630 }
631 free(chosen);
633 strbuf_release(&choice);
634 return result;
635}
636static int clean_cmd(void)
638{
639 return MENU_RETURN_NO_LOOP;
640}
641static int filter_by_patterns_cmd(void)
643{
644 struct dir_struct dir;
645 struct strbuf confirm = STRBUF_INIT;
646 struct strbuf **ignore_list;
647 struct string_list_item *item;
648 struct exclude_list *el;
649 int changed = -1, i;
650 for (;;) {
652 if (!del_list.nr)
653 break;
654 if (changed)
656 pretty_print_dels();
657 clean_print_color(CLEAN_COLOR_PROMPT);
659 printf(_("Input ignore patterns>> "));
660 clean_print_color(CLEAN_COLOR_RESET);
661 if (strbuf_getline_lf(&confirm, stdin) != EOF)
662 strbuf_trim(&confirm);
663 else
664 putchar('\n');
665 /* quit filter_by_pattern mode if press ENTER or Ctrl-D */
667 if (!confirm.len)
668 break;
669 memset(&dir, 0, sizeof(dir));
671 el = add_exclude_list(&dir, EXC_CMDL, "manual exclude");
672 ignore_list = strbuf_split_max(&confirm, ' ', 0);
673 for (i = 0; ignore_list[i]; i++) {
675 strbuf_trim(ignore_list[i]);
676 if (!ignore_list[i]->len)
677 continue;
678 add_exclude(ignore_list[i]->buf, "", 0, el, -(i+1));
680 }
681 changed = 0;
683 for_each_string_list_item(item, &del_list) {
684 int dtype = DT_UNKNOWN;
685 if (is_excluded(&dir, &the_index, item->string, &dtype)) {
687 *item->string = '\0';
688 changed++;
689 }
690 }
691 if (changed) {
693 string_list_remove_empty_items(&del_list, 0);
694 } else {
695 clean_print_color(CLEAN_COLOR_ERROR);
696 printf_ln(_("WARNING: Cannot find items matched by: %s"), confirm.buf);
697 clean_print_color(CLEAN_COLOR_RESET);
698 }
699 strbuf_list_free(ignore_list);
701 clear_directory(&dir);
702 }
703 strbuf_release(&confirm);
705 return 0;
706}
707static int select_by_numbers_cmd(void)
709{
710 struct menu_opts menu_opts;
711 struct menu_stuff menu_stuff;
712 struct string_list_item *items;
713 int *chosen;
714 int i, j;
715 menu_opts.header = NULL;
717 menu_opts.prompt = N_("Select items to delete");
718 menu_opts.flags = 0;
719 menu_stuff.type = MENU_STUFF_TYPE_STRING_LIST;
721 menu_stuff.stuff = &del_list;
722 menu_stuff.nr = del_list.nr;
723 chosen = list_and_choose(&menu_opts, &menu_stuff);
725 items = del_list.items;
726 for (i = 0, j = 0; i < del_list.nr; i++) {
727 if (i < chosen[j]) {
728 *(items[i].string) = '\0';
729 } else if (i == chosen[j]) {
730 /* delete selected item */
731 j++;
732 continue;
733 } else {
734 /* end of chosen (chosen[j] == EOF), won't delete */
735 *(items[i].string) = '\0';
736 }
737 }
738 string_list_remove_empty_items(&del_list, 0);
740 free(chosen);
742 return 0;
743}
744static int ask_each_cmd(void)
746{
747 struct strbuf confirm = STRBUF_INIT;
748 struct strbuf buf = STRBUF_INIT;
749 struct string_list_item *item;
750 const char *qname;
751 int changed = 0, eof = 0;
752 for_each_string_list_item(item, &del_list) {
754 /* Ctrl-D should stop removing files */
755 if (!eof) {
756 qname = quote_path_relative(item->string, NULL, &buf);
757 /* TRANSLATORS: Make sure to keep [y/N] as is */
758 printf(_("Remove %s [y/N]? "), qname);
759 if (strbuf_getline_lf(&confirm, stdin) != 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(_("Bye.\n"));
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_AND_NULL(chosen);
841 if (!del_list.nr) {
842 clean_print_color(CLEAN_COLOR_ERROR);
843 printf_ln(_("No more files to clean, exiting."));
844 clean_print_color(CLEAN_COLOR_RESET);
845 break;
846 }
847 continue;
848 }
849 } else {
850 quit_cmd();
851 }
852 FREE_AND_NULL(chosen);
854 break;
855 }
856}
857static void correct_untracked_entries(struct dir_struct *dir)
859{
860 int src, dst, ign;
861 for (src = dst = ign = 0; src < dir->nr; src++) {
863 /* skip paths in ignored[] that cannot be inside entries[src] */
864 while (ign < dir->ignored_nr &&
865 0 <= cmp_dir_entry(&dir->entries[src], &dir->ignored[ign]))
866 ign++;
867 if (ign < dir->ignored_nr &&
869 check_dir_entry_contains(dir->entries[src], dir->ignored[ign])) {
870 /* entries[src] contains an ignored path, so we drop it */
871 free(dir->entries[src]);
872 } else {
873 struct dir_entry *ent = dir->entries[src++];
874 /* entries[src] does not contain an ignored path, so we keep it */
876 dir->entries[dst++] = ent;
877 /* then discard paths in entries[] contained inside entries[src] */
879 while (src < dir->nr &&
880 check_dir_entry_contains(ent, dir->entries[src]))
881 free(dir->entries[src++]);
882 /* compensate for the outer loop's loop control */
884 src--;
885 }
886 }
887 dir->nr = dst;
888}
889int cmd_clean(int argc, const char **argv, const char *prefix)
891{
892 int i, res;
893 int dry_run = 0, remove_directories = 0, quiet = 0, ignored = 0;
894 int ignored_only = 0, config_set = 0, errors = 0, gone = 1;
895 int rm_flags = REMOVE_DIR_KEEP_NESTED_GIT;
896 struct strbuf abs_path = STRBUF_INIT;
897 struct dir_struct dir;
898 struct pathspec pathspec;
899 struct strbuf buf = STRBUF_INIT;
900 struct string_list exclude_list = STRING_LIST_INIT_NODUP;
901 struct exclude_list *el;
902 struct string_list_item *item;
903 const char *qname;
904 struct option options[] = {
905 OPT__QUIET(&quiet, N_("do not print names of files removed")),
906 OPT__DRY_RUN(&dry_run, N_("dry run")),
907 OPT__FORCE(&force, N_("force"), PARSE_OPT_NOCOMPLETE),
908 OPT_BOOL('i', "interactive", &interactive, N_("interactive cleaning")),
909 OPT_BOOL('d', NULL, &remove_directories,
910 N_("remove whole directories")),
911 { OPTION_CALLBACK, 'e', "exclude", &exclude_list, N_("pattern"),
912 N_("add <pattern> to ignore rules"), PARSE_OPT_NONEG, exclude_cb },
913 OPT_BOOL('x', NULL, &ignored, N_("remove ignored files, too")),
914 OPT_BOOL('X', NULL, &ignored_only,
915 N_("remove only ignored files")),
916 OPT_END()
917 };
918 git_config(git_clean_config, NULL);
920 if (force < 0)
921 force = 0;
922 else
923 config_set = 1;
924 argc = parse_options(argc, argv, prefix, options, builtin_clean_usage,
926 0);
927 memset(&dir, 0, sizeof(dir));
929 if (ignored_only)
930 dir.flags |= DIR_SHOW_IGNORED;
931 if (ignored && ignored_only)
933 die(_("-x and -X cannot be used together"));
934 if (!interactive && !dry_run && !force) {
936 if (config_set)
937 die(_("clean.requireForce set to true and neither -i, -n, nor -f given; "
938 "refusing to clean"));
939 else
940 die(_("clean.requireForce defaults to true and neither -i, -n, nor -f given;"
941 " refusing to clean"));
942 }
943 if (force > 1)
945 rm_flags = 0;
946 dir.flags |= DIR_SHOW_OTHER_DIRECTORIES;
948 if (remove_directories)
950 dir.flags |= DIR_SHOW_IGNORED_TOO | DIR_KEEP_UNTRACKED_CONTENTS;
951 if (read_cache() < 0)
953 die(_("index file corrupt"));
954 if (!ignored)
956 setup_standard_excludes(&dir);
957 el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
959 for (i = 0; i < exclude_list.nr; i++)
960 add_exclude(exclude_list.items[i].string, "", 0, el, -(i+1));
961 parse_pathspec(&pathspec, 0,
963 PATHSPEC_PREFER_CWD,
964 prefix, argv);
965 fill_directory(&dir, &the_index, &pathspec);
967 correct_untracked_entries(&dir);
968 for (i = 0; i < dir.nr; i++) {
970 struct dir_entry *ent = dir.entries[i];
971 int matches = 0;
972 struct stat st;
973 const char *rel;
974 if (!cache_name_is_other(ent->name, ent->len))
976 continue;
977 if (pathspec.nr)
979 matches = dir_path_match(&the_index, ent, &pathspec, 0, NULL);
980 if (pathspec.nr && !matches)
982 continue;
983 if (lstat(ent->name, &st))
985 die_errno("Cannot lstat '%s'", ent->name);
986 if (S_ISDIR(st.st_mode) && !remove_directories &&
988 matches != MATCHED_EXACTLY)
989 continue;
990 rel = relative_path(ent->name, prefix, &buf);
992 string_list_append(&del_list, rel);
993 }
994 for (i = 0; i < dir.nr; i++)
996 free(dir.entries[i]);
997 for (i = 0; i < dir.ignored_nr; i++)
999 free(dir.ignored[i]);
1000 if (interactive && del_list.nr > 0)
1002 interactive_main_loop();
1003 for_each_string_list_item(item, &del_list) {
1005 struct stat st;
1006 if (prefix)
1008 strbuf_addstr(&abs_path, prefix);
1009 strbuf_addstr(&abs_path, item->string);
1011 /*
1013 * we might have removed this as part of earlier
1014 * recursive directory removal, so lstat() here could
1015 * fail with ENOENT.
1016 */
1017 if (lstat(abs_path.buf, &st))
1018 continue;
1019 if (S_ISDIR(st.st_mode)) {
1021 if (remove_dirs(&abs_path, prefix, rm_flags, dry_run, quiet, &gone))
1022 errors++;
1023 if (gone && !quiet) {
1024 qname = quote_path_relative(item->string, NULL, &buf);
1025 printf(dry_run ? _(msg_would_remove) : _(msg_remove), qname);
1026 }
1027 } else {
1028 res = dry_run ? 0 : unlink(abs_path.buf);
1029 if (res) {
1030 int saved_errno = errno;
1031 qname = quote_path_relative(item->string, NULL, &buf);
1032 errno = saved_errno;
1033 warning_errno(_(msg_warn_remove_failed), qname);
1034 errors++;
1035 } else if (!quiet) {
1036 qname = quote_path_relative(item->string, NULL, &buf);
1037 printf(dry_run ? _(msg_would_remove) : _(msg_remove), qname);
1038 }
1039 }
1040 strbuf_reset(&abs_path);
1041 }
1042 strbuf_release(&abs_path);
1044 strbuf_release(&buf);
1045 string_list_clear(&del_list, 0);
1046 string_list_clear(&exclude_list, 0);
1047 return (errors != 0);
1048}