rev-parse: check i before using argv[i] against argc
[git/jrn.git] / builtin / rev-parse.c
blob068fd17ac91be66d831cb22461013bc24f9d1c02
1 /*
2 * rev-parse.c
4 * Copyright (C) Linus Torvalds, 2005
5 */
6 #include "cache.h"
7 #include "commit.h"
8 #include "refs.h"
9 #include "quote.h"
10 #include "builtin.h"
11 #include "parse-options.h"
13 #define DO_REVS 1
14 #define DO_NOREV 2
15 #define DO_FLAGS 4
16 #define DO_NONFLAGS 8
17 static int filter = ~0;
19 static const char *def;
21 #define NORMAL 0
22 #define REVERSED 1
23 static int show_type = NORMAL;
25 #define SHOW_SYMBOLIC_ASIS 1
26 #define SHOW_SYMBOLIC_FULL 2
27 static int symbolic;
28 static int abbrev;
29 static int abbrev_ref;
30 static int abbrev_ref_strict;
31 static int output_sq;
34 * Some arguments are relevant "revision" arguments,
35 * others are about output format or other details.
36 * This sorts it all out.
38 static int is_rev_argument(const char *arg)
40 static const char *rev_args[] = {
41 "--all",
42 "--bisect",
43 "--dense",
44 "--branches=",
45 "--branches",
46 "--header",
47 "--ignore-missing",
48 "--max-age=",
49 "--max-count=",
50 "--min-age=",
51 "--no-merges",
52 "--min-parents=",
53 "--no-min-parents",
54 "--max-parents=",
55 "--no-max-parents",
56 "--objects",
57 "--objects-edge",
58 "--parents",
59 "--pretty",
60 "--remotes=",
61 "--remotes",
62 "--glob=",
63 "--sparse",
64 "--tags=",
65 "--tags",
66 "--topo-order",
67 "--date-order",
68 "--unpacked",
69 NULL
71 const char **p = rev_args;
73 /* accept -<digit>, like traditional "head" */
74 if ((*arg == '-') && isdigit(arg[1]))
75 return 1;
77 for (;;) {
78 const char *str = *p++;
79 int len;
80 if (!str)
81 return 0;
82 len = strlen(str);
83 if (!strcmp(arg, str) ||
84 (str[len-1] == '=' && !strncmp(arg, str, len)))
85 return 1;
89 /* Output argument as a string, either SQ or normal */
90 static void show(const char *arg)
92 if (output_sq) {
93 int sq = '\'', ch;
95 putchar(sq);
96 while ((ch = *arg++)) {
97 if (ch == sq)
98 fputs("'\\'", stdout);
99 putchar(ch);
101 putchar(sq);
102 putchar(' ');
104 else
105 puts(arg);
108 /* Like show(), but with a negation prefix according to type */
109 static void show_with_type(int type, const char *arg)
111 if (type != show_type)
112 putchar('^');
113 show(arg);
116 /* Output a revision, only if filter allows it */
117 static void show_rev(int type, const unsigned char *sha1, const char *name)
119 if (!(filter & DO_REVS))
120 return;
121 def = NULL;
123 if ((symbolic || abbrev_ref) && name) {
124 if (symbolic == SHOW_SYMBOLIC_FULL || abbrev_ref) {
125 unsigned char discard[20];
126 char *full;
128 switch (dwim_ref(name, strlen(name), discard, &full)) {
129 case 0:
131 * Not found -- not a ref. We could
132 * emit "name" here, but symbolic-full
133 * users are interested in finding the
134 * refs spelled in full, and they would
135 * need to filter non-refs if we did so.
137 break;
138 case 1: /* happy */
139 if (abbrev_ref)
140 full = shorten_unambiguous_ref(full,
141 abbrev_ref_strict);
142 show_with_type(type, full);
143 break;
144 default: /* ambiguous */
145 error("refname '%s' is ambiguous", name);
146 break;
148 } else {
149 show_with_type(type, name);
152 else if (abbrev)
153 show_with_type(type, find_unique_abbrev(sha1, abbrev));
154 else
155 show_with_type(type, sha1_to_hex(sha1));
158 /* Output a flag, only if filter allows it. */
159 static int show_flag(const char *arg)
161 if (!(filter & DO_FLAGS))
162 return 0;
163 if (filter & (is_rev_argument(arg) ? DO_REVS : DO_NOREV)) {
164 show(arg);
165 return 1;
167 return 0;
170 static int show_default(void)
172 const char *s = def;
174 if (s) {
175 unsigned char sha1[20];
177 def = NULL;
178 if (!get_sha1(s, sha1)) {
179 show_rev(NORMAL, sha1, s);
180 return 1;
183 return 0;
186 static int show_reference(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
188 show_rev(NORMAL, sha1, refname);
189 return 0;
192 static int anti_reference(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
194 show_rev(REVERSED, sha1, refname);
195 return 0;
198 static int show_abbrev(const unsigned char *sha1, void *cb_data)
200 show_rev(NORMAL, sha1, NULL);
201 return 0;
204 static void show_datestring(const char *flag, const char *datestr)
206 static char buffer[100];
208 /* date handling requires both flags and revs */
209 if ((filter & (DO_FLAGS | DO_REVS)) != (DO_FLAGS | DO_REVS))
210 return;
211 snprintf(buffer, sizeof(buffer), "%s%lu", flag, approxidate(datestr));
212 show(buffer);
215 static int show_file(const char *arg, int output_prefix)
217 show_default();
218 if ((filter & (DO_NONFLAGS|DO_NOREV)) == (DO_NONFLAGS|DO_NOREV)) {
219 if (output_prefix) {
220 const char *prefix = startup_info->prefix;
221 show(prefix_filename(prefix,
222 prefix ? strlen(prefix) : 0,
223 arg));
224 } else
225 show(arg);
226 return 1;
228 return 0;
231 static int try_difference(const char *arg)
233 char *dotdot;
234 unsigned char sha1[20];
235 unsigned char end[20];
236 const char *next;
237 const char *this;
238 int symmetric;
239 static const char head_by_default[] = "HEAD";
241 if (!(dotdot = strstr(arg, "..")))
242 return 0;
243 next = dotdot + 2;
244 this = arg;
245 symmetric = (*next == '.');
247 *dotdot = 0;
248 next += symmetric;
250 if (!*next)
251 next = head_by_default;
252 if (dotdot == arg)
253 this = head_by_default;
255 if (this == head_by_default && next == head_by_default &&
256 !symmetric) {
258 * Just ".."? That is not a range but the
259 * pathspec for the parent directory.
261 *dotdot = '.';
262 return 0;
265 if (!get_sha1_committish(this, sha1) && !get_sha1_committish(next, end)) {
266 show_rev(NORMAL, end, next);
267 show_rev(symmetric ? NORMAL : REVERSED, sha1, this);
268 if (symmetric) {
269 struct commit_list *exclude;
270 struct commit *a, *b;
271 a = lookup_commit_reference(sha1);
272 b = lookup_commit_reference(end);
273 exclude = get_merge_bases(a, b, 1);
274 while (exclude) {
275 struct commit_list *n = exclude->next;
276 show_rev(REVERSED,
277 exclude->item->object.sha1,NULL);
278 free(exclude);
279 exclude = n;
282 return 1;
284 *dotdot = '.';
285 return 0;
288 static int try_parent_shorthands(const char *arg)
290 char *dotdot;
291 unsigned char sha1[20];
292 struct commit *commit;
293 struct commit_list *parents;
294 int parents_only;
296 if ((dotdot = strstr(arg, "^!")))
297 parents_only = 0;
298 else if ((dotdot = strstr(arg, "^@")))
299 parents_only = 1;
301 if (!dotdot || dotdot[2])
302 return 0;
304 *dotdot = 0;
305 if (get_sha1_committish(arg, sha1))
306 return 0;
308 if (!parents_only)
309 show_rev(NORMAL, sha1, arg);
310 commit = lookup_commit_reference(sha1);
311 for (parents = commit->parents; parents; parents = parents->next)
312 show_rev(parents_only ? NORMAL : REVERSED,
313 parents->item->object.sha1, arg);
315 return 1;
318 static int parseopt_dump(const struct option *o, const char *arg, int unset)
320 struct strbuf *parsed = o->value;
321 if (unset)
322 strbuf_addf(parsed, " --no-%s", o->long_name);
323 else if (o->short_name)
324 strbuf_addf(parsed, " -%c", o->short_name);
325 else
326 strbuf_addf(parsed, " --%s", o->long_name);
327 if (arg) {
328 strbuf_addch(parsed, ' ');
329 sq_quote_buf(parsed, arg);
331 return 0;
334 static const char *skipspaces(const char *s)
336 while (isspace(*s))
337 s++;
338 return s;
341 static int cmd_parseopt(int argc, const char **argv, const char *prefix)
343 static int keep_dashdash = 0, stop_at_non_option = 0;
344 static char const * const parseopt_usage[] = {
345 N_("git rev-parse --parseopt [options] -- [<args>...]"),
346 NULL
348 static struct option parseopt_opts[] = {
349 OPT_BOOL(0, "keep-dashdash", &keep_dashdash,
350 N_("keep the `--` passed as an arg")),
351 OPT_BOOL(0, "stop-at-non-option", &stop_at_non_option,
352 N_("stop parsing after the "
353 "first non-option argument")),
354 OPT_END(),
357 struct strbuf sb = STRBUF_INIT, parsed = STRBUF_INIT;
358 const char **usage = NULL;
359 struct option *opts = NULL;
360 int onb = 0, osz = 0, unb = 0, usz = 0;
362 strbuf_addstr(&parsed, "set --");
363 argc = parse_options(argc, argv, prefix, parseopt_opts, parseopt_usage,
364 PARSE_OPT_KEEP_DASHDASH);
365 if (argc < 1 || strcmp(argv[0], "--"))
366 usage_with_options(parseopt_usage, parseopt_opts);
368 /* get the usage up to the first line with a -- on it */
369 for (;;) {
370 if (strbuf_getline(&sb, stdin, '\n') == EOF)
371 die("premature end of input");
372 ALLOC_GROW(usage, unb + 1, usz);
373 if (!strcmp("--", sb.buf)) {
374 if (unb < 1)
375 die("no usage string given before the `--' separator");
376 usage[unb] = NULL;
377 break;
379 usage[unb++] = strbuf_detach(&sb, NULL);
382 /* parse: (<short>|<short>,<long>|<long>)[=?]? SP+ <help> */
383 while (strbuf_getline(&sb, stdin, '\n') != EOF) {
384 const char *s;
385 struct option *o;
387 if (!sb.len)
388 continue;
390 ALLOC_GROW(opts, onb + 1, osz);
391 memset(opts + onb, 0, sizeof(opts[onb]));
393 o = &opts[onb++];
394 s = strchr(sb.buf, ' ');
395 if (!s || *sb.buf == ' ') {
396 o->type = OPTION_GROUP;
397 o->help = xstrdup(skipspaces(sb.buf));
398 continue;
401 o->type = OPTION_CALLBACK;
402 o->help = xstrdup(skipspaces(s));
403 o->value = &parsed;
404 o->flags = PARSE_OPT_NOARG;
405 o->callback = &parseopt_dump;
406 while (s > sb.buf && strchr("*=?!", s[-1])) {
407 switch (*--s) {
408 case '=':
409 o->flags &= ~PARSE_OPT_NOARG;
410 break;
411 case '?':
412 o->flags &= ~PARSE_OPT_NOARG;
413 o->flags |= PARSE_OPT_OPTARG;
414 break;
415 case '!':
416 o->flags |= PARSE_OPT_NONEG;
417 break;
418 case '*':
419 o->flags |= PARSE_OPT_HIDDEN;
420 break;
424 if (s - sb.buf == 1) /* short option only */
425 o->short_name = *sb.buf;
426 else if (sb.buf[1] != ',') /* long option only */
427 o->long_name = xmemdupz(sb.buf, s - sb.buf);
428 else {
429 o->short_name = *sb.buf;
430 o->long_name = xmemdupz(sb.buf + 2, s - sb.buf - 2);
433 strbuf_release(&sb);
435 /* put an OPT_END() */
436 ALLOC_GROW(opts, onb + 1, osz);
437 memset(opts + onb, 0, sizeof(opts[onb]));
438 argc = parse_options(argc, argv, prefix, opts, usage,
439 (keep_dashdash ? PARSE_OPT_KEEP_DASHDASH : 0) |
440 (stop_at_non_option ? PARSE_OPT_STOP_AT_NON_OPTION : 0) |
441 PARSE_OPT_SHELL_EVAL);
443 strbuf_addf(&parsed, " --");
444 sq_quote_argv(&parsed, argv, 0);
445 puts(parsed.buf);
446 return 0;
449 static int cmd_sq_quote(int argc, const char **argv)
451 struct strbuf buf = STRBUF_INIT;
453 if (argc)
454 sq_quote_argv(&buf, argv, 0);
455 printf("%s\n", buf.buf);
456 strbuf_release(&buf);
458 return 0;
461 static void die_no_single_rev(int quiet)
463 if (quiet)
464 exit(1);
465 else
466 die("Needed a single revision");
469 static const char builtin_rev_parse_usage[] =
470 N_("git rev-parse --parseopt [options] -- [<args>...]\n"
471 " or: git rev-parse --sq-quote [<arg>...]\n"
472 " or: git rev-parse [options] [<arg>...]\n"
473 "\n"
474 "Run \"git rev-parse --parseopt -h\" for more information on the first usage.");
476 int cmd_rev_parse(int argc, const char **argv, const char *prefix)
478 int i, as_is = 0, verify = 0, quiet = 0, revs_count = 0, type = 0;
479 int output_prefix = 0;
480 unsigned char sha1[20];
481 const char *name = NULL;
483 if (argc > 1 && !strcmp("--parseopt", argv[1]))
484 return cmd_parseopt(argc - 1, argv + 1, prefix);
486 if (argc > 1 && !strcmp("--sq-quote", argv[1]))
487 return cmd_sq_quote(argc - 2, argv + 2);
489 if (argc > 1 && !strcmp("-h", argv[1]))
490 usage(builtin_rev_parse_usage);
492 prefix = setup_git_directory();
493 git_config(git_default_config, NULL);
494 for (i = 1; i < argc; i++) {
495 const char *arg = argv[i];
497 if (as_is) {
498 if (show_file(arg, output_prefix) && as_is < 2)
499 verify_filename(prefix, arg, 0);
500 continue;
502 if (!strcmp(arg,"-n")) {
503 if (++i >= argc)
504 die("-n requires an argument");
505 if ((filter & DO_FLAGS) && (filter & DO_REVS)) {
506 show(arg);
507 show(argv[i]);
509 continue;
511 if (!prefixcmp(arg, "-n")) {
512 if ((filter & DO_FLAGS) && (filter & DO_REVS))
513 show(arg);
514 continue;
517 if (*arg == '-') {
518 if (!strcmp(arg, "--")) {
519 as_is = 2;
520 /* Pass on the "--" if we show anything but files.. */
521 if (filter & (DO_FLAGS | DO_REVS))
522 show_file(arg, 0);
523 continue;
525 if (!strcmp(arg, "--default")) {
526 def = argv[++i];
527 if (!def)
528 die("--default requires an argument");
529 continue;
531 if (!strcmp(arg, "--prefix")) {
532 prefix = argv[++i];
533 if (!prefix)
534 die("--prefix requires an argument");
535 startup_info->prefix = prefix;
536 output_prefix = 1;
537 continue;
539 if (!strcmp(arg, "--revs-only")) {
540 filter &= ~DO_NOREV;
541 continue;
543 if (!strcmp(arg, "--no-revs")) {
544 filter &= ~DO_REVS;
545 continue;
547 if (!strcmp(arg, "--flags")) {
548 filter &= ~DO_NONFLAGS;
549 continue;
551 if (!strcmp(arg, "--no-flags")) {
552 filter &= ~DO_FLAGS;
553 continue;
555 if (!strcmp(arg, "--verify")) {
556 filter &= ~(DO_FLAGS|DO_NOREV);
557 verify = 1;
558 continue;
560 if (!strcmp(arg, "--quiet") || !strcmp(arg, "-q")) {
561 quiet = 1;
562 continue;
564 if (!strcmp(arg, "--short") ||
565 !prefixcmp(arg, "--short=")) {
566 filter &= ~(DO_FLAGS|DO_NOREV);
567 verify = 1;
568 abbrev = DEFAULT_ABBREV;
569 if (arg[7] == '=')
570 abbrev = strtoul(arg + 8, NULL, 10);
571 if (abbrev < MINIMUM_ABBREV)
572 abbrev = MINIMUM_ABBREV;
573 else if (40 <= abbrev)
574 abbrev = 40;
575 continue;
577 if (!strcmp(arg, "--sq")) {
578 output_sq = 1;
579 continue;
581 if (!strcmp(arg, "--not")) {
582 show_type ^= REVERSED;
583 continue;
585 if (!strcmp(arg, "--symbolic")) {
586 symbolic = SHOW_SYMBOLIC_ASIS;
587 continue;
589 if (!strcmp(arg, "--symbolic-full-name")) {
590 symbolic = SHOW_SYMBOLIC_FULL;
591 continue;
593 if (!prefixcmp(arg, "--abbrev-ref") &&
594 (!arg[12] || arg[12] == '=')) {
595 abbrev_ref = 1;
596 abbrev_ref_strict = warn_ambiguous_refs;
597 if (arg[12] == '=') {
598 if (!strcmp(arg + 13, "strict"))
599 abbrev_ref_strict = 1;
600 else if (!strcmp(arg + 13, "loose"))
601 abbrev_ref_strict = 0;
602 else
603 die("unknown mode for %s", arg);
605 continue;
607 if (!strcmp(arg, "--all")) {
608 for_each_ref(show_reference, NULL);
609 continue;
611 if (!prefixcmp(arg, "--disambiguate=")) {
612 for_each_abbrev(arg + 15, show_abbrev, NULL);
613 continue;
615 if (!strcmp(arg, "--bisect")) {
616 for_each_ref_in("refs/bisect/bad", show_reference, NULL);
617 for_each_ref_in("refs/bisect/good", anti_reference, NULL);
618 continue;
620 if (!prefixcmp(arg, "--branches=")) {
621 for_each_glob_ref_in(show_reference, arg + 11,
622 "refs/heads/", NULL);
623 continue;
625 if (!strcmp(arg, "--branches")) {
626 for_each_branch_ref(show_reference, NULL);
627 continue;
629 if (!prefixcmp(arg, "--tags=")) {
630 for_each_glob_ref_in(show_reference, arg + 7,
631 "refs/tags/", NULL);
632 continue;
634 if (!strcmp(arg, "--tags")) {
635 for_each_tag_ref(show_reference, NULL);
636 continue;
638 if (!prefixcmp(arg, "--glob=")) {
639 for_each_glob_ref(show_reference, arg + 7, NULL);
640 continue;
642 if (!prefixcmp(arg, "--remotes=")) {
643 for_each_glob_ref_in(show_reference, arg + 10,
644 "refs/remotes/", NULL);
645 continue;
647 if (!strcmp(arg, "--remotes")) {
648 for_each_remote_ref(show_reference, NULL);
649 continue;
651 if (!strcmp(arg, "--local-env-vars")) {
652 int i;
653 for (i = 0; local_repo_env[i]; i++)
654 printf("%s\n", local_repo_env[i]);
655 continue;
657 if (!strcmp(arg, "--show-toplevel")) {
658 const char *work_tree = get_git_work_tree();
659 if (work_tree)
660 puts(work_tree);
661 continue;
663 if (!strcmp(arg, "--show-prefix")) {
664 if (prefix)
665 puts(prefix);
666 else
667 putchar('\n');
668 continue;
670 if (!strcmp(arg, "--show-cdup")) {
671 const char *pfx = prefix;
672 if (!is_inside_work_tree()) {
673 const char *work_tree =
674 get_git_work_tree();
675 if (work_tree)
676 printf("%s\n", work_tree);
677 continue;
679 while (pfx) {
680 pfx = strchr(pfx, '/');
681 if (pfx) {
682 pfx++;
683 printf("../");
686 putchar('\n');
687 continue;
689 if (!strcmp(arg, "--git-dir")) {
690 const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
691 static char cwd[PATH_MAX];
692 int len;
693 if (gitdir) {
694 puts(gitdir);
695 continue;
697 if (!prefix) {
698 puts(".git");
699 continue;
701 if (!getcwd(cwd, PATH_MAX))
702 die_errno("unable to get current working directory");
703 len = strlen(cwd);
704 printf("%s%s.git\n", cwd, len && cwd[len-1] != '/' ? "/" : "");
705 continue;
707 if (!strcmp(arg, "--resolve-git-dir")) {
708 const char *gitdir = argv[++i];
709 if (!gitdir)
710 die("--resolve-git-dir requires an argument");
711 gitdir = resolve_gitdir(gitdir);
712 if (!gitdir)
713 die("not a gitdir '%s'", argv[i]);
714 puts(gitdir);
715 continue;
717 if (!strcmp(arg, "--is-inside-git-dir")) {
718 printf("%s\n", is_inside_git_dir() ? "true"
719 : "false");
720 continue;
722 if (!strcmp(arg, "--is-inside-work-tree")) {
723 printf("%s\n", is_inside_work_tree() ? "true"
724 : "false");
725 continue;
727 if (!strcmp(arg, "--is-bare-repository")) {
728 printf("%s\n", is_bare_repository() ? "true"
729 : "false");
730 continue;
732 if (!prefixcmp(arg, "--since=")) {
733 show_datestring("--max-age=", arg+8);
734 continue;
736 if (!prefixcmp(arg, "--after=")) {
737 show_datestring("--max-age=", arg+8);
738 continue;
740 if (!prefixcmp(arg, "--before=")) {
741 show_datestring("--min-age=", arg+9);
742 continue;
744 if (!prefixcmp(arg, "--until=")) {
745 show_datestring("--min-age=", arg+8);
746 continue;
748 if (show_flag(arg) && verify)
749 die_no_single_rev(quiet);
750 continue;
753 /* Not a flag argument */
754 if (try_difference(arg))
755 continue;
756 if (try_parent_shorthands(arg))
757 continue;
758 name = arg;
759 type = NORMAL;
760 if (*arg == '^') {
761 name++;
762 type = REVERSED;
764 if (!get_sha1(name, sha1)) {
765 if (verify)
766 revs_count++;
767 else
768 show_rev(type, sha1, name);
769 continue;
771 if (verify)
772 die_no_single_rev(quiet);
773 as_is = 1;
774 if (!show_file(arg, output_prefix))
775 continue;
776 verify_filename(prefix, arg, 1);
778 if (verify) {
779 if (revs_count == 1) {
780 show_rev(type, sha1, name);
781 return 0;
782 } else if (revs_count == 0 && show_default())
783 return 0;
784 die_no_single_rev(quiet);
785 } else
786 show_default();
787 return 0;