setup.c: document get_pathspec()
[git] / builtin / add.c
1 /*
2  * "git add" builtin command
3  *
4  * Copyright (C) 2006 Linus Torvalds
5  */
6 #include "cache.h"
7 #include "builtin.h"
8 #include "dir.h"
9 #include "pathspec.h"
10 #include "exec_cmd.h"
11 #include "cache-tree.h"
12 #include "run-command.h"
13 #include "parse-options.h"
14 #include "diff.h"
15 #include "diffcore.h"
16 #include "revision.h"
17 #include "bulk-checkin.h"
18
19 static const char * const builtin_add_usage[] = {
20         "git add [options] [--] <filepattern>...",
21         NULL
22 };
23 static int patch_interactive, add_interactive, edit_interactive;
24 static int take_worktree_changes;
25
26 struct update_callback_data {
27         int flags;
28         int add_errors;
29 };
30
31 static int fix_unmerged_status(struct diff_filepair *p,
32                                struct update_callback_data *data)
33 {
34         if (p->status != DIFF_STATUS_UNMERGED)
35                 return p->status;
36         if (!(data->flags & ADD_CACHE_IGNORE_REMOVAL) && !p->two->mode)
37                 /*
38                  * This is not an explicit add request, and the
39                  * path is missing from the working tree (deleted)
40                  */
41                 return DIFF_STATUS_DELETED;
42         else
43                 /*
44                  * Either an explicit add request, or path exists
45                  * in the working tree.  An attempt to explicitly
46                  * add a path that does not exist in the working tree
47                  * will be caught as an error by the caller immediately.
48                  */
49                 return DIFF_STATUS_MODIFIED;
50 }
51
52 static void update_callback(struct diff_queue_struct *q,
53                             struct diff_options *opt, void *cbdata)
54 {
55         int i;
56         struct update_callback_data *data = cbdata;
57
58         for (i = 0; i < q->nr; i++) {
59                 struct diff_filepair *p = q->queue[i];
60                 const char *path = p->one->path;
61                 switch (fix_unmerged_status(p, data)) {
62                 default:
63                         die(_("unexpected diff status %c"), p->status);
64                 case DIFF_STATUS_MODIFIED:
65                 case DIFF_STATUS_TYPE_CHANGED:
66                         if (add_file_to_index(&the_index, path, data->flags)) {
67                                 if (!(data->flags & ADD_CACHE_IGNORE_ERRORS))
68                                         die(_("updating files failed"));
69                                 data->add_errors++;
70                         }
71                         break;
72                 case DIFF_STATUS_DELETED:
73                         if (data->flags & ADD_CACHE_IGNORE_REMOVAL)
74                                 break;
75                         if (!(data->flags & ADD_CACHE_PRETEND))
76                                 remove_file_from_index(&the_index, path);
77                         if (data->flags & (ADD_CACHE_PRETEND|ADD_CACHE_VERBOSE))
78                                 printf(_("remove '%s'\n"), path);
79                         break;
80                 }
81         }
82 }
83
84 int add_files_to_cache(const char *prefix, const char **pathspec, int flags)
85 {
86         struct update_callback_data data;
87         struct rev_info rev;
88         init_revisions(&rev, prefix);
89         setup_revisions(0, NULL, &rev, NULL);
90         init_pathspec(&rev.prune_data, pathspec);
91         rev.diffopt.output_format = DIFF_FORMAT_CALLBACK;
92         rev.diffopt.format_callback = update_callback;
93         data.flags = flags;
94         data.add_errors = 0;
95         rev.diffopt.format_callback_data = &data;
96         rev.max_count = 0; /* do not compare unmerged paths with stage #2 */
97         run_diff_files(&rev, DIFF_RACY_IS_MODIFIED);
98         return !!data.add_errors;
99 }
100
101 static char *prune_directory(struct dir_struct *dir, const char **pathspec, int prefix)
102 {
103         char *seen;
104         int i, specs;
105         struct dir_entry **src, **dst;
106
107         for (specs = 0; pathspec[specs];  specs++)
108                 /* nothing */;
109         seen = xcalloc(specs, 1);
110
111         src = dst = dir->entries;
112         i = dir->nr;
113         while (--i >= 0) {
114                 struct dir_entry *entry = *src++;
115                 if (match_pathspec(pathspec, entry->name, entry->len,
116                                    prefix, seen))
117                         *dst++ = entry;
118         }
119         dir->nr = dst - dir->entries;
120         add_pathspec_matches_against_index(pathspec, seen, specs);
121         return seen;
122 }
123
124 /*
125  * Checks the index to see whether any path in pathspec refers to
126  * something inside a submodule.  If so, dies with an error message.
127  */
128 static void treat_gitlinks(const char **pathspec)
129 {
130         int i;
131
132         if (!pathspec || !*pathspec)
133                 return;
134
135         for (i = 0; pathspec[i]; i++)
136                 pathspec[i] = check_path_for_gitlink(pathspec[i]);
137 }
138
139 static void refresh(int verbose, const char **pathspec)
140 {
141         char *seen;
142         int i, specs;
143
144         for (specs = 0; pathspec[specs];  specs++)
145                 /* nothing */;
146         seen = xcalloc(specs, 1);
147         refresh_index(&the_index, verbose ? REFRESH_IN_PORCELAIN : REFRESH_QUIET,
148                       pathspec, seen, _("Unstaged changes after refreshing the index:"));
149         for (i = 0; i < specs; i++) {
150                 if (!seen[i])
151                         die(_("pathspec '%s' did not match any files"), pathspec[i]);
152         }
153         free(seen);
154 }
155
156 /*
157  * Normalizes argv relative to prefix, via get_pathspec(), and then
158  * runs die_if_path_beyond_symlink() on each path in the normalized
159  * list.
160  */
161 static const char **validate_pathspec(const char **argv, const char *prefix)
162 {
163         const char **pathspec = get_pathspec(prefix, argv);
164
165         if (pathspec) {
166                 const char **p;
167                 for (p = pathspec; *p; p++) {
168                         die_if_path_beyond_symlink(*p, prefix);
169                 }
170         }
171
172         return pathspec;
173 }
174
175 int run_add_interactive(const char *revision, const char *patch_mode,
176                         const char **pathspec)
177 {
178         int status, ac, pc = 0;
179         const char **args;
180
181         if (pathspec)
182                 while (pathspec[pc])
183                         pc++;
184
185         args = xcalloc(sizeof(const char *), (pc + 5));
186         ac = 0;
187         args[ac++] = "add--interactive";
188         if (patch_mode)
189                 args[ac++] = patch_mode;
190         if (revision)
191                 args[ac++] = revision;
192         args[ac++] = "--";
193         if (pc) {
194                 memcpy(&(args[ac]), pathspec, sizeof(const char *) * pc);
195                 ac += pc;
196         }
197         args[ac] = NULL;
198
199         status = run_command_v_opt(args, RUN_GIT_CMD);
200         free(args);
201         return status;
202 }
203
204 int interactive_add(int argc, const char **argv, const char *prefix, int patch)
205 {
206         const char **pathspec = NULL;
207
208         if (argc) {
209                 pathspec = validate_pathspec(argv, prefix);
210                 if (!pathspec)
211                         return -1;
212         }
213
214         return run_add_interactive(NULL,
215                                    patch ? "--patch" : NULL,
216                                    pathspec);
217 }
218
219 static int edit_patch(int argc, const char **argv, const char *prefix)
220 {
221         char *file = xstrdup(git_path("ADD_EDIT.patch"));
222         const char *apply_argv[] = { "apply", "--recount", "--cached",
223                 NULL, NULL };
224         struct child_process child;
225         struct rev_info rev;
226         int out;
227         struct stat st;
228
229         apply_argv[3] = file;
230
231         git_config(git_diff_basic_config, NULL); /* no "diff" UI options */
232
233         if (read_cache() < 0)
234                 die (_("Could not read the index"));
235
236         init_revisions(&rev, prefix);
237         rev.diffopt.context = 7;
238
239         argc = setup_revisions(argc, argv, &rev, NULL);
240         rev.diffopt.output_format = DIFF_FORMAT_PATCH;
241         DIFF_OPT_SET(&rev.diffopt, IGNORE_DIRTY_SUBMODULES);
242         out = open(file, O_CREAT | O_WRONLY, 0666);
243         if (out < 0)
244                 die (_("Could not open '%s' for writing."), file);
245         rev.diffopt.file = xfdopen(out, "w");
246         rev.diffopt.close_file = 1;
247         if (run_diff_files(&rev, 0))
248                 die (_("Could not write patch"));
249
250         launch_editor(file, NULL, NULL);
251
252         if (stat(file, &st))
253                 die_errno(_("Could not stat '%s'"), file);
254         if (!st.st_size)
255                 die(_("Empty patch. Aborted."));
256
257         memset(&child, 0, sizeof(child));
258         child.git_cmd = 1;
259         child.argv = apply_argv;
260         if (run_command(&child))
261                 die (_("Could not apply '%s'"), file);
262
263         unlink(file);
264         return 0;
265 }
266
267 static struct lock_file lock_file;
268
269 static const char ignore_error[] =
270 N_("The following paths are ignored by one of your .gitignore files:\n");
271
272 static int verbose = 0, show_only = 0, ignored_too = 0, refresh_only = 0;
273 static int ignore_add_errors, addremove, intent_to_add, ignore_missing = 0;
274
275 static struct option builtin_add_options[] = {
276         OPT__DRY_RUN(&show_only, "dry run"),
277         OPT__VERBOSE(&verbose, "be verbose"),
278         OPT_GROUP(""),
279         OPT_BOOLEAN('i', "interactive", &add_interactive, "interactive picking"),
280         OPT_BOOLEAN('p', "patch", &patch_interactive, "select hunks interactively"),
281         OPT_BOOLEAN('e', "edit", &edit_interactive, "edit current diff and apply"),
282         OPT__FORCE(&ignored_too, "allow adding otherwise ignored files"),
283         OPT_BOOLEAN('u', "update", &take_worktree_changes, "update tracked files"),
284         OPT_BOOLEAN('N', "intent-to-add", &intent_to_add, "record only the fact that the path will be added later"),
285         OPT_BOOLEAN('A', "all", &addremove, "add changes from all tracked and untracked files"),
286         OPT_BOOLEAN( 0 , "refresh", &refresh_only, "don't add, only refresh the index"),
287         OPT_BOOLEAN( 0 , "ignore-errors", &ignore_add_errors, "just skip files which cannot be added because of errors"),
288         OPT_BOOLEAN( 0 , "ignore-missing", &ignore_missing, "check if - even missing - files are ignored in dry run"),
289         OPT_END(),
290 };
291
292 static int add_config(const char *var, const char *value, void *cb)
293 {
294         if (!strcmp(var, "add.ignoreerrors") ||
295             !strcmp(var, "add.ignore-errors")) {
296                 ignore_add_errors = git_config_bool(var, value);
297                 return 0;
298         }
299         return git_default_config(var, value, cb);
300 }
301
302 static int add_files(struct dir_struct *dir, int flags)
303 {
304         int i, exit_status = 0;
305
306         if (dir->ignored_nr) {
307                 fprintf(stderr, _(ignore_error));
308                 for (i = 0; i < dir->ignored_nr; i++)
309                         fprintf(stderr, "%s\n", dir->ignored[i]->name);
310                 fprintf(stderr, _("Use -f if you really want to add them.\n"));
311                 die(_("no files added"));
312         }
313
314         for (i = 0; i < dir->nr; i++)
315                 if (add_file_to_cache(dir->entries[i]->name, flags)) {
316                         if (!ignore_add_errors)
317                                 die(_("adding files failed"));
318                         exit_status = 1;
319                 }
320         return exit_status;
321 }
322
323 int cmd_add(int argc, const char **argv, const char *prefix)
324 {
325         int exit_status = 0;
326         int newfd;
327         const char **pathspec;
328         struct dir_struct dir;
329         int flags;
330         int add_new_files;
331         int require_pathspec;
332         char *seen = NULL;
333
334         git_config(add_config, NULL);
335
336         argc = parse_options(argc, argv, prefix, builtin_add_options,
337                           builtin_add_usage, PARSE_OPT_KEEP_ARGV0);
338         if (patch_interactive)
339                 add_interactive = 1;
340         if (add_interactive)
341                 exit(interactive_add(argc - 1, argv + 1, prefix, patch_interactive));
342
343         if (edit_interactive)
344                 return(edit_patch(argc, argv, prefix));
345         argc--;
346         argv++;
347
348         if (addremove && take_worktree_changes)
349                 die(_("-A and -u are mutually incompatible"));
350         if (!show_only && ignore_missing)
351                 die(_("Option --ignore-missing can only be used together with --dry-run"));
352         if ((addremove || take_worktree_changes) && !argc) {
353                 static const char *here[2] = { ".", NULL };
354                 argc = 1;
355                 argv = here;
356         }
357
358         add_new_files = !take_worktree_changes && !refresh_only;
359         require_pathspec = !take_worktree_changes;
360
361         newfd = hold_locked_index(&lock_file, 1);
362
363         flags = ((verbose ? ADD_CACHE_VERBOSE : 0) |
364                  (show_only ? ADD_CACHE_PRETEND : 0) |
365                  (intent_to_add ? ADD_CACHE_INTENT : 0) |
366                  (ignore_add_errors ? ADD_CACHE_IGNORE_ERRORS : 0) |
367                  (!(addremove || take_worktree_changes)
368                   ? ADD_CACHE_IGNORE_REMOVAL : 0));
369
370         if (require_pathspec && argc == 0) {
371                 fprintf(stderr, _("Nothing specified, nothing added.\n"));
372                 fprintf(stderr, _("Maybe you wanted to say 'git add .'?\n"));
373                 return 0;
374         }
375         pathspec = validate_pathspec(argv, prefix);
376
377         if (read_cache() < 0)
378                 die(_("index file corrupt"));
379         treat_gitlinks(pathspec);
380
381         if (add_new_files) {
382                 int baselen;
383
384                 /* Set up the default git porcelain excludes */
385                 memset(&dir, 0, sizeof(dir));
386                 if (!ignored_too) {
387                         dir.flags |= DIR_COLLECT_IGNORED;
388                         setup_standard_excludes(&dir);
389                 }
390
391                 /* This picks up the paths that are not tracked */
392                 baselen = fill_directory(&dir, pathspec);
393                 if (pathspec)
394                         seen = prune_directory(&dir, pathspec, baselen);
395         }
396
397         if (refresh_only) {
398                 refresh(verbose, pathspec);
399                 goto finish;
400         }
401
402         if (pathspec) {
403                 int i;
404                 struct path_exclude_check check;
405
406                 path_exclude_check_init(&check, &dir);
407                 if (!seen)
408                         seen = find_pathspecs_matching_against_index(pathspec);
409                 for (i = 0; pathspec[i]; i++) {
410                         if (!seen[i] && pathspec[i][0]
411                             && !file_exists(pathspec[i])) {
412                                 if (ignore_missing) {
413                                         int dtype = DT_UNKNOWN;
414                                         if (is_path_excluded(&check, pathspec[i], -1, &dtype))
415                                                 dir_add_ignored(&dir, pathspec[i], strlen(pathspec[i]));
416                                 } else
417                                         die(_("pathspec '%s' did not match any files"),
418                                             pathspec[i]);
419                         }
420                 }
421                 free(seen);
422                 path_exclude_check_clear(&check);
423         }
424
425         plug_bulk_checkin();
426
427         exit_status |= add_files_to_cache(prefix, pathspec, flags);
428
429         if (add_new_files)
430                 exit_status |= add_files(&dir, flags);
431
432         unplug_bulk_checkin();
433
434  finish:
435         if (active_cache_changed) {
436                 if (write_cache(newfd, active_cache, active_nr) ||
437                     commit_locked_index(&lock_file))
438                         die(_("Unable to write new index file"));
439         }
440
441         return exit_status;
442 }