git.oblomov.eu Git - git/blob - 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 "refs.h"
  14 #include "string-list.h"
  15 #include "quote.h"
  16 #include "column.h"
  17 #include "color.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)();
  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         if (!prefixcmp(var, "column."))
 103                 return git_column_config(var, value, "clean", &colopts);
 104
 105         /* honors the color.interactive* config variables which also
 106            applied in git-add--interactive and git-stash */
 107         if (!strcmp(var, "color.interactive")) {
 108                 clean_use_color = git_config_colorbool(var, value);
 109                 return 0;
 110         }
 111         if (!prefixcmp(var, "color.interactive.")) {
 112                 int slot = parse_clean_color_slot(var +
 113                                                   strlen("color.interactive."));
 114                 if (slot < 0)
 115                         return 0;
 116                 if (!value)
 117                         return config_error_nonbool(var);
 118                 color_parse(value, var, clean_colors[slot]);
 119                 return 0;
 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, i;
 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                 for (i = 0; i < dels.nr; i++)
 245                         printf(dry_run ?  _(msg_would_remove) : _(msg_remove), dels.items[i].string);
 246         }
 247         string_list_clear(&dels, 0);
 248         return ret;
 249 }
 250
 251 static void pretty_print_dels(void)
 252 {
 253         struct string_list list = STRING_LIST_INIT_DUP;
 254         struct string_list_item *item;
 255         struct strbuf buf = STRBUF_INIT;
 256         const char *qname;
 257         struct column_options copts;
 258
 259         for_each_string_list_item(item, &del_list) {
 260                 qname = quote_path_relative(item->string, NULL, &buf);
 261                 string_list_append(&list, qname);
 262         }
 263
 264         /*
 265          * always enable column display, we only consult column.*
 266          * about layout strategy and stuff
 267          */
 268         colopts = (colopts & ~COL_ENABLE_MASK) | COL_ENABLED;
 269         memset(&copts, 0, sizeof(copts));
 270         copts.indent = "  ";
 271         copts.padding = 2;
 272         print_columns(&list, colopts, &copts);
 273         strbuf_release(&buf);
 274         string_list_clear(&list, 0);
 275 }
 276
 277 static void pretty_print_menus(struct string_list *menu_list)
 278 {
 279         unsigned int local_colopts = 0;
 280         struct column_options copts;
 281
 282         local_colopts = COL_ENABLED | COL_ROW;
 283         memset(&copts, 0, sizeof(copts));
 284         copts.indent = "  ";
 285         copts.padding = 2;
 286         print_columns(menu_list, local_colopts, &copts);
 287 }
 288
 289 static void prompt_help_cmd(int singleton)
 290 {
 291         clean_print_color(CLEAN_COLOR_HELP);
 292         printf_ln(singleton ?
 293                   _("Prompt help:\n"
 294                     "1          - select a numbered item\n"
 295                     "foo        - select item based on unique prefix\n"
 296                     "           - (empty) select nothing") :
 297                   _("Prompt help:\n"
 298                     "1          - select a single item\n"
 299                     "3-5        - select a range of items\n"
 300                     "2-3,6-9    - select multiple ranges\n"
 301                     "foo        - select item based on unique prefix\n"
 302                     "-...       - unselect specified items\n"
 303                     "*          - choose all items\n"
 304                     "           - (empty) finish selecting"));
 305         clean_print_color(CLEAN_COLOR_RESET);
 306 }
 307
 308 /*
 309  * display menu stuff with number prefix and hotkey highlight
 310  */
 311 static void print_highlight_menu_stuff(struct menu_stuff *stuff, int **chosen)
 312 {
 313         struct string_list menu_list = STRING_LIST_INIT_DUP;
 314         struct strbuf menu = STRBUF_INIT;
 315         struct strbuf buf = STRBUF_INIT;
 316         struct menu_item *menu_item;
 317         struct string_list_item *string_list_item;
 318         int i;
 319
 320         switch (stuff->type) {
 321         default:
 322                 die("Bad type of menu_staff when print menu");
 323         case MENU_STUFF_TYPE_MENU_ITEM:
 324                 menu_item = (struct menu_item *)stuff->stuff;
 325                 for (i = 0; i < stuff->nr; i++, menu_item++) {
 326                         const char *p;
 327                         int highlighted = 0;
 328
 329                         p = menu_item->title;
 330                         if ((*chosen)[i] < 0)
 331                                 (*chosen)[i] = menu_item->selected ? 1 : 0;
 332                         strbuf_addf(&menu, "%s%2d: ", (*chosen)[i] ? "*" : " ", i+1);
 333                         for (; *p; p++) {
 334                                 if (!highlighted && *p == menu_item->hotkey) {
 335                                         strbuf_addstr(&menu, clean_get_color(CLEAN_COLOR_PROMPT));
 336                                         strbuf_addch(&menu, *p);
 337                                         strbuf_addstr(&menu, clean_get_color(CLEAN_COLOR_RESET));
 338                                         highlighted = 1;
 339                                 } else {
 340                                         strbuf_addch(&menu, *p);
 341                                 }
 342                         }
 343                         string_list_append(&menu_list, menu.buf);
 344                         strbuf_reset(&menu);
 345                 }
 346                 break;
 347         case MENU_STUFF_TYPE_STRING_LIST:
 348                 i = 0;
 349                 for_each_string_list_item(string_list_item, (struct string_list *)stuff->stuff) {
 350                         if ((*chosen)[i] < 0)
 351                                 (*chosen)[i] = 0;
 352                         strbuf_addf(&menu, "%s%2d: %s",
 353                                     (*chosen)[i] ? "*" : " ", i+1, string_list_item->string);
 354                         string_list_append(&menu_list, menu.buf);
 355                         strbuf_reset(&menu);
 356                         i++;
 357                 }
 358                 break;
 359         }
 360
 361         pretty_print_menus(&menu_list);
 362
 363         strbuf_release(&menu);
 364         strbuf_release(&buf);
 365         string_list_clear(&menu_list, 0);
 366 }
 367
 368 /*
 369  * Parse user input, and return choice(s) for menu (menu_stuff).
 370  *
 371  * Input
 372  *     (for single choice)
 373  *         1          - select a numbered item
 374  *         foo        - select item based on menu title
 375  *                    - (empty) select nothing
 376  *
 377  *     (for multiple choice)
 378  *         1          - select a single item
 379  *         3-5        - select a range of items
 380  *         2-3,6-9    - select multiple ranges
 381  *         foo        - select item based on menu title
 382  *         -...       - unselect specified items
 383  *         *          - choose all items
 384  *                    - (empty) finish selecting
 385  *
 386  * The parse result will be saved in array **chosen, and
 387  * return number of total selections.
 388  */
 389 static int parse_choice(struct menu_stuff *menu_stuff,
 390                         int is_single,
 391                         struct strbuf input,
 392                         int **chosen)
 393 {
 394         struct strbuf **choice_list, **ptr;
 395         struct menu_item *menu_item;
 396         struct string_list_item *string_list_item;
 397         int nr = 0;
 398         int i;
 399
 400         if (is_single) {
 401                 choice_list = strbuf_split_max(&input, '\n', 0);
 402         } else {
 403                 char *p = input.buf;
 404                 do {
 405                         if (*p == ',')
 406                                 *p = ' ';
 407                 } while (*p++);
 408                 choice_list = strbuf_split_max(&input, ' ', 0);
 409         }
 410
 411         for (ptr = choice_list; *ptr; ptr++) {
 412                 char *p;
 413                 int choose = 1;
 414                 int bottom = 0, top = 0;
 415                 int is_range, is_number;
 416
 417                 strbuf_trim(*ptr);
 418                 if (!(*ptr)->len)
 419                         continue;
 420
 421                 /* Input that begins with '-'; unchoose */
 422                 if (*(*ptr)->buf == '-') {
 423                         choose = 0;
 424                         strbuf_remove((*ptr), 0, 1);
 425                 }
 426
 427                 is_range = 0;
 428                 is_number = 1;
 429                 for (p = (*ptr)->buf; *p; p++) {
 430                         if ('-' == *p) {
 431                                 if (!is_range) {
 432                                         is_range = 1;
 433                                         is_number = 0;
 434                                 } else {
 435                                         is_number = 0;
 436                                         is_range = 0;
 437                                         break;
 438                                 }
 439                         } else if (!isdigit(*p)) {
 440                                 is_number = 0;
 441                                 is_range = 0;
 442                                 break;
 443                         }
 444                 }
 445
 446                 if (is_number) {
 447                         bottom = atoi((*ptr)->buf);
 448                         top = bottom;
 449                 } else if (is_range) {
 450                         bottom = atoi((*ptr)->buf);
 451                         /* a range can be specified like 5-7 or 5- */
 452                         if (!*(strchr((*ptr)->buf, '-') + 1))
 453                                 top = menu_stuff->nr;
 454                         else
 455                                 top = atoi(strchr((*ptr)->buf, '-') + 1);
 456                 } else if (!strcmp((*ptr)->buf, "*")) {
 457                         bottom = 1;
 458                         top = menu_stuff->nr;
 459                 } else {
 460                         switch (menu_stuff->type) {
 461                         default:
 462                                 die("Bad type of menu_stuff when parse choice");
 463                         case MENU_STUFF_TYPE_MENU_ITEM:
 464                                 menu_item = (struct menu_item *)menu_stuff->stuff;
 465                                 for (i = 0; i < menu_stuff->nr; i++, menu_item++) {
 466                                         if (((*ptr)->len == 1 &&
 467                                              *(*ptr)->buf == menu_item->hotkey) ||
 468                                             !strcasecmp((*ptr)->buf, menu_item->title)) {
 469                                                 bottom = i + 1;
 470                                                 top = bottom;
 471                                                 break;
 472                                         }
 473                                 }
 474                                 break;
 475                         case MENU_STUFF_TYPE_STRING_LIST:
 476                                 string_list_item = ((struct string_list *)menu_stuff->stuff)->items;
 477                                 for (i = 0; i < menu_stuff->nr; i++, string_list_item++) {
 478                                         if (!strcasecmp((*ptr)->buf, string_list_item->string)) {
 479                                                 bottom = i + 1;
 480                                                 top = bottom;
 481                                                 break;
 482                                         }
 483                                 }
 484                                 break;
 485                         }
 486                 }
 487
 488                 if (top <= 0 || bottom <= 0 || top > menu_stuff->nr || bottom > top ||
 489                     (is_single && bottom != top)) {
 490                         clean_print_color(CLEAN_COLOR_ERROR);
 491                         printf_ln(_("Huh (%s)?"), (*ptr)->buf);
 492                         clean_print_color(CLEAN_COLOR_RESET);
 493                         continue;
 494                 }
 495
 496                 for (i = bottom; i <= top; i++)
 497                         (*chosen)[i-1] = choose;
 498         }
 499
 500         strbuf_list_free(choice_list);
 501
 502         for (i = 0; i < menu_stuff->nr; i++)
 503                 nr += (*chosen)[i];
 504         return nr;
 505 }
 506
 507 /*
 508  * Implement a git-add-interactive compatible UI, which is borrowed
 509  * from git-add--interactive.perl.
 510  *
 511  * Return value:
 512  *
 513  *   - Return an array of integers
 514  *   - , and it is up to you to free the allocated memory.
 515  *   - The array ends with EOF.
 516  *   - If user pressed CTRL-D (i.e. EOF), no selection returned.
 517  */
 518 static int *list_and_choose(struct menu_opts *opts, struct menu_stuff *stuff)
 519 {
 520         struct strbuf choice = STRBUF_INIT;
 521         int *chosen, *result;
 522         int nr = 0;
 523         int eof = 0;
 524         int i;
 525
 526         chosen = xmalloc(sizeof(int) * stuff->nr);
 527         /* set chosen as uninitialized */
 528         for (i = 0; i < stuff->nr; i++)
 529                 chosen[i] = -1;
 530
 531         for (;;) {
 532                 if (opts->header) {
 533                         printf_ln("%s%s%s",
 534                                   clean_get_color(CLEAN_COLOR_HEADER),
 535                                   _(opts->header),
 536                                   clean_get_color(CLEAN_COLOR_RESET));
 537                 }
 538
 539                 /* chosen will be initialized by print_highlight_menu_stuff */
 540                 print_highlight_menu_stuff(stuff, &chosen);
 541
 542                 if (opts->flags & MENU_OPTS_LIST_ONLY)
 543                         break;
 544
 545                 if (opts->prompt) {
 546                         printf("%s%s%s%s",
 547                                clean_get_color(CLEAN_COLOR_PROMPT),
 548                                _(opts->prompt),
 549                                opts->flags & MENU_OPTS_SINGLETON ? "> " : ">> ",
 550                                clean_get_color(CLEAN_COLOR_RESET));
 551                 }
 552
 553                 if (strbuf_getline(&choice, stdin, '\n') != EOF) {
 554                         strbuf_trim(&choice);
 555                 } else {
 556                         eof = 1;
 557                         break;
 558                 }
 559
 560                 /* help for prompt */
 561                 if (!strcmp(choice.buf, "?")) {
 562                         prompt_help_cmd(opts->flags & MENU_OPTS_SINGLETON);
 563                         continue;
 564                 }
 565
 566                 /* for a multiple-choice menu, press ENTER (empty) will return back */
 567                 if (!(opts->flags & MENU_OPTS_SINGLETON) && !choice.len)
 568                         break;
 569
 570                 nr = parse_choice(stuff,
 571                                   opts->flags & MENU_OPTS_SINGLETON,
 572                                   choice,
 573                                   &chosen);
 574
 575                 if (opts->flags & MENU_OPTS_SINGLETON) {
 576                         if (nr)
 577                                 break;
 578                 } else if (opts->flags & MENU_OPTS_IMMEDIATE) {
 579                         break;
 580                 }
 581         }
 582
 583         if (eof) {
 584                 result = xmalloc(sizeof(int));
 585                 *result = EOF;
 586         } else {
 587                 int j = 0;
 588
 589                 /*
 590                  * recalculate nr, if return back from menu directly with
 591                  * default selections.
 592                  */
 593                 if (!nr) {
 594                         for (i = 0; i < stuff->nr; i++)
 595                                 nr += chosen[i];
 596                 }
 597
 598                 result = xmalloc(sizeof(int) * (nr + 1));
 599                 memset(result, 0, sizeof(int) * (nr + 1));
 600                 for (i = 0; i < stuff->nr && j < nr; i++) {
 601                         if (chosen[i])
 602                                 result[j++] = i;
 603                 }
 604                 result[j] = EOF;
 605         }
 606
 607         free(chosen);
 608         strbuf_release(&choice);
 609         return result;
 610 }
 611
 612 static int clean_cmd(void)
 613 {
 614         return MENU_RETURN_NO_LOOP;
 615 }
 616
 617 static int filter_by_patterns_cmd(void)
 618 {
 619         struct dir_struct dir;
 620         struct strbuf confirm = STRBUF_INIT;
 621         struct strbuf **ignore_list;
 622         struct string_list_item *item;
 623         struct exclude_list *el;
 624         int changed = -1, i;
 625
 626         for (;;) {
 627                 if (!del_list.nr)
 628                         break;
 629
 630                 if (changed)
 631                         pretty_print_dels();
 632
 633                 clean_print_color(CLEAN_COLOR_PROMPT);
 634                 printf(_("Input ignore patterns>> "));
 635                 clean_print_color(CLEAN_COLOR_RESET);
 636                 if (strbuf_getline(&confirm, stdin, '\n') != EOF)
 637                         strbuf_trim(&confirm);
 638                 else
 639                         putchar('\n');
 640
 641                 /* quit filter_by_pattern mode if press ENTER or Ctrl-D */
 642                 if (!confirm.len)
 643                         break;
 644
 645                 memset(&dir, 0, sizeof(dir));
 646                 el = add_exclude_list(&dir, EXC_CMDL, "manual exclude");
 647                 ignore_list = strbuf_split_max(&confirm, ' ', 0);
 648
 649                 for (i = 0; ignore_list[i]; i++) {
 650                         strbuf_trim(ignore_list[i]);
 651                         if (!ignore_list[i]->len)
 652                                 continue;
 653
 654                         add_exclude(ignore_list[i]->buf, "", 0, el, -(i+1));
 655                 }
 656
 657                 changed = 0;
 658                 for_each_string_list_item(item, &del_list) {
 659                         int dtype = DT_UNKNOWN;
 660
 661                         if (is_excluded(&dir, item->string, &dtype)) {
 662                                 *item->string = '\0';
 663                                 changed++;
 664                         }
 665                 }
 666
 667                 if (changed) {
 668                         string_list_remove_empty_items(&del_list, 0);
 669                 } else {
 670                         clean_print_color(CLEAN_COLOR_ERROR);
 671                         printf_ln(_("WARNING: Cannot find items matched by: %s"), confirm.buf);
 672                         clean_print_color(CLEAN_COLOR_RESET);
 673                 }
 674
 675                 strbuf_list_free(ignore_list);
 676                 clear_directory(&dir);
 677         }
 678
 679         strbuf_release(&confirm);
 680         return 0;
 681 }
 682
 683 static int quit_cmd(void)
 684 {
 685         string_list_clear(&del_list, 0);
 686         printf_ln(_("Bye."));
 687         return MENU_RETURN_NO_LOOP;
 688 }
 689
 690 static int help_cmd(void)
 691 {
 692         clean_print_color(CLEAN_COLOR_HELP);
 693         printf_ln(_(
 694                     "clean               - start cleaning\n"
 695                     "filter by pattern   - exclude items from deletion\n"
 696                     "quit                - stop cleaning\n"
 697                     "help                - this screen\n"
 698                     "?                   - help for prompt selection"
 699                    ));
 700         clean_print_color(CLEAN_COLOR_RESET);
 701         return 0;
 702 }
 703
 704 static void interactive_main_loop(void)
 705 {
 706         while (del_list.nr) {
 707                 struct menu_opts menu_opts;
 708                 struct menu_stuff menu_stuff;
 709                 struct menu_item menus[] = {
 710                         {'c', "clean",                  0, clean_cmd},
 711                         {'f', "filter by pattern",      0, filter_by_patterns_cmd},
 712                         {'q', "quit",                   0, quit_cmd},
 713                         {'h', "help",                   0, help_cmd},
 714                 };
 715                 int *chosen;
 716
 717                 menu_opts.header = N_("*** Commands ***");
 718                 menu_opts.prompt = N_("What now");
 719                 menu_opts.flags = MENU_OPTS_SINGLETON;
 720
 721                 menu_stuff.type = MENU_STUFF_TYPE_MENU_ITEM;
 722                 menu_stuff.stuff = menus;
 723                 menu_stuff.nr = sizeof(menus) / sizeof(struct menu_item);
 724
 725                 clean_print_color(CLEAN_COLOR_HEADER);
 726                 printf_ln(Q_("Would remove the following item:",
 727                              "Would remove the following items:",
 728                              del_list.nr));
 729                 clean_print_color(CLEAN_COLOR_RESET);
 730
 731                 pretty_print_dels();
 732
 733                 chosen = list_and_choose(&menu_opts, &menu_stuff);
 734
 735                 if (*chosen != EOF) {
 736                         int ret;
 737                         ret = menus[*chosen].fn();
 738                         if (ret != MENU_RETURN_NO_LOOP) {
 739                                 free(chosen);
 740                                 chosen = NULL;
 741                                 if (!del_list.nr) {
 742                                         clean_print_color(CLEAN_COLOR_ERROR);
 743                                         printf_ln(_("No more files to clean, exiting."));
 744                                         clean_print_color(CLEAN_COLOR_RESET);
 745                                         break;
 746                                 }
 747                                 continue;
 748                         }
 749                 } else {
 750                         quit_cmd();
 751                 }
 752
 753                 free(chosen);
 754                 chosen = NULL;
 755                 break;
 756         }
 757 }
 758
 759 int cmd_clean(int argc, const char **argv, const char *prefix)
 760 {
 761         int i, res;
 762         int dry_run = 0, remove_directories = 0, quiet = 0, ignored = 0;
 763         int ignored_only = 0, config_set = 0, errors = 0, gone = 1;
 764         int rm_flags = REMOVE_DIR_KEEP_NESTED_GIT;
 765         struct strbuf abs_path = STRBUF_INIT;
 766         struct dir_struct dir;
 767         static const char **pathspec;
 768         struct strbuf buf = STRBUF_INIT;
 769         struct string_list exclude_list = STRING_LIST_INIT_NODUP;
 770         struct exclude_list *el;
 771         struct string_list_item *item;
 772         const char *qname;
 773         char *seen = NULL;
 774         struct option options[] = {
 775                 OPT__QUIET(&quiet, N_("do not print names of files removed")),
 776                 OPT__DRY_RUN(&dry_run, N_("dry run")),
 777                 OPT__FORCE(&force, N_("force")),
 778                 OPT_BOOL('i', "interactive", &interactive, N_("interactive cleaning")),
 779                 OPT_BOOLEAN('d', NULL, &remove_directories,
 780                                 N_("remove whole directories")),
 781                 { OPTION_CALLBACK, 'e', "exclude", &exclude_list, N_("pattern"),
 782                   N_("add <pattern> to ignore rules"), PARSE_OPT_NONEG, exclude_cb },
 783                 OPT_BOOLEAN('x', NULL, &ignored, N_("remove ignored files, too")),
 784                 OPT_BOOLEAN('X', NULL, &ignored_only,
 785                                 N_("remove only ignored files")),
 786                 OPT_END()
 787         };
 788
 789         git_config(git_clean_config, NULL);
 790         if (force < 0)
 791                 force = 0;
 792         else
 793                 config_set = 1;
 794
 795         argc = parse_options(argc, argv, prefix, options, builtin_clean_usage,
 796                              0);
 797
 798         memset(&dir, 0, sizeof(dir));
 799         if (ignored_only)
 800                 dir.flags |= DIR_SHOW_IGNORED;
 801
 802         if (ignored && ignored_only)
 803                 die(_("-x and -X cannot be used together"));
 804
 805         if (!interactive && !dry_run && !force) {
 806                 if (config_set)
 807                         die(_("clean.requireForce set to true and neither -i, -n nor -f given; "
 808                                   "refusing to clean"));
 809                 else
 810                         die(_("clean.requireForce defaults to true and neither -i, -n nor -f given; "
 811                                   "refusing to clean"));
 812         }
 813
 814         if (force > 1)
 815                 rm_flags = 0;
 816
 817         dir.flags |= DIR_SHOW_OTHER_DIRECTORIES;
 818
 819         if (read_cache() < 0)
 820                 die(_("index file corrupt"));
 821
 822         if (!ignored)
 823                 setup_standard_excludes(&dir);
 824
 825         el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
 826         for (i = 0; i < exclude_list.nr; i++)
 827                 add_exclude(exclude_list.items[i].string, "", 0, el, -(i+1));
 828
 829         pathspec = get_pathspec(prefix, argv);
 830
 831         fill_directory(&dir, pathspec);
 832
 833         if (pathspec)
 834                 seen = xmalloc(argc > 0 ? argc : 1);
 835
 836         for (i = 0; i < dir.nr; i++) {
 837                 struct dir_entry *ent = dir.entries[i];
 838                 int len, pos;
 839                 int matches = 0;
 840                 struct cache_entry *ce;
 841                 struct stat st;
 842                 const char *rel;
 843
 844                 /*
 845                  * Remove the '/' at the end that directory
 846                  * walking adds for directory entries.
 847                  */
 848                 len = ent->len;
 849                 if (len && ent->name[len-1] == '/')
 850                         len--;
 851                 pos = cache_name_pos(ent->name, len);
 852                 if (0 <= pos)
 853                         continue;       /* exact match */
 854                 pos = -pos - 1;
 855                 if (pos < active_nr) {
 856                         ce = active_cache[pos];
 857                         if (ce_namelen(ce) == len &&
 858                             !memcmp(ce->name, ent->name, len))
 859                                 continue; /* Yup, this one exists unmerged */
 860                 }
 861
 862                 if (lstat(ent->name, &st))
 863                         die_errno("Cannot lstat '%s'", ent->name);
 864
 865                 if (pathspec) {
 866                         memset(seen, 0, argc > 0 ? argc : 1);
 867                         matches = match_pathspec(pathspec, ent->name, len,
 868                                                  0, seen);
 869                 }
 870
 871                 if (S_ISDIR(st.st_mode)) {
 872                         if (remove_directories || (matches == MATCHED_EXACTLY)) {
 873                                 rel = relative_path(ent->name, prefix, &buf);
 874                                 string_list_append(&del_list, rel);
 875                         }
 876                 } else {
 877                         if (pathspec && !matches)
 878                                 continue;
 879                         rel = relative_path(ent->name, prefix, &buf);
 880                         string_list_append(&del_list, rel);
 881                 }
 882         }
 883
 884         if (interactive && del_list.nr > 0)
 885                 interactive_main_loop();
 886
 887         for_each_string_list_item(item, &del_list) {
 888                 struct stat st;
 889
 890                 if (prefix)
 891                         strbuf_addstr(&abs_path, prefix);
 892
 893                 strbuf_addstr(&abs_path, item->string);
 894
 895                 /*
 896                  * we might have removed this as part of earlier
 897                  * recursive directory removal, so lstat() here could
 898                  * fail with ENOENT.
 899                  */
 900                 if (lstat(abs_path.buf, &st))
 901                         continue;
 902
 903                 if (S_ISDIR(st.st_mode)) {
 904                         if (remove_dirs(&abs_path, prefix, rm_flags, dry_run, quiet, &gone))
 905                                 errors++;
 906                         if (gone && !quiet) {
 907                                 qname = quote_path_relative(item->string, NULL, &buf);
 908                                 printf(dry_run ? _(msg_would_remove) : _(msg_remove), qname);
 909                         }
 910                 } else {
 911                         res = dry_run ? 0 : unlink(abs_path.buf);
 912                         if (res) {
 913                                 qname = quote_path_relative(item->string, NULL, &buf);
 914                                 warning(_(msg_warn_remove_failed), qname);
 915                                 errors++;
 916                         } else if (!quiet) {
 917                                 qname = quote_path_relative(item->string, NULL, &buf);
 918                                 printf(dry_run ? _(msg_would_remove) : _(msg_remove), qname);
 919                         }
 920                 }
 921                 strbuf_reset(&abs_path);
 922         }
 923         free(seen);
 924
 925         strbuf_release(&abs_path);
 926         strbuf_release(&buf);
 927         string_list_clear(&del_list, 0);
 928         string_list_clear(&exclude_list, 0);
 929         return (errors != 0);
 930 }