Merge branch 'jc/maint-fix-test-perm' into maint
[git] / builtin-ls-files.c
1 /*
2  * This merges the file listing in the directory cache index
3  * with the actual working directory list, and shows different
4  * combinations of the two.
5  *
6  * Copyright (C) Linus Torvalds, 2005
7  */
8 #include "cache.h"
9 #include "quote.h"
10 #include "dir.h"
11 #include "builtin.h"
12 #include "tree.h"
13 #include "parse-options.h"
14 #include "resolve-undo.h"
15 #include "string-list.h"
16
17 static int abbrev;
18 static int show_deleted;
19 static int show_cached;
20 static int show_others;
21 static int show_stage;
22 static int show_unmerged;
23 static int show_resolve_undo;
24 static int show_modified;
25 static int show_killed;
26 static int show_valid_bit;
27 static int line_terminator = '\n';
28
29 static int prefix_len;
30 static int prefix_offset;
31 static const char **pathspec;
32 static int error_unmatch;
33 static char *ps_matched;
34 static const char *with_tree;
35 static int exc_given;
36
37 static const char *tag_cached = "";
38 static const char *tag_unmerged = "";
39 static const char *tag_removed = "";
40 static const char *tag_other = "";
41 static const char *tag_killed = "";
42 static const char *tag_modified = "";
43 static const char *tag_skip_worktree = "";
44 static const char *tag_resolve_undo = "";
45
46 static void show_dir_entry(const char *tag, struct dir_entry *ent)
47 {
48         int len = prefix_len;
49         int offset = prefix_offset;
50
51         if (len >= ent->len)
52                 die("git ls-files: internal error - directory entry not superset of prefix");
53
54         if (!match_pathspec(pathspec, ent->name, ent->len, len, ps_matched))
55                 return;
56
57         fputs(tag, stdout);
58         write_name_quoted(ent->name + offset, stdout, line_terminator);
59 }
60
61 static void show_other_files(struct dir_struct *dir)
62 {
63         int i;
64
65         for (i = 0; i < dir->nr; i++) {
66                 struct dir_entry *ent = dir->entries[i];
67                 if (!cache_name_is_other(ent->name, ent->len))
68                         continue;
69                 show_dir_entry(tag_other, ent);
70         }
71 }
72
73 static void show_killed_files(struct dir_struct *dir)
74 {
75         int i;
76         for (i = 0; i < dir->nr; i++) {
77                 struct dir_entry *ent = dir->entries[i];
78                 char *cp, *sp;
79                 int pos, len, killed = 0;
80
81                 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
82                         sp = strchr(cp, '/');
83                         if (!sp) {
84                                 /* If ent->name is prefix of an entry in the
85                                  * cache, it will be killed.
86                                  */
87                                 pos = cache_name_pos(ent->name, ent->len);
88                                 if (0 <= pos)
89                                         die("bug in show-killed-files");
90                                 pos = -pos - 1;
91                                 while (pos < active_nr &&
92                                        ce_stage(active_cache[pos]))
93                                         pos++; /* skip unmerged */
94                                 if (active_nr <= pos)
95                                         break;
96                                 /* pos points at a name immediately after
97                                  * ent->name in the cache.  Does it expect
98                                  * ent->name to be a directory?
99                                  */
100                                 len = ce_namelen(active_cache[pos]);
101                                 if ((ent->len < len) &&
102                                     !strncmp(active_cache[pos]->name,
103                                              ent->name, ent->len) &&
104                                     active_cache[pos]->name[ent->len] == '/')
105                                         killed = 1;
106                                 break;
107                         }
108                         if (0 <= cache_name_pos(ent->name, sp - ent->name)) {
109                                 /* If any of the leading directories in
110                                  * ent->name is registered in the cache,
111                                  * ent->name will be killed.
112                                  */
113                                 killed = 1;
114                                 break;
115                         }
116                 }
117                 if (killed)
118                         show_dir_entry(tag_killed, dir->entries[i]);
119         }
120 }
121
122 static void show_ce_entry(const char *tag, struct cache_entry *ce)
123 {
124         int len = prefix_len;
125         int offset = prefix_offset;
126
127         if (len >= ce_namelen(ce))
128                 die("git ls-files: internal error - cache entry not superset of prefix");
129
130         if (!match_pathspec(pathspec, ce->name, ce_namelen(ce), len, ps_matched))
131                 return;
132
133         if (tag && *tag && show_valid_bit &&
134             (ce->ce_flags & CE_VALID)) {
135                 static char alttag[4];
136                 memcpy(alttag, tag, 3);
137                 if (isalpha(tag[0]))
138                         alttag[0] = tolower(tag[0]);
139                 else if (tag[0] == '?')
140                         alttag[0] = '!';
141                 else {
142                         alttag[0] = 'v';
143                         alttag[1] = tag[0];
144                         alttag[2] = ' ';
145                         alttag[3] = 0;
146                 }
147                 tag = alttag;
148         }
149
150         if (!show_stage) {
151                 fputs(tag, stdout);
152         } else {
153                 printf("%s%06o %s %d\t",
154                        tag,
155                        ce->ce_mode,
156                        abbrev ? find_unique_abbrev(ce->sha1,abbrev)
157                                 : sha1_to_hex(ce->sha1),
158                        ce_stage(ce));
159         }
160         write_name_quoted(ce->name + offset, stdout, line_terminator);
161 }
162
163 static int show_one_ru(struct string_list_item *item, void *cbdata)
164 {
165         int offset = prefix_offset;
166         const char *path = item->string;
167         struct resolve_undo_info *ui = item->util;
168         int i, len;
169
170         len = strlen(path);
171         if (len < prefix_len)
172                 return 0; /* outside of the prefix */
173         if (!match_pathspec(pathspec, path, len, prefix_len, ps_matched))
174                 return 0; /* uninterested */
175         for (i = 0; i < 3; i++) {
176                 if (!ui->mode[i])
177                         continue;
178                 printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
179                        abbrev
180                        ? find_unique_abbrev(ui->sha1[i], abbrev)
181                        : sha1_to_hex(ui->sha1[i]),
182                        i + 1);
183                 write_name_quoted(path + offset, stdout, line_terminator);
184         }
185         return 0;
186 }
187
188 static void show_ru_info(const char *prefix)
189 {
190         if (!the_index.resolve_undo)
191                 return;
192         for_each_string_list(show_one_ru, the_index.resolve_undo, NULL);
193 }
194
195 static void show_files(struct dir_struct *dir, const char *prefix)
196 {
197         int i;
198
199         /* For cached/deleted files we don't need to even do the readdir */
200         if (show_others || show_killed) {
201                 fill_directory(dir, pathspec);
202                 if (show_others)
203                         show_other_files(dir);
204                 if (show_killed)
205                         show_killed_files(dir);
206         }
207         if (show_cached | show_stage) {
208                 for (i = 0; i < active_nr; i++) {
209                         struct cache_entry *ce = active_cache[i];
210                         int dtype = ce_to_dtype(ce);
211                         if (dir->flags & DIR_SHOW_IGNORED &&
212                             !excluded(dir, ce->name, &dtype))
213                                 continue;
214                         if (show_unmerged && !ce_stage(ce))
215                                 continue;
216                         if (ce->ce_flags & CE_UPDATE)
217                                 continue;
218                         show_ce_entry(ce_stage(ce) ? tag_unmerged :
219                                 (ce_skip_worktree(ce) ? tag_skip_worktree : tag_cached), ce);
220                 }
221         }
222         if (show_deleted | show_modified) {
223                 for (i = 0; i < active_nr; i++) {
224                         struct cache_entry *ce = active_cache[i];
225                         struct stat st;
226                         int err;
227                         int dtype = ce_to_dtype(ce);
228                         if (dir->flags & DIR_SHOW_IGNORED &&
229                             !excluded(dir, ce->name, &dtype))
230                                 continue;
231                         if (ce->ce_flags & CE_UPDATE)
232                                 continue;
233                         if (ce_skip_worktree(ce))
234                                 continue;
235                         err = lstat(ce->name, &st);
236                         if (show_deleted && err)
237                                 show_ce_entry(tag_removed, ce);
238                         if (show_modified && ce_modified(ce, &st, 0))
239                                 show_ce_entry(tag_modified, ce);
240                 }
241         }
242 }
243
244 /*
245  * Prune the index to only contain stuff starting with "prefix"
246  */
247 static void prune_cache(const char *prefix)
248 {
249         int pos = cache_name_pos(prefix, prefix_len);
250         unsigned int first, last;
251
252         if (pos < 0)
253                 pos = -pos-1;
254         memmove(active_cache, active_cache + pos,
255                 (active_nr - pos) * sizeof(struct cache_entry *));
256         active_nr -= pos;
257         first = 0;
258         last = active_nr;
259         while (last > first) {
260                 int next = (last + first) >> 1;
261                 struct cache_entry *ce = active_cache[next];
262                 if (!strncmp(ce->name, prefix, prefix_len)) {
263                         first = next+1;
264                         continue;
265                 }
266                 last = next;
267         }
268         active_nr = last;
269 }
270
271 static const char *verify_pathspec(const char *prefix)
272 {
273         const char **p, *n, *prev;
274         unsigned long max;
275
276         prev = NULL;
277         max = PATH_MAX;
278         for (p = pathspec; (n = *p) != NULL; p++) {
279                 int i, len = 0;
280                 for (i = 0; i < max; i++) {
281                         char c = n[i];
282                         if (prev && prev[i] != c)
283                                 break;
284                         if (!c || c == '*' || c == '?')
285                                 break;
286                         if (c == '/')
287                                 len = i+1;
288                 }
289                 prev = n;
290                 if (len < max) {
291                         max = len;
292                         if (!max)
293                                 break;
294                 }
295         }
296
297         if (prefix_offset > max || memcmp(prev, prefix, prefix_offset))
298                 die("git ls-files: cannot generate relative filenames containing '..'");
299
300         prefix_len = max;
301         return max ? xmemdupz(prev, max) : NULL;
302 }
303
304 static void strip_trailing_slash_from_submodules(void)
305 {
306         const char **p;
307
308         for (p = pathspec; *p != NULL; p++) {
309                 int len = strlen(*p), pos;
310
311                 if (len < 1 || (*p)[len - 1] != '/')
312                         continue;
313                 pos = cache_name_pos(*p, len - 1);
314                 if (pos >= 0 && S_ISGITLINK(active_cache[pos]->ce_mode))
315                         *p = xstrndup(*p, len - 1);
316         }
317 }
318
319 /*
320  * Read the tree specified with --with-tree option
321  * (typically, HEAD) into stage #1 and then
322  * squash them down to stage #0.  This is used for
323  * --error-unmatch to list and check the path patterns
324  * that were given from the command line.  We are not
325  * going to write this index out.
326  */
327 void overlay_tree_on_cache(const char *tree_name, const char *prefix)
328 {
329         struct tree *tree;
330         unsigned char sha1[20];
331         const char **match;
332         struct cache_entry *last_stage0 = NULL;
333         int i;
334
335         if (get_sha1(tree_name, sha1))
336                 die("tree-ish %s not found.", tree_name);
337         tree = parse_tree_indirect(sha1);
338         if (!tree)
339                 die("bad tree-ish %s", tree_name);
340
341         /* Hoist the unmerged entries up to stage #3 to make room */
342         for (i = 0; i < active_nr; i++) {
343                 struct cache_entry *ce = active_cache[i];
344                 if (!ce_stage(ce))
345                         continue;
346                 ce->ce_flags |= CE_STAGEMASK;
347         }
348
349         if (prefix) {
350                 static const char *(matchbuf[2]);
351                 matchbuf[0] = prefix;
352                 matchbuf[1] = NULL;
353                 match = matchbuf;
354         } else
355                 match = NULL;
356         if (read_tree(tree, 1, match))
357                 die("unable to read tree entries %s", tree_name);
358
359         for (i = 0; i < active_nr; i++) {
360                 struct cache_entry *ce = active_cache[i];
361                 switch (ce_stage(ce)) {
362                 case 0:
363                         last_stage0 = ce;
364                         /* fallthru */
365                 default:
366                         continue;
367                 case 1:
368                         /*
369                          * If there is stage #0 entry for this, we do not
370                          * need to show it.  We use CE_UPDATE bit to mark
371                          * such an entry.
372                          */
373                         if (last_stage0 &&
374                             !strcmp(last_stage0->name, ce->name))
375                                 ce->ce_flags |= CE_UPDATE;
376                 }
377         }
378 }
379
380 int report_path_error(const char *ps_matched, const char **pathspec, int prefix_offset)
381 {
382         /*
383          * Make sure all pathspec matched; otherwise it is an error.
384          */
385         int num, errors = 0;
386         for (num = 0; pathspec[num]; num++) {
387                 int other, found_dup;
388
389                 if (ps_matched[num])
390                         continue;
391                 /*
392                  * The caller might have fed identical pathspec
393                  * twice.  Do not barf on such a mistake.
394                  */
395                 for (found_dup = other = 0;
396                      !found_dup && pathspec[other];
397                      other++) {
398                         if (other == num || !ps_matched[other])
399                                 continue;
400                         if (!strcmp(pathspec[other], pathspec[num]))
401                                 /*
402                                  * Ok, we have a match already.
403                                  */
404                                 found_dup = 1;
405                 }
406                 if (found_dup)
407                         continue;
408
409                 error("pathspec '%s' did not match any file(s) known to git.",
410                       pathspec[num] + prefix_offset);
411                 errors++;
412         }
413         return errors;
414 }
415
416 static const char * const ls_files_usage[] = {
417         "git ls-files [options] [<file>]*",
418         NULL
419 };
420
421 static int option_parse_z(const struct option *opt,
422                           const char *arg, int unset)
423 {
424         line_terminator = unset ? '\n' : '\0';
425
426         return 0;
427 }
428
429 static int option_parse_exclude(const struct option *opt,
430                                 const char *arg, int unset)
431 {
432         struct exclude_list *list = opt->value;
433
434         exc_given = 1;
435         add_exclude(arg, "", 0, list);
436
437         return 0;
438 }
439
440 static int option_parse_exclude_from(const struct option *opt,
441                                      const char *arg, int unset)
442 {
443         struct dir_struct *dir = opt->value;
444
445         exc_given = 1;
446         add_excludes_from_file(dir, arg);
447
448         return 0;
449 }
450
451 static int option_parse_exclude_standard(const struct option *opt,
452                                          const char *arg, int unset)
453 {
454         struct dir_struct *dir = opt->value;
455
456         exc_given = 1;
457         setup_standard_excludes(dir);
458
459         return 0;
460 }
461
462 int cmd_ls_files(int argc, const char **argv, const char *prefix)
463 {
464         int require_work_tree = 0, show_tag = 0;
465         struct dir_struct dir;
466         struct option builtin_ls_files_options[] = {
467                 { OPTION_CALLBACK, 'z', NULL, NULL, NULL,
468                         "paths are separated with NUL character",
469                         PARSE_OPT_NOARG, option_parse_z },
470                 OPT_BOOLEAN('t', NULL, &show_tag,
471                         "identify the file status with tags"),
472                 OPT_BOOLEAN('v', NULL, &show_valid_bit,
473                         "use lowercase letters for 'assume unchanged' files"),
474                 OPT_BOOLEAN('c', "cached", &show_cached,
475                         "show cached files in the output (default)"),
476                 OPT_BOOLEAN('d', "deleted", &show_deleted,
477                         "show deleted files in the output"),
478                 OPT_BOOLEAN('m', "modified", &show_modified,
479                         "show modified files in the output"),
480                 OPT_BOOLEAN('o', "others", &show_others,
481                         "show other files in the output"),
482                 OPT_BIT('i', "ignored", &dir.flags,
483                         "show ignored files in the output",
484                         DIR_SHOW_IGNORED),
485                 OPT_BOOLEAN('s', "stage", &show_stage,
486                         "show staged contents' object name in the output"),
487                 OPT_BOOLEAN('k', "killed", &show_killed,
488                         "show files on the filesystem that need to be removed"),
489                 OPT_BIT(0, "directory", &dir.flags,
490                         "show 'other' directories' name only",
491                         DIR_SHOW_OTHER_DIRECTORIES),
492                 OPT_NEGBIT(0, "empty-directory", &dir.flags,
493                         "don't show empty directories",
494                         DIR_HIDE_EMPTY_DIRECTORIES),
495                 OPT_BOOLEAN('u', "unmerged", &show_unmerged,
496                         "show unmerged files in the output"),
497                 OPT_BOOLEAN(0, "resolve-undo", &show_resolve_undo,
498                             "show resolve-undo information"),
499                 { OPTION_CALLBACK, 'x', "exclude", &dir.exclude_list[EXC_CMDL], "pattern",
500                         "skip files matching pattern",
501                         0, option_parse_exclude },
502                 { OPTION_CALLBACK, 'X', "exclude-from", &dir, "file",
503                         "exclude patterns are read from <file>",
504                         0, option_parse_exclude_from },
505                 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, "file",
506                         "read additional per-directory exclude patterns in <file>"),
507                 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
508                         "add the standard git exclusions",
509                         PARSE_OPT_NOARG, option_parse_exclude_standard },
510                 { OPTION_SET_INT, 0, "full-name", &prefix_offset, NULL,
511                         "make the output relative to the project top directory",
512                         PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
513                 OPT_BOOLEAN(0, "error-unmatch", &error_unmatch,
514                         "if any <file> is not in the index, treat this as an error"),
515                 OPT_STRING(0, "with-tree", &with_tree, "tree-ish",
516                         "pretend that paths removed since <tree-ish> are still present"),
517                 OPT__ABBREV(&abbrev),
518                 OPT_END()
519         };
520
521         memset(&dir, 0, sizeof(dir));
522         if (prefix)
523                 prefix_offset = strlen(prefix);
524         git_config(git_default_config, NULL);
525
526         if (read_cache() < 0)
527                 die("index file corrupt");
528
529         argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
530                         ls_files_usage, 0);
531         if (show_tag || show_valid_bit) {
532                 tag_cached = "H ";
533                 tag_unmerged = "M ";
534                 tag_removed = "R ";
535                 tag_modified = "C ";
536                 tag_other = "? ";
537                 tag_killed = "K ";
538                 tag_skip_worktree = "S ";
539                 tag_resolve_undo = "U ";
540         }
541         if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
542                 require_work_tree = 1;
543         if (show_unmerged)
544                 /*
545                  * There's no point in showing unmerged unless
546                  * you also show the stage information.
547                  */
548                 show_stage = 1;
549         if (dir.exclude_per_dir)
550                 exc_given = 1;
551
552         if (require_work_tree && !is_inside_work_tree())
553                 setup_work_tree();
554
555         pathspec = get_pathspec(prefix, argv);
556
557         /* be nice with submodule paths ending in a slash */
558         if (pathspec)
559                 strip_trailing_slash_from_submodules();
560
561         /* Verify that the pathspec matches the prefix */
562         if (pathspec)
563                 prefix = verify_pathspec(prefix);
564
565         /* Treat unmatching pathspec elements as errors */
566         if (pathspec && error_unmatch) {
567                 int num;
568                 for (num = 0; pathspec[num]; num++)
569                         ;
570                 ps_matched = xcalloc(1, num);
571         }
572
573         if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
574                 die("ls-files --ignored needs some exclude pattern");
575
576         /* With no flags, we default to showing the cached files */
577         if (!(show_stage | show_deleted | show_others | show_unmerged |
578               show_killed | show_modified | show_resolve_undo))
579                 show_cached = 1;
580
581         if (prefix)
582                 prune_cache(prefix);
583         if (with_tree) {
584                 /*
585                  * Basic sanity check; show-stages and show-unmerged
586                  * would not make any sense with this option.
587                  */
588                 if (show_stage || show_unmerged)
589                         die("ls-files --with-tree is incompatible with -s or -u");
590                 overlay_tree_on_cache(with_tree, prefix);
591         }
592         show_files(&dir, prefix);
593         if (show_resolve_undo)
594                 show_ru_info(prefix);
595
596         if (ps_matched) {
597                 int bad;
598                 bad = report_path_error(ps_matched, pathspec, prefix_offset);
599                 if (bad)
600                         fprintf(stderr, "Did you forget to 'git add'?\n");
601
602                 return bad ? 1 : 0;
603         }
604
605         return 0;
606 }