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