Merge branch 'ls/travis-coccicheck'
[git] / 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 "string-list.h"
14 #include "quote.h"
15 #include "column.h"
16 #include "color.h"
17 #include "pathspec.h"
18
19 static int force = -1; /* unset */
20 static int interactive;
21 static struct string_list del_list = STRING_LIST_INIT_DUP;
22 static unsigned int colopts;
23
24 static const char *const builtin_clean_usage[] = {
25         N_("git clean [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] <paths>..."),
26         NULL
27 };
28
29 static const char *msg_remove = N_("Removing %s\n");
30 static const char *msg_would_remove = N_("Would remove %s\n");
31 static const char *msg_skip_git_dir = N_("Skipping repository %s\n");
32 static const char *msg_would_skip_git_dir = N_("Would skip repository %s\n");
33 static const char *msg_warn_remove_failed = N_("failed to remove %s");
34
35 static int clean_use_color = -1;
36 static char clean_colors[][COLOR_MAXLEN] = {
37         GIT_COLOR_RESET,
38         GIT_COLOR_NORMAL,       /* PLAIN */
39         GIT_COLOR_BOLD_BLUE,    /* PROMPT */
40         GIT_COLOR_BOLD,         /* HEADER */
41         GIT_COLOR_BOLD_RED,     /* HELP */
42         GIT_COLOR_BOLD_RED,     /* ERROR */
43 };
44 enum color_clean {
45         CLEAN_COLOR_RESET = 0,
46         CLEAN_COLOR_PLAIN = 1,
47         CLEAN_COLOR_PROMPT = 2,
48         CLEAN_COLOR_HEADER = 3,
49         CLEAN_COLOR_HELP = 4,
50         CLEAN_COLOR_ERROR = 5
51 };
52
53 #define MENU_OPTS_SINGLETON             01
54 #define MENU_OPTS_IMMEDIATE             02
55 #define MENU_OPTS_LIST_ONLY             04
56
57 struct menu_opts {
58         const char *header;
59         const char *prompt;
60         int flags;
61 };
62
63 #define MENU_RETURN_NO_LOOP             10
64
65 struct menu_item {
66         char hotkey;
67         const char *title;
68         int selected;
69         int (*fn)(void);
70 };
71
72 enum menu_stuff_type {
73         MENU_STUFF_TYPE_STRING_LIST = 1,
74         MENU_STUFF_TYPE_MENU_ITEM
75 };
76
77 struct menu_stuff {
78         enum menu_stuff_type type;
79         int nr;
80         void *stuff;
81 };
82
83 static int parse_clean_color_slot(const char *var)
84 {
85         if (!strcasecmp(var, "reset"))
86                 return CLEAN_COLOR_RESET;
87         if (!strcasecmp(var, "plain"))
88                 return CLEAN_COLOR_PLAIN;
89         if (!strcasecmp(var, "prompt"))
90                 return CLEAN_COLOR_PROMPT;
91         if (!strcasecmp(var, "header"))
92                 return CLEAN_COLOR_HEADER;
93         if (!strcasecmp(var, "help"))
94                 return CLEAN_COLOR_HELP;
95         if (!strcasecmp(var, "error"))
96                 return CLEAN_COLOR_ERROR;
97         return -1;
98 }
99
100 static int git_clean_config(const char *var, const char *value, void *cb)
101 {
102         const char *slot_name;
103
104         if (starts_with(var, "column."))
105                 return git_column_config(var, value, "clean", &colopts);
106
107         /* honors the color.interactive* config variables which also
108            applied in git-add--interactive and git-stash */
109         if (!strcmp(var, "color.interactive")) {
110                 clean_use_color = git_config_colorbool(var, value);
111                 return 0;
112         }
113         if (skip_prefix(var, "color.interactive.", &slot_name)) {
114                 int slot = parse_clean_color_slot(slot_name);
115                 if (slot < 0)
116                         return 0;
117                 if (!value)
118                         return config_error_nonbool(var);
119                 return color_parse(value, clean_colors[slot]);
120         }
121
122         if (!strcmp(var, "clean.requireforce")) {
123                 force = !git_config_bool(var, value);
124                 return 0;
125         }
126
127         /* inspect the color.ui config variable and others */
128         return git_color_default_config(var, value, cb);
129 }
130
131 static const char *clean_get_color(enum color_clean ix)
132 {
133         if (want_color(clean_use_color))
134                 return clean_colors[ix];
135         return "";
136 }
137
138 static void clean_print_color(enum color_clean ix)
139 {
140         printf("%s", clean_get_color(ix));
141 }
142
143 static int exclude_cb(const struct option *opt, const char *arg, int unset)
144 {
145         struct string_list *exclude_list = opt->value;
146         string_list_append(exclude_list, arg);
147         return 0;
148 }
149
150 static int remove_dirs(struct strbuf *path, const char *prefix, int force_flag,
151                 int dry_run, int quiet, int *dir_gone)
152 {
153         DIR *dir;
154         struct strbuf quoted = STRBUF_INIT;
155         struct dirent *e;
156         int res = 0, ret = 0, gone = 1, original_len = path->len, len;
157         struct string_list dels = STRING_LIST_INIT_DUP;
158
159         *dir_gone = 1;
160
161         if ((force_flag & REMOVE_DIR_KEEP_NESTED_GIT) && is_nonbare_repository_dir(path)) {
162                 if (!quiet) {
163                         quote_path_relative(path->buf, prefix, &quoted);
164                         printf(dry_run ?  _(msg_would_skip_git_dir) : _(msg_skip_git_dir),
165                                         quoted.buf);
166                 }
167
168                 *dir_gone = 0;
169                 return 0;
170         }
171
172         dir = opendir(path->buf);
173         if (!dir) {
174                 /* an empty dir could be removed even if it is unreadble */
175                 res = dry_run ? 0 : rmdir(path->buf);
176                 if (res) {
177                         int saved_errno = errno;
178                         quote_path_relative(path->buf, prefix, &quoted);
179                         errno = saved_errno;
180                         warning_errno(_(msg_warn_remove_failed), quoted.buf);
181                         *dir_gone = 0;
182                 }
183                 return res;
184         }
185
186         strbuf_complete(path, '/');
187
188         len = path->len;
189         while ((e = readdir(dir)) != NULL) {
190                 struct stat st;
191                 if (is_dot_or_dotdot(e->d_name))
192                         continue;
193
194                 strbuf_setlen(path, len);
195                 strbuf_addstr(path, e->d_name);
196                 if (lstat(path->buf, &st))
197                         ; /* fall thru */
198                 else if (S_ISDIR(st.st_mode)) {
199                         if (remove_dirs(path, prefix, force_flag, dry_run, quiet, &gone))
200                                 ret = 1;
201                         if (gone) {
202                                 quote_path_relative(path->buf, prefix, &quoted);
203                                 string_list_append(&dels, quoted.buf);
204                         } else
205                                 *dir_gone = 0;
206                         continue;
207                 } else {
208                         res = dry_run ? 0 : unlink(path->buf);
209                         if (!res) {
210                                 quote_path_relative(path->buf, prefix, &quoted);
211                                 string_list_append(&dels, quoted.buf);
212                         } else {
213                                 int saved_errno = errno;
214                                 quote_path_relative(path->buf, prefix, &quoted);
215                                 errno = saved_errno;
216                                 warning_errno(_(msg_warn_remove_failed), quoted.buf);
217                                 *dir_gone = 0;
218                                 ret = 1;
219                         }
220                         continue;
221                 }
222
223                 /* path too long, stat fails, or non-directory still exists */
224                 *dir_gone = 0;
225                 ret = 1;
226                 break;
227         }
228         closedir(dir);
229
230         strbuf_setlen(path, original_len);
231
232         if (*dir_gone) {
233                 res = dry_run ? 0 : rmdir(path->buf);
234                 if (!res)
235                         *dir_gone = 1;
236                 else {
237                         int saved_errno = errno;
238                         quote_path_relative(path->buf, prefix, &quoted);
239                         errno = saved_errno;
240                         warning_errno(_(msg_warn_remove_failed), quoted.buf);
241                         *dir_gone = 0;
242                         ret = 1;
243                 }
244         }
245
246         if (!*dir_gone && !quiet) {
247                 int i;
248                 for (i = 0; i < dels.nr; i++)
249                         printf(dry_run ?  _(msg_would_remove) : _(msg_remove), dels.items[i].string);
250         }
251         string_list_clear(&dels, 0);
252         return ret;
253 }
254
255 static 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
263         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
268         /*
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 }
280
281 static void pretty_print_menus(struct string_list *menu_list)
282 {
283         unsigned int local_colopts = 0;
284         struct column_options copts;
285
286         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 }
292
293 static 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
312 /*
313  * display menu stuff with number prefix and hotkey highlight
314  */
315 static 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
323         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
332                         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
364         pretty_print_menus(&menu_list);
365
366         strbuf_release(&menu);
367         string_list_clear(&menu_list, 0);
368 }
369
370 static 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
376         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
382                 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
419
420 /*
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  */
441 static 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
450         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
461         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
467                 strbuf_trim(*ptr);
468                 if (!(*ptr)->len)
469                         continue;
470
471                 /* Input that begins with '-'; unchoose */
472                 if (*(*ptr)->buf == '-') {
473                         choose = 0;
474                         strbuf_remove((*ptr), 0, 1);
475                 }
476
477                 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
496                 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
514                 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
522                 for (i = bottom; i <= top; i++)
523                         (*chosen)[i-1] = choose;
524         }
525
526         strbuf_list_free(choice_list);
527
528         for (i = 0; i < menu_stuff->nr; i++)
529                 nr += (*chosen)[i];
530         return nr;
531 }
532
533 /*
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  */
544 static 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
552         ALLOC_ARRAY(chosen, stuff->nr);
553         /* set chosen as uninitialized */
554         for (i = 0; i < stuff->nr; i++)
555                 chosen[i] = -1;
556
557         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
565                 /* chosen will be initialized by print_highlight_menu_stuff */
566                 print_highlight_menu_stuff(stuff, &chosen);
567
568                 if (opts->flags & MENU_OPTS_LIST_ONLY)
569                         break;
570
571                 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
579                 if (strbuf_getline_lf(&choice, stdin) != EOF) {
580                         strbuf_trim(&choice);
581                 } else {
582                         eof = 1;
583                         break;
584                 }
585
586                 /* help for prompt */
587                 if (!strcmp(choice.buf, "?")) {
588                         prompt_help_cmd(opts->flags & MENU_OPTS_SINGLETON);
589                         continue;
590                 }
591
592                 /* for a multiple-choice menu, press ENTER (empty) will return back */
593                 if (!(opts->flags & MENU_OPTS_SINGLETON) && !choice.len)
594                         break;
595
596                 nr = parse_choice(stuff,
597                                   opts->flags & MENU_OPTS_SINGLETON,
598                                   choice,
599                                   &chosen);
600
601                 if (opts->flags & MENU_OPTS_SINGLETON) {
602                         if (nr)
603                                 break;
604                 } else if (opts->flags & MENU_OPTS_IMMEDIATE) {
605                         break;
606                 }
607         }
608
609         if (eof) {
610                 result = xmalloc(sizeof(int));
611                 *result = EOF;
612         } else {
613                 int j = 0;
614
615                 /*
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
624                 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
632         free(chosen);
633         strbuf_release(&choice);
634         return result;
635 }
636
637 static int clean_cmd(void)
638 {
639         return MENU_RETURN_NO_LOOP;
640 }
641
642 static 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
651         for (;;) {
652                 if (!del_list.nr)
653                         break;
654
655                 if (changed)
656                         pretty_print_dels();
657
658                 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
666                 /* quit filter_by_pattern mode if press ENTER or Ctrl-D */
667                 if (!confirm.len)
668                         break;
669
670                 memset(&dir, 0, sizeof(dir));
671                 el = add_exclude_list(&dir, EXC_CMDL, "manual exclude");
672                 ignore_list = strbuf_split_max(&confirm, ' ', 0);
673
674                 for (i = 0; ignore_list[i]; i++) {
675                         strbuf_trim(ignore_list[i]);
676                         if (!ignore_list[i]->len)
677                                 continue;
678
679                         add_exclude(ignore_list[i]->buf, "", 0, el, -(i+1));
680                 }
681
682                 changed = 0;
683                 for_each_string_list_item(item, &del_list) {
684                         int dtype = DT_UNKNOWN;
685
686                         if (is_excluded(&dir, item->string, &dtype)) {
687                                 *item->string = '\0';
688                                 changed++;
689                         }
690                 }
691
692                 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
700                 strbuf_list_free(ignore_list);
701                 clear_directory(&dir);
702         }
703
704         strbuf_release(&confirm);
705         return 0;
706 }
707
708 static 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
716         menu_opts.header = NULL;
717         menu_opts.prompt = N_("Select items to delete");
718         menu_opts.flags = 0;
719
720         menu_stuff.type = MENU_STUFF_TYPE_STRING_LIST;
721         menu_stuff.stuff = &del_list;
722         menu_stuff.nr = del_list.nr;
723
724         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
739         string_list_remove_empty_items(&del_list, 0);
740
741         free(chosen);
742         return 0;
743 }
744
745 static 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
753         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
772         if (changed)
773                 string_list_remove_empty_items(&del_list, 0);
774
775         strbuf_release(&buf);
776         strbuf_release(&confirm);
777         return MENU_RETURN_NO_LOOP;
778 }
779
780 static int quit_cmd(void)
781 {
782         string_list_clear(&del_list, 0);
783         printf(_("Bye.\n"));
784         return MENU_RETURN_NO_LOOP;
785 }
786
787 static 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 }
802
803 static 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
818                 menu_opts.header = N_("*** Commands ***");
819                 menu_opts.prompt = N_("What now");
820                 menu_opts.flags = MENU_OPTS_SINGLETON;
821
822                 menu_stuff.type = MENU_STUFF_TYPE_MENU_ITEM;
823                 menu_stuff.stuff = menus;
824                 menu_stuff.nr = sizeof(menus) / sizeof(struct menu_item);
825
826                 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
832                 pretty_print_dels();
833
834                 chosen = list_and_choose(&menu_opts, &menu_stuff);
835
836                 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
854                 free(chosen);
855                 chosen = NULL;
856                 break;
857         }
858 }
859
860 int 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
889         git_config(git_clean_config, NULL);
890         if (force < 0)
891                 force = 0;
892         else
893                 config_set = 1;
894
895         argc = parse_options(argc, argv, prefix, options, builtin_clean_usage,
896                              0);
897
898         memset(&dir, 0, sizeof(dir));
899         if (ignored_only)
900                 dir.flags |= DIR_SHOW_IGNORED;
901
902         if (ignored && ignored_only)
903                 die(_("-x and -X cannot be used together"));
904
905         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
914         if (force > 1)
915                 rm_flags = 0;
916
917         dir.flags |= DIR_SHOW_OTHER_DIRECTORIES;
918
919         if (read_cache() < 0)
920                 die(_("index file corrupt"));
921
922         if (!ignored)
923                 setup_standard_excludes(&dir);
924
925         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
929         parse_pathspec(&pathspec, 0,
930                        PATHSPEC_PREFER_CWD,
931                        prefix, argv);
932
933         fill_directory(&dir, &pathspec);
934
935         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
941                 if (!cache_name_is_other(ent->name, ent->len))
942                         continue;
943
944                 if (pathspec.nr)
945                         matches = dir_path_match(ent, &pathspec, 0, NULL);
946
947                 if (pathspec.nr && !matches)
948                         continue;
949
950                 if (lstat(ent->name, &st))
951                         die_errno("Cannot lstat '%s'", ent->name);
952
953                 if (S_ISDIR(st.st_mode) && !remove_directories &&
954                     matches != MATCHED_EXACTLY)
955                         continue;
956
957                 rel = relative_path(ent->name, prefix, &buf);
958                 string_list_append(&del_list, rel);
959         }
960
961         if (interactive && del_list.nr > 0)
962                 interactive_main_loop();
963
964         for_each_string_list_item(item, &del_list) {
965                 struct stat st;
966
967                 if (prefix)
968                         strbuf_addstr(&abs_path, prefix);
969
970                 strbuf_addstr(&abs_path, item->string);
971
972                 /*
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
980                 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                                 int saved_errno = errno;
991                                 qname = quote_path_relative(item->string, NULL, &buf);
992                                 errno = saved_errno;
993                                 warning_errno(_(msg_warn_remove_failed), qname);
994                                 errors++;
995                         } else if (!quiet) {
996                                 qname = quote_path_relative(item->string, NULL, &buf);
997                                 printf(dry_run ? _(msg_would_remove) : _(msg_remove), qname);
998                         }
999                 }
1000                 strbuf_reset(&abs_path);
1001         }
1002
1003         strbuf_release(&abs_path);
1004         strbuf_release(&buf);
1005         string_list_clear(&del_list, 0);
1006         string_list_clear(&exclude_list, 0);
1007         return (errors != 0);
1008 }