Andrew's git - gitweb.git/blob

   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 "pathspec.h"
  17
  18static int force = -1; /* unset */
  19
  20static const char *const builtin_clean_usage[] = {
  21        N_("git clean [-d] [-f] [-n] [-q] [-e <pattern>] [-x | -X] [--] <paths>..."),
  22        NULL
  23};
  24
  25static const char *msg_remove = N_("Removing %s\n");
  26static const char *msg_would_remove = N_("Would remove %s\n");
  27static const char *msg_skip_git_dir = N_("Skipping repository %s\n");
  28static const char *msg_would_skip_git_dir = N_("Would skip repository %s\n");
  29static const char *msg_warn_remove_failed = N_("failed to remove %s");
  30
  31static int git_clean_config(const char *var, const char *value, void *cb)
  32{
  33        if (!strcmp(var, "clean.requireforce"))
  34                force = !git_config_bool(var, value);
  35        return git_default_config(var, value, cb);
  36}
  37
  38static int exclude_cb(const struct option *opt, const char *arg, int unset)
  39{
  40        struct string_list *exclude_list = opt->value;
  41        string_list_append(exclude_list, arg);
  42        return 0;
  43}
  44
  45static int remove_dirs(struct strbuf *path, const char *prefix, int force_flag,
  46                int dry_run, int quiet, int *dir_gone)
  47{
  48        DIR *dir;
  49        struct strbuf quoted = STRBUF_INIT;
  50        struct dirent *e;
  51        int res = 0, ret = 0, gone = 1, original_len = path->len, len, i;
  52        unsigned char submodule_head[20];
  53        struct string_list dels = STRING_LIST_INIT_DUP;
  54
  55        *dir_gone = 1;
  56
  57        if ((force_flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
  58                        !resolve_gitlink_ref(path->buf, "HEAD", submodule_head)) {
  59                if (!quiet) {
  60                        quote_path_relative(path->buf, strlen(path->buf), &quoted, prefix);
  61                        printf(dry_run ?  _(msg_would_skip_git_dir) : _(msg_skip_git_dir),
  62                                        quoted.buf);
  63                }
  64
  65                *dir_gone = 0;
  66                return 0;
  67        }
  68
  69        dir = opendir(path->buf);
  70        if (!dir) {
  71                /* an empty dir could be removed even if it is unreadble */
  72                res = dry_run ? 0 : rmdir(path->buf);
  73                if (res) {
  74                        quote_path_relative(path->buf, strlen(path->buf), &quoted, prefix);
  75                        warning(_(msg_warn_remove_failed), quoted.buf);
  76                        *dir_gone = 0;
  77                }
  78                return res;
  79        }
  80
  81        if (path->buf[original_len - 1] != '/')
  82                strbuf_addch(path, '/');
  83
  84        len = path->len;
  85        while ((e = readdir(dir)) != NULL) {
  86                struct stat st;
  87                if (is_dot_or_dotdot(e->d_name))
  88                        continue;
  89
  90                strbuf_setlen(path, len);
  91                strbuf_addstr(path, e->d_name);
  92                if (lstat(path->buf, &st))
  93                        ; /* fall thru */
  94                else if (S_ISDIR(st.st_mode)) {
  95                        if (remove_dirs(path, prefix, force_flag, dry_run, quiet, &gone))
  96                                ret = 1;
  97                        if (gone) {
  98                                quote_path_relative(path->buf, strlen(path->buf), &quoted, prefix);
  99                                string_list_append(&dels, quoted.buf);
 100                        } else
 101                                *dir_gone = 0;
 102                        continue;
 103                } else {
 104                        res = dry_run ? 0 : unlink(path->buf);
 105                        if (!res) {
 106                                quote_path_relative(path->buf, strlen(path->buf), &quoted, prefix);
 107                                string_list_append(&dels, quoted.buf);
 108                        } else {
 109                                quote_path_relative(path->buf, strlen(path->buf), &quoted, prefix);
 110                                warning(_(msg_warn_remove_failed), quoted.buf);
 111                                *dir_gone = 0;
 112                                ret = 1;
 113                        }
 114                        continue;
 115                }
 116
 117                /* path too long, stat fails, or non-directory still exists */
 118                *dir_gone = 0;
 119                ret = 1;
 120                break;
 121        }
 122        closedir(dir);
 123
 124        strbuf_setlen(path, original_len);
 125
 126        if (*dir_gone) {
 127                res = dry_run ? 0 : rmdir(path->buf);
 128                if (!res)
 129                        *dir_gone = 1;
 130                else {
 131                        quote_path_relative(path->buf, strlen(path->buf), &quoted, prefix);
 132                        warning(_(msg_warn_remove_failed), quoted.buf);
 133                        *dir_gone = 0;
 134                        ret = 1;
 135                }
 136        }
 137
 138        if (!*dir_gone && !quiet) {
 139                for (i = 0; i < dels.nr; i++)
 140                        printf(dry_run ?  _(msg_would_remove) : _(msg_remove), dels.items[i].string);
 141        }
 142        string_list_clear(&dels, 0);
 143        return ret;
 144}
 145
 146int cmd_clean(int argc, const char **argv, const char *prefix)
 147{
 148        int i, res;
 149        int dry_run = 0, remove_directories = 0, quiet = 0, ignored = 0;
 150        int ignored_only = 0, config_set = 0, errors = 0, gone = 1;
 151        int rm_flags = REMOVE_DIR_KEEP_NESTED_GIT;
 152        struct strbuf directory = STRBUF_INIT;
 153        struct dir_struct dir;
 154        struct pathspec pathspec;
 155        struct strbuf buf = STRBUF_INIT;
 156        struct string_list exclude_list = STRING_LIST_INIT_NODUP;
 157        struct exclude_list *el;
 158        const char *qname;
 159        struct option options[] = {
 160                OPT__QUIET(&quiet, N_("do not print names of files removed")),
 161                OPT__DRY_RUN(&dry_run, N_("dry run")),
 162                OPT__FORCE(&force, N_("force")),
 163                OPT_BOOLEAN('d', NULL, &remove_directories,
 164                                N_("remove whole directories")),
 165                { OPTION_CALLBACK, 'e', "exclude", &exclude_list, N_("pattern"),
 166                  N_("add <pattern> to ignore rules"), PARSE_OPT_NONEG, exclude_cb },
 167                OPT_BOOLEAN('x', NULL, &ignored, N_("remove ignored files, too")),
 168                OPT_BOOLEAN('X', NULL, &ignored_only,
 169                                N_("remove only ignored files")),
 170                OPT_END()
 171        };
 172
 173        git_config(git_clean_config, NULL);
 174        if (force < 0)
 175                force = 0;
 176        else
 177                config_set = 1;
 178
 179        argc = parse_options(argc, argv, prefix, options, builtin_clean_usage,
 180                             0);
 181
 182        memset(&dir, 0, sizeof(dir));
 183        if (ignored_only)
 184                dir.flags |= DIR_SHOW_IGNORED;
 185
 186        if (ignored && ignored_only)
 187                die(_("-x and -X cannot be used together"));
 188
 189        if (!dry_run && !force) {
 190                if (config_set)
 191                        die(_("clean.requireForce set to true and neither -n nor -f given; "
 192                                  "refusing to clean"));
 193                else
 194                        die(_("clean.requireForce defaults to true and neither -n nor -f given; "
 195                                  "refusing to clean"));
 196        }
 197
 198        if (force > 1)
 199                rm_flags = 0;
 200
 201        dir.flags |= DIR_SHOW_OTHER_DIRECTORIES;
 202
 203        if (read_cache() < 0)
 204                die(_("index file corrupt"));
 205
 206        if (!ignored)
 207                setup_standard_excludes(&dir);
 208
 209        el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
 210        for (i = 0; i < exclude_list.nr; i++)
 211                add_exclude(exclude_list.items[i].string, "", 0, el, -(i+1));
 212
 213        parse_pathspec(&pathspec, 0,
 214                       PATHSPEC_PREFER_CWD,
 215                       prefix, argv);
 216
 217        fill_directory(&dir, pathspec.raw);
 218
 219        for (i = 0; i < dir.nr; i++) {
 220                struct dir_entry *ent = dir.entries[i];
 221                int len, pos;
 222                int matches = 0;
 223                struct cache_entry *ce;
 224                struct stat st;
 225
 226                /*
 227                 * Remove the '/' at the end that directory
 228                 * walking adds for directory entries.
 229                 */
 230                len = ent->len;
 231                if (len && ent->name[len-1] == '/')
 232                        len--;
 233                pos = cache_name_pos(ent->name, len);
 234                if (0 <= pos)
 235                        continue;       /* exact match */
 236                pos = -pos - 1;
 237                if (pos < active_nr) {
 238                        ce = active_cache[pos];
 239                        if (ce_namelen(ce) == len &&
 240                            !memcmp(ce->name, ent->name, len))
 241                                continue; /* Yup, this one exists unmerged */
 242                }
 243
 244                /*
 245                 * we might have removed this as part of earlier
 246                 * recursive directory removal, so lstat() here could
 247                 * fail with ENOENT.
 248                 */
 249                if (lstat(ent->name, &st))
 250                        continue;
 251
 252                if (pathspec.nr)
 253                        matches = match_pathspec_depth(&pathspec, ent->name,
 254                                                       len, 0, NULL);
 255
 256                if (S_ISDIR(st.st_mode)) {
 257                        strbuf_addstr(&directory, ent->name);
 258                        if (remove_directories || (matches == MATCHED_EXACTLY)) {
 259                                if (remove_dirs(&directory, prefix, rm_flags, dry_run, quiet, &gone))
 260                                        errors++;
 261                                if (gone && !quiet) {
 262                                        qname = quote_path_relative(directory.buf, directory.len, &buf, prefix);
 263                                        printf(dry_run ? _(msg_would_remove) : _(msg_remove), qname);
 264                                }
 265                        }
 266                        strbuf_reset(&directory);
 267                } else {
 268                        if (pathspec.nr && !matches)
 269                                continue;
 270                        res = dry_run ? 0 : unlink(ent->name);
 271                        if (res) {
 272                                qname = quote_path_relative(ent->name, -1, &buf, prefix);
 273                                warning(_(msg_warn_remove_failed), qname);
 274                                errors++;
 275                        } else if (!quiet) {
 276                                qname = quote_path_relative(ent->name, -1, &buf, prefix);
 277                                printf(dry_run ? _(msg_would_remove) : _(msg_remove), qname);
 278                        }
 279                }
 280        }
 281
 282        strbuf_release(&directory);
 283        string_list_clear(&exclude_list, 0);
 284        return (errors != 0);
 285}