Document struct match_attr
[git] / attr.c
1 /*
2  * Handle git attributes.  See gitattributes(5) for a description of
3  * the file syntax, and Documentation/technical/api-gitattributes.txt
4  * for a description of the API.
5  *
6  * One basic design decision here is that we are not going to support
7  * an insanely large number of attributes.
8  */
9
10 #define NO_THE_INDEX_COMPATIBILITY_MACROS
11 #include "cache.h"
12 #include "exec_cmd.h"
13 #include "attr.h"
14
15 const char git_attr__true[] = "(builtin)true";
16 const char git_attr__false[] = "\0(builtin)false";
17 static const char git_attr__unknown[] = "(builtin)unknown";
18 #define ATTR__TRUE git_attr__true
19 #define ATTR__FALSE git_attr__false
20 #define ATTR__UNSET NULL
21 #define ATTR__UNKNOWN git_attr__unknown
22
23 static const char *attributes_file;
24
25 /* This is a randomly chosen prime. */
26 #define HASHSIZE 257
27
28 #ifndef DEBUG_ATTR
29 #define DEBUG_ATTR 0
30 #endif
31
32 struct git_attr {
33         struct git_attr *next;
34         unsigned h;
35         int attr_nr;
36         char name[FLEX_ARRAY];
37 };
38 static int attr_nr;
39
40 static struct git_attr_check *check_all_attr;
41 static struct git_attr *(git_attr_hash[HASHSIZE]);
42
43 static unsigned hash_name(const char *name, int namelen)
44 {
45         unsigned val = 0, c;
46
47         while (namelen--) {
48                 c = *name++;
49                 val = ((val << 7) | (val >> 22)) ^ c;
50         }
51         return val;
52 }
53
54 static int invalid_attr_name(const char *name, int namelen)
55 {
56         /*
57          * Attribute name cannot begin with '-' and from
58          * [-A-Za-z0-9_.].  We'd specifically exclude '=' for now,
59          * as we might later want to allow non-binary value for
60          * attributes, e.g. "*.svg      merge=special-merge-program-for-svg"
61          */
62         if (*name == '-')
63                 return -1;
64         while (namelen--) {
65                 char ch = *name++;
66                 if (! (ch == '-' || ch == '.' || ch == '_' ||
67                        ('0' <= ch && ch <= '9') ||
68                        ('a' <= ch && ch <= 'z') ||
69                        ('A' <= ch && ch <= 'Z')) )
70                         return -1;
71         }
72         return 0;
73 }
74
75 static struct git_attr *git_attr_internal(const char *name, int len)
76 {
77         unsigned hval = hash_name(name, len);
78         unsigned pos = hval % HASHSIZE;
79         struct git_attr *a;
80
81         for (a = git_attr_hash[pos]; a; a = a->next) {
82                 if (a->h == hval &&
83                     !memcmp(a->name, name, len) && !a->name[len])
84                         return a;
85         }
86
87         if (invalid_attr_name(name, len))
88                 return NULL;
89
90         a = xmalloc(sizeof(*a) + len + 1);
91         memcpy(a->name, name, len);
92         a->name[len] = 0;
93         a->h = hval;
94         a->next = git_attr_hash[pos];
95         a->attr_nr = attr_nr++;
96         git_attr_hash[pos] = a;
97
98         check_all_attr = xrealloc(check_all_attr,
99                                   sizeof(*check_all_attr) * attr_nr);
100         check_all_attr[a->attr_nr].attr = a;
101         check_all_attr[a->attr_nr].value = ATTR__UNKNOWN;
102         return a;
103 }
104
105 struct git_attr *git_attr(const char *name)
106 {
107         return git_attr_internal(name, strlen(name));
108 }
109
110 /* What does a matched pattern decide? */
111 struct attr_state {
112         struct git_attr *attr;
113         const char *setto;
114 };
115
116 /*
117  * One rule, as from a .gitattributes file.
118  *
119  * If is_macro is true, then u.attr is a pointer to the git_attr being
120  * defined.
121  *
122  * If is_macro is false, then u.pattern points at the filename pattern
123  * to which the rule applies.  (The memory pointed to is part of the
124  * memory block allocated for the match_attr instance.)
125  *
126  * In either case, num_attr is the number of attributes affected by
127  * this rule, and state is an array listing them.  The attributes are
128  * listed as they appear in the file (macros unexpanded).
129  */
130 struct match_attr {
131         union {
132                 char *pattern;
133                 struct git_attr *attr;
134         } u;
135         char is_macro;
136         unsigned num_attr;
137         struct attr_state state[FLEX_ARRAY];
138 };
139
140 static const char blank[] = " \t\r\n";
141
142 static const char *parse_attr(const char *src, int lineno, const char *cp,
143                               int *num_attr, struct match_attr *res)
144 {
145         const char *ep, *equals;
146         int len;
147
148         ep = cp + strcspn(cp, blank);
149         equals = strchr(cp, '=');
150         if (equals && ep < equals)
151                 equals = NULL;
152         if (equals)
153                 len = equals - cp;
154         else
155                 len = ep - cp;
156         if (!res) {
157                 if (*cp == '-' || *cp == '!') {
158                         cp++;
159                         len--;
160                 }
161                 if (invalid_attr_name(cp, len)) {
162                         fprintf(stderr,
163                                 "%.*s is not a valid attribute name: %s:%d\n",
164                                 len, cp, src, lineno);
165                         return NULL;
166                 }
167         } else {
168                 struct attr_state *e;
169
170                 e = &(res->state[*num_attr]);
171                 if (*cp == '-' || *cp == '!') {
172                         e->setto = (*cp == '-') ? ATTR__FALSE : ATTR__UNSET;
173                         cp++;
174                         len--;
175                 }
176                 else if (!equals)
177                         e->setto = ATTR__TRUE;
178                 else {
179                         e->setto = xmemdupz(equals + 1, ep - equals - 1);
180                 }
181                 e->attr = git_attr_internal(cp, len);
182         }
183         (*num_attr)++;
184         return ep + strspn(ep, blank);
185 }
186
187 static struct match_attr *parse_attr_line(const char *line, const char *src,
188                                           int lineno, int macro_ok)
189 {
190         int namelen;
191         int num_attr;
192         const char *cp, *name;
193         struct match_attr *res = NULL;
194         int pass;
195         int is_macro;
196
197         cp = line + strspn(line, blank);
198         if (!*cp || *cp == '#')
199                 return NULL;
200         name = cp;
201         namelen = strcspn(name, blank);
202         if (strlen(ATTRIBUTE_MACRO_PREFIX) < namelen &&
203             !prefixcmp(name, ATTRIBUTE_MACRO_PREFIX)) {
204                 if (!macro_ok) {
205                         fprintf(stderr, "%s not allowed: %s:%d\n",
206                                 name, src, lineno);
207                         return NULL;
208                 }
209                 is_macro = 1;
210                 name += strlen(ATTRIBUTE_MACRO_PREFIX);
211                 name += strspn(name, blank);
212                 namelen = strcspn(name, blank);
213                 if (invalid_attr_name(name, namelen)) {
214                         fprintf(stderr,
215                                 "%.*s is not a valid attribute name: %s:%d\n",
216                                 namelen, name, src, lineno);
217                         return NULL;
218                 }
219         }
220         else
221                 is_macro = 0;
222
223         for (pass = 0; pass < 2; pass++) {
224                 /* pass 0 counts and allocates, pass 1 fills */
225                 num_attr = 0;
226                 cp = name + namelen;
227                 cp = cp + strspn(cp, blank);
228                 while (*cp) {
229                         cp = parse_attr(src, lineno, cp, &num_attr, res);
230                         if (!cp)
231                                 return NULL;
232                 }
233                 if (pass)
234                         break;
235                 res = xcalloc(1,
236                               sizeof(*res) +
237                               sizeof(struct attr_state) * num_attr +
238                               (is_macro ? 0 : namelen + 1));
239                 if (is_macro)
240                         res->u.attr = git_attr_internal(name, namelen);
241                 else {
242                         res->u.pattern = (char *)&(res->state[num_attr]);
243                         memcpy(res->u.pattern, name, namelen);
244                         res->u.pattern[namelen] = 0;
245                 }
246                 res->is_macro = is_macro;
247                 res->num_attr = num_attr;
248         }
249         return res;
250 }
251
252 /*
253  * Like info/exclude and .gitignore, the attribute information can
254  * come from many places.
255  *
256  * (1) .gitattribute file of the same directory;
257  * (2) .gitattribute file of the parent directory if (1) does not have
258  *      any match; this goes recursively upwards, just like .gitignore.
259  * (3) $GIT_DIR/info/attributes, which overrides both of the above.
260  *
261  * In the same file, later entries override the earlier match, so in the
262  * global list, we would have entries from info/attributes the earliest
263  * (reading the file from top to bottom), .gitattribute of the root
264  * directory (again, reading the file from top to bottom) down to the
265  * current directory, and then scan the list backwards to find the first match.
266  * This is exactly the same as what excluded() does in dir.c to deal with
267  * .gitignore
268  */
269
270 static struct attr_stack {
271         struct attr_stack *prev;
272         char *origin;
273         unsigned num_matches;
274         unsigned alloc;
275         struct match_attr **attrs;
276 } *attr_stack;
277
278 static void free_attr_elem(struct attr_stack *e)
279 {
280         int i;
281         free(e->origin);
282         for (i = 0; i < e->num_matches; i++) {
283                 struct match_attr *a = e->attrs[i];
284                 int j;
285                 for (j = 0; j < a->num_attr; j++) {
286                         const char *setto = a->state[j].setto;
287                         if (setto == ATTR__TRUE ||
288                             setto == ATTR__FALSE ||
289                             setto == ATTR__UNSET ||
290                             setto == ATTR__UNKNOWN)
291                                 ;
292                         else
293                                 free((char *) setto);
294                 }
295                 free(a);
296         }
297         free(e);
298 }
299
300 static const char *builtin_attr[] = {
301         "[attr]binary -diff -text",
302         NULL,
303 };
304
305 static void handle_attr_line(struct attr_stack *res,
306                              const char *line,
307                              const char *src,
308                              int lineno,
309                              int macro_ok)
310 {
311         struct match_attr *a;
312
313         a = parse_attr_line(line, src, lineno, macro_ok);
314         if (!a)
315                 return;
316         if (res->alloc <= res->num_matches) {
317                 res->alloc = alloc_nr(res->num_matches);
318                 res->attrs = xrealloc(res->attrs,
319                                       sizeof(struct match_attr *) *
320                                       res->alloc);
321         }
322         res->attrs[res->num_matches++] = a;
323 }
324
325 static struct attr_stack *read_attr_from_array(const char **list)
326 {
327         struct attr_stack *res;
328         const char *line;
329         int lineno = 0;
330
331         res = xcalloc(1, sizeof(*res));
332         while ((line = *(list++)) != NULL)
333                 handle_attr_line(res, line, "[builtin]", ++lineno, 1);
334         return res;
335 }
336
337 static enum git_attr_direction direction;
338 static struct index_state *use_index;
339
340 static struct attr_stack *read_attr_from_file(const char *path, int macro_ok)
341 {
342         FILE *fp = fopen(path, "r");
343         struct attr_stack *res;
344         char buf[2048];
345         int lineno = 0;
346
347         if (!fp)
348                 return NULL;
349         res = xcalloc(1, sizeof(*res));
350         while (fgets(buf, sizeof(buf), fp))
351                 handle_attr_line(res, buf, path, ++lineno, macro_ok);
352         fclose(fp);
353         return res;
354 }
355
356 static void *read_index_data(const char *path)
357 {
358         int pos, len;
359         unsigned long sz;
360         enum object_type type;
361         void *data;
362         struct index_state *istate = use_index ? use_index : &the_index;
363
364         len = strlen(path);
365         pos = index_name_pos(istate, path, len);
366         if (pos < 0) {
367                 /*
368                  * We might be in the middle of a merge, in which
369                  * case we would read stage #2 (ours).
370                  */
371                 int i;
372                 for (i = -pos - 1;
373                      (pos < 0 && i < istate->cache_nr &&
374                       !strcmp(istate->cache[i]->name, path));
375                      i++)
376                         if (ce_stage(istate->cache[i]) == 2)
377                                 pos = i;
378         }
379         if (pos < 0)
380                 return NULL;
381         data = read_sha1_file(istate->cache[pos]->sha1, &type, &sz);
382         if (!data || type != OBJ_BLOB) {
383                 free(data);
384                 return NULL;
385         }
386         return data;
387 }
388
389 static struct attr_stack *read_attr_from_index(const char *path, int macro_ok)
390 {
391         struct attr_stack *res;
392         char *buf, *sp;
393         int lineno = 0;
394
395         buf = read_index_data(path);
396         if (!buf)
397                 return NULL;
398
399         res = xcalloc(1, sizeof(*res));
400         for (sp = buf; *sp; ) {
401                 char *ep;
402                 int more;
403                 for (ep = sp; *ep && *ep != '\n'; ep++)
404                         ;
405                 more = (*ep == '\n');
406                 *ep = '\0';
407                 handle_attr_line(res, sp, path, ++lineno, macro_ok);
408                 sp = ep + more;
409         }
410         free(buf);
411         return res;
412 }
413
414 static struct attr_stack *read_attr(const char *path, int macro_ok)
415 {
416         struct attr_stack *res;
417
418         if (direction == GIT_ATTR_CHECKOUT) {
419                 res = read_attr_from_index(path, macro_ok);
420                 if (!res)
421                         res = read_attr_from_file(path, macro_ok);
422         }
423         else if (direction == GIT_ATTR_CHECKIN) {
424                 res = read_attr_from_file(path, macro_ok);
425                 if (!res)
426                         /*
427                          * There is no checked out .gitattributes file there, but
428                          * we might have it in the index.  We allow operation in a
429                          * sparsely checked out work tree, so read from it.
430                          */
431                         res = read_attr_from_index(path, macro_ok);
432         }
433         else
434                 res = read_attr_from_index(path, macro_ok);
435         if (!res)
436                 res = xcalloc(1, sizeof(*res));
437         return res;
438 }
439
440 #if DEBUG_ATTR
441 static void debug_info(const char *what, struct attr_stack *elem)
442 {
443         fprintf(stderr, "%s: %s\n", what, elem->origin ? elem->origin : "()");
444 }
445 static void debug_set(const char *what, const char *match, struct git_attr *attr, const void *v)
446 {
447         const char *value = v;
448
449         if (ATTR_TRUE(value))
450                 value = "set";
451         else if (ATTR_FALSE(value))
452                 value = "unset";
453         else if (ATTR_UNSET(value))
454                 value = "unspecified";
455
456         fprintf(stderr, "%s: %s => %s (%s)\n",
457                 what, attr->name, (char *) value, match);
458 }
459 #define debug_push(a) debug_info("push", (a))
460 #define debug_pop(a) debug_info("pop", (a))
461 #else
462 #define debug_push(a) do { ; } while (0)
463 #define debug_pop(a) do { ; } while (0)
464 #define debug_set(a,b,c,d) do { ; } while (0)
465 #endif
466
467 static void drop_attr_stack(void)
468 {
469         while (attr_stack) {
470                 struct attr_stack *elem = attr_stack;
471                 attr_stack = elem->prev;
472                 free_attr_elem(elem);
473         }
474 }
475
476 static const char *git_etc_gitattributes(void)
477 {
478         static const char *system_wide;
479         if (!system_wide)
480                 system_wide = system_path(ETC_GITATTRIBUTES);
481         return system_wide;
482 }
483
484 static int git_attr_system(void)
485 {
486         return !git_env_bool("GIT_ATTR_NOSYSTEM", 0);
487 }
488
489 static int git_attr_config(const char *var, const char *value, void *dummy)
490 {
491         if (!strcmp(var, "core.attributesfile"))
492                 return git_config_pathname(&attributes_file, var, value);
493
494         return 0;
495 }
496
497 static void bootstrap_attr_stack(void)
498 {
499         if (!attr_stack) {
500                 struct attr_stack *elem;
501
502                 elem = read_attr_from_array(builtin_attr);
503                 elem->origin = NULL;
504                 elem->prev = attr_stack;
505                 attr_stack = elem;
506
507                 if (git_attr_system()) {
508                         elem = read_attr_from_file(git_etc_gitattributes(), 1);
509                         if (elem) {
510                                 elem->origin = NULL;
511                                 elem->prev = attr_stack;
512                                 attr_stack = elem;
513                         }
514                 }
515
516                 git_config(git_attr_config, NULL);
517                 if (attributes_file) {
518                         elem = read_attr_from_file(attributes_file, 1);
519                         if (elem) {
520                                 elem->origin = NULL;
521                                 elem->prev = attr_stack;
522                                 attr_stack = elem;
523                         }
524                 }
525
526                 if (!is_bare_repository() || direction == GIT_ATTR_INDEX) {
527                         elem = read_attr(GITATTRIBUTES_FILE, 1);
528                         elem->origin = strdup("");
529                         elem->prev = attr_stack;
530                         attr_stack = elem;
531                         debug_push(elem);
532                 }
533
534                 elem = read_attr_from_file(git_path(INFOATTRIBUTES_FILE), 1);
535                 if (!elem)
536                         elem = xcalloc(1, sizeof(*elem));
537                 elem->origin = NULL;
538                 elem->prev = attr_stack;
539                 attr_stack = elem;
540         }
541 }
542
543 static void prepare_attr_stack(const char *path, int dirlen)
544 {
545         struct attr_stack *elem, *info;
546         int len;
547         struct strbuf pathbuf;
548
549         strbuf_init(&pathbuf, dirlen+2+strlen(GITATTRIBUTES_FILE));
550
551         /*
552          * At the bottom of the attribute stack is the built-in
553          * set of attribute definitions, followed by the contents
554          * of $(prefix)/etc/gitattributes and a file specified by
555          * core.attributesfile.  Then, contents from
556          * .gitattribute files from directories closer to the
557          * root to the ones in deeper directories are pushed
558          * to the stack.  Finally, at the very top of the stack
559          * we always keep the contents of $GIT_DIR/info/attributes.
560          *
561          * When checking, we use entries from near the top of the
562          * stack, preferring $GIT_DIR/info/attributes, then
563          * .gitattributes in deeper directories to shallower ones,
564          * and finally use the built-in set as the default.
565          */
566         if (!attr_stack)
567                 bootstrap_attr_stack();
568
569         /*
570          * Pop the "info" one that is always at the top of the stack.
571          */
572         info = attr_stack;
573         attr_stack = info->prev;
574
575         /*
576          * Pop the ones from directories that are not the prefix of
577          * the path we are checking.
578          */
579         while (attr_stack && attr_stack->origin) {
580                 int namelen = strlen(attr_stack->origin);
581
582                 elem = attr_stack;
583                 if (namelen <= dirlen &&
584                     !strncmp(elem->origin, path, namelen))
585                         break;
586
587                 debug_pop(elem);
588                 attr_stack = elem->prev;
589                 free_attr_elem(elem);
590         }
591
592         /*
593          * Read from parent directories and push them down
594          */
595         if (!is_bare_repository() || direction == GIT_ATTR_INDEX) {
596                 while (1) {
597                         char *cp;
598
599                         len = strlen(attr_stack->origin);
600                         if (dirlen <= len)
601                                 break;
602                         strbuf_reset(&pathbuf);
603                         strbuf_add(&pathbuf, path, dirlen);
604                         strbuf_addch(&pathbuf, '/');
605                         cp = strchr(pathbuf.buf + len + 1, '/');
606                         strcpy(cp + 1, GITATTRIBUTES_FILE);
607                         elem = read_attr(pathbuf.buf, 0);
608                         *cp = '\0';
609                         elem->origin = strdup(pathbuf.buf);
610                         elem->prev = attr_stack;
611                         attr_stack = elem;
612                         debug_push(elem);
613                 }
614         }
615
616         strbuf_release(&pathbuf);
617
618         /*
619          * Finally push the "info" one at the top of the stack.
620          */
621         info->prev = attr_stack;
622         attr_stack = info;
623 }
624
625 static int path_matches(const char *pathname, int pathlen,
626                         const char *pattern,
627                         const char *base, int baselen)
628 {
629         if (!strchr(pattern, '/')) {
630                 /* match basename */
631                 const char *basename = strrchr(pathname, '/');
632                 basename = basename ? basename + 1 : pathname;
633                 return (fnmatch(pattern, basename, 0) == 0);
634         }
635         /*
636          * match with FNM_PATHNAME; the pattern has base implicitly
637          * in front of it.
638          */
639         if (*pattern == '/')
640                 pattern++;
641         if (pathlen < baselen ||
642             (baselen && pathname[baselen] != '/') ||
643             strncmp(pathname, base, baselen))
644                 return 0;
645         if (baselen != 0)
646                 baselen++;
647         return fnmatch(pattern, pathname + baselen, FNM_PATHNAME) == 0;
648 }
649
650 static int macroexpand_one(int attr_nr, int rem);
651
652 static int fill_one(const char *what, struct match_attr *a, int rem)
653 {
654         struct git_attr_check *check = check_all_attr;
655         int i;
656
657         for (i = a->num_attr - 1; 0 < rem && 0 <= i; i--) {
658                 struct git_attr *attr = a->state[i].attr;
659                 const char **n = &(check[attr->attr_nr].value);
660                 const char *v = a->state[i].setto;
661
662                 if (*n == ATTR__UNKNOWN) {
663                         debug_set(what,
664                                   a->is_macro ? a->u.attr->name : a->u.pattern,
665                                   attr, v);
666                         *n = v;
667                         rem--;
668                         rem = macroexpand_one(attr->attr_nr, rem);
669                 }
670         }
671         return rem;
672 }
673
674 static int fill(const char *path, int pathlen, struct attr_stack *stk, int rem)
675 {
676         int i;
677         const char *base = stk->origin ? stk->origin : "";
678
679         for (i = stk->num_matches - 1; 0 < rem && 0 <= i; i--) {
680                 struct match_attr *a = stk->attrs[i];
681                 if (a->is_macro)
682                         continue;
683                 if (path_matches(path, pathlen,
684                                  a->u.pattern, base, strlen(base)))
685                         rem = fill_one("fill", a, rem);
686         }
687         return rem;
688 }
689
690 static int macroexpand_one(int attr_nr, int rem)
691 {
692         struct attr_stack *stk;
693         struct match_attr *a = NULL;
694         int i;
695
696         if (check_all_attr[attr_nr].value != ATTR__TRUE)
697                 return rem;
698
699         for (stk = attr_stack; !a && stk; stk = stk->prev)
700                 for (i = stk->num_matches - 1; !a && 0 <= i; i--) {
701                         struct match_attr *ma = stk->attrs[i];
702                         if (!ma->is_macro)
703                                 continue;
704                         if (ma->u.attr->attr_nr == attr_nr)
705                                 a = ma;
706                 }
707
708         if (a)
709                 rem = fill_one("expand", a, rem);
710
711         return rem;
712 }
713
714 int git_checkattr(const char *path, int num, struct git_attr_check *check)
715 {
716         struct attr_stack *stk;
717         const char *cp;
718         int dirlen, pathlen, i, rem;
719
720         bootstrap_attr_stack();
721         for (i = 0; i < attr_nr; i++)
722                 check_all_attr[i].value = ATTR__UNKNOWN;
723
724         pathlen = strlen(path);
725         cp = strrchr(path, '/');
726         if (!cp)
727                 dirlen = 0;
728         else
729                 dirlen = cp - path;
730         prepare_attr_stack(path, dirlen);
731         rem = attr_nr;
732         for (stk = attr_stack; 0 < rem && stk; stk = stk->prev)
733                 rem = fill(path, pathlen, stk, rem);
734
735         for (i = 0; i < num; i++) {
736                 const char *value = check_all_attr[check[i].attr->attr_nr].value;
737                 if (value == ATTR__UNKNOWN)
738                         value = ATTR__UNSET;
739                 check[i].value = value;
740         }
741
742         return 0;
743 }
744
745 void git_attr_set_direction(enum git_attr_direction new, struct index_state *istate)
746 {
747         enum git_attr_direction old = direction;
748
749         if (is_bare_repository() && new != GIT_ATTR_INDEX)
750                 die("BUG: non-INDEX attr direction in a bare repo");
751
752         direction = new;
753         if (new != old)
754                 drop_attr_stack();
755         use_index = istate;
756 }