Commit | Line | Data |
---|---|---|
70827b15 LT |
1 | #include "cache.h" |
2 | #include "builtin.h" | |
3 | #include "exec_cmd.h" | |
8af84dad | 4 | #include "levenshtein.h" |
940208a7 | 5 | #include "help.h" |
6612b9e4 | 6 | #include "common-cmds.h" |
dbfae689 NTND |
7 | #include "string-list.h" |
8 | #include "column.h" | |
816fb46b | 9 | #include "version.h" |
e5618106 | 10 | #include "refs.h" |
64949984 | 11 | |
940208a7 | 12 | void add_cmdname(struct cmdnames *cmds, const char *name, int len) |
70827b15 | 13 | { |
940208a7 | 14 | struct cmdname *ent = xmalloc(sizeof(*ent) + len + 1); |
1eb05690 | 15 | |
70827b15 LT |
16 | ent->len = len; |
17 | memcpy(ent->name, name, len); | |
18 | ent->name[len] = 0; | |
1eb05690 SP |
19 | |
20 | ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc); | |
21 | cmds->names[cmds->cnt++] = ent; | |
70827b15 LT |
22 | } |
23 | ||
8af84dad JS |
24 | static void clean_cmdnames(struct cmdnames *cmds) |
25 | { | |
26 | int i; | |
27 | for (i = 0; i < cmds->cnt; ++i) | |
28 | free(cmds->names[i]); | |
29 | free(cmds->names); | |
30 | cmds->cnt = 0; | |
31 | cmds->alloc = 0; | |
32 | } | |
33 | ||
70827b15 LT |
34 | static int cmdname_compare(const void *a_, const void *b_) |
35 | { | |
36 | struct cmdname *a = *(struct cmdname **)a_; | |
37 | struct cmdname *b = *(struct cmdname **)b_; | |
38 | return strcmp(a->name, b->name); | |
39 | } | |
40 | ||
1eb05690 SP |
41 | static void uniq(struct cmdnames *cmds) |
42 | { | |
43 | int i, j; | |
44 | ||
45 | if (!cmds->cnt) | |
46 | return; | |
47 | ||
4a15758f JK |
48 | for (i = j = 1; i < cmds->cnt; i++) { |
49 | if (!strcmp(cmds->names[i]->name, cmds->names[j-1]->name)) | |
50 | free(cmds->names[i]); | |
51 | else | |
1eb05690 | 52 | cmds->names[j++] = cmds->names[i]; |
4a15758f | 53 | } |
1eb05690 SP |
54 | |
55 | cmds->cnt = j; | |
56 | } | |
57 | ||
940208a7 | 58 | void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes) |
f3fa1838 | 59 | { |
1eb05690 SP |
60 | int ci, cj, ei; |
61 | int cmp; | |
62 | ||
63 | ci = cj = ei = 0; | |
64 | while (ci < cmds->cnt && ei < excludes->cnt) { | |
65 | cmp = strcmp(cmds->names[ci]->name, excludes->names[ei]->name); | |
66 | if (cmp < 0) | |
67 | cmds->names[cj++] = cmds->names[ci++]; | |
6a17f583 JH |
68 | else if (cmp == 0) { |
69 | ei++; | |
70 | free(cmds->names[ci++]); | |
71 | } else if (cmp > 0) | |
1eb05690 SP |
72 | ei++; |
73 | } | |
74 | ||
75 | while (ci < cmds->cnt) | |
76 | cmds->names[cj++] = cmds->names[ci++]; | |
77 | ||
78 | cmds->cnt = cj; | |
79 | } | |
80 | ||
d10cb3df | 81 | static void pretty_print_cmdnames(struct cmdnames *cmds, unsigned int colopts) |
70827b15 | 82 | { |
dbfae689 NTND |
83 | struct string_list list = STRING_LIST_INIT_NODUP; |
84 | struct column_options copts; | |
85 | int i; | |
70827b15 | 86 | |
dbfae689 NTND |
87 | for (i = 0; i < cmds->cnt; i++) |
88 | string_list_append(&list, cmds->names[i]->name); | |
89 | /* | |
90 | * always enable column display, we only consult column.* | |
91 | * about layout strategy and stuff | |
92 | */ | |
93 | colopts = (colopts & ~COL_ENABLE_MASK) | COL_ENABLED; | |
94 | memset(&copts, 0, sizeof(copts)); | |
95 | copts.indent = " "; | |
96 | copts.padding = 2; | |
97 | print_columns(&list, colopts, &copts); | |
98 | string_list_clear(&list, 0); | |
70827b15 LT |
99 | } |
100 | ||
cc3b7a97 JS |
101 | static int is_executable(const char *name) |
102 | { | |
103 | struct stat st; | |
104 | ||
105 | if (stat(name, &st) || /* stat, not lstat */ | |
106 | !S_ISREG(st.st_mode)) | |
107 | return 0; | |
108 | ||
f66450ae | 109 | #if defined(GIT_WINDOWS_NATIVE) |
0d30ad71 | 110 | { /* cannot trust the executable bit, peek into the file instead */ |
cc3b7a97 JS |
111 | char buf[3] = { 0 }; |
112 | int n; | |
113 | int fd = open(name, O_RDONLY); | |
114 | st.st_mode &= ~S_IXUSR; | |
115 | if (fd >= 0) { | |
116 | n = read(fd, buf, 2); | |
117 | if (n == 2) | |
118 | /* DOS executables start with "MZ" */ | |
119 | if (!strcmp(buf, "#!") || !strcmp(buf, "MZ")) | |
120 | st.st_mode |= S_IXUSR; | |
121 | close(fd); | |
122 | } | |
0d30ad71 | 123 | } |
cc3b7a97 JS |
124 | #endif |
125 | return st.st_mode & S_IXUSR; | |
126 | } | |
127 | ||
e321180e | 128 | static void list_commands_in_dir(struct cmdnames *cmds, |
940208a7 MV |
129 | const char *path, |
130 | const char *prefix) | |
70827b15 | 131 | { |
1eb05690 | 132 | DIR *dir = opendir(path); |
70827b15 | 133 | struct dirent *de; |
f5d600e2 JS |
134 | struct strbuf buf = STRBUF_INIT; |
135 | int len; | |
70827b15 | 136 | |
f5d600e2 | 137 | if (!dir) |
e321180e | 138 | return; |
940208a7 MV |
139 | if (!prefix) |
140 | prefix = "git-"; | |
70827b15 | 141 | |
f5d600e2 JS |
142 | strbuf_addf(&buf, "%s/", path); |
143 | len = buf.len; | |
144 | ||
70827b15 | 145 | while ((de = readdir(dir)) != NULL) { |
de8118e1 | 146 | const char *ent; |
26936bfd | 147 | size_t entlen; |
70827b15 | 148 | |
de8118e1 | 149 | if (!skip_prefix(de->d_name, prefix, &ent)) |
70827b15 | 150 | continue; |
0966003c | 151 | |
f5d600e2 JS |
152 | strbuf_setlen(&buf, len); |
153 | strbuf_addstr(&buf, de->d_name); | |
154 | if (!is_executable(buf.buf)) | |
70827b15 LT |
155 | continue; |
156 | ||
de8118e1 | 157 | entlen = strlen(ent); |
6e409473 | 158 | strip_suffix(ent, ".exe", &entlen); |
70827b15 | 159 | |
de8118e1 | 160 | add_cmdname(cmds, ent, entlen); |
70827b15 LT |
161 | } |
162 | closedir(dir); | |
f5d600e2 | 163 | strbuf_release(&buf); |
1eb05690 SP |
164 | } |
165 | ||
e321180e | 166 | void load_command_list(const char *prefix, |
940208a7 MV |
167 | struct cmdnames *main_cmds, |
168 | struct cmdnames *other_cmds) | |
1eb05690 | 169 | { |
1eb05690 | 170 | const char *env_path = getenv("PATH"); |
1eb05690 SP |
171 | const char *exec_path = git_exec_path(); |
172 | ||
1f08e5ce | 173 | if (exec_path) { |
e321180e | 174 | list_commands_in_dir(main_cmds, exec_path, prefix); |
1f08e5ce AR |
175 | qsort(main_cmds->names, main_cmds->cnt, |
176 | sizeof(*main_cmds->names), cmdname_compare); | |
177 | uniq(main_cmds); | |
1eb05690 SP |
178 | } |
179 | ||
1f08e5ce AR |
180 | if (env_path) { |
181 | char *paths, *path, *colon; | |
182 | path = paths = xstrdup(env_path); | |
183 | while (1) { | |
184 | if ((colon = strchr(path, PATH_SEP))) | |
185 | *colon = 0; | |
746c221a PB |
186 | if (!exec_path || strcmp(path, exec_path)) |
187 | list_commands_in_dir(other_cmds, path, prefix); | |
1eb05690 | 188 | |
1f08e5ce AR |
189 | if (!colon) |
190 | break; | |
191 | path = colon + 1; | |
192 | } | |
193 | free(paths); | |
1eb05690 | 194 | |
1f08e5ce AR |
195 | qsort(other_cmds->names, other_cmds->cnt, |
196 | sizeof(*other_cmds->names), cmdname_compare); | |
197 | uniq(other_cmds); | |
198 | } | |
940208a7 | 199 | exclude_cmds(other_cmds, main_cmds); |
2156435f JK |
200 | } |
201 | ||
f4ed0af6 | 202 | void list_commands(unsigned int colopts, |
dbfae689 | 203 | struct cmdnames *main_cmds, struct cmdnames *other_cmds) |
2156435f | 204 | { |
940208a7 | 205 | if (main_cmds->cnt) { |
61c5d431 | 206 | const char *exec_path = git_exec_path(); |
4470ef94 | 207 | printf_ln(_("available git commands in '%s'"), exec_path); |
1eb05690 | 208 | putchar('\n'); |
d10cb3df | 209 | pretty_print_cmdnames(main_cmds, colopts); |
1eb05690 SP |
210 | putchar('\n'); |
211 | } | |
212 | ||
940208a7 | 213 | if (other_cmds->cnt) { |
4470ef94 | 214 | printf_ln(_("git commands available from elsewhere on your $PATH")); |
940208a7 | 215 | putchar('\n'); |
d10cb3df | 216 | pretty_print_cmdnames(other_cmds, colopts); |
1eb05690 SP |
217 | putchar('\n'); |
218 | } | |
70827b15 LT |
219 | } |
220 | ||
22414770 SG |
221 | static int cmd_group_cmp(const void *elem1, const void *elem2) |
222 | { | |
223 | const struct cmdname_help *e1 = elem1; | |
224 | const struct cmdname_help *e2 = elem2; | |
225 | ||
226 | if (e1->group < e2->group) | |
227 | return -1; | |
228 | if (e1->group > e2->group) | |
229 | return 1; | |
230 | return strcmp(e1->name, e2->name); | |
231 | } | |
232 | ||
1542d4cd JH |
233 | void list_common_cmds_help(void) |
234 | { | |
235 | int i, longest = 0; | |
22414770 | 236 | int current_grp = -1; |
1542d4cd JH |
237 | |
238 | for (i = 0; i < ARRAY_SIZE(common_cmds); i++) { | |
239 | if (longest < strlen(common_cmds[i].name)) | |
240 | longest = strlen(common_cmds[i].name); | |
241 | } | |
242 | ||
22414770 SG |
243 | qsort(common_cmds, ARRAY_SIZE(common_cmds), |
244 | sizeof(common_cmds[0]), cmd_group_cmp); | |
245 | ||
246 | puts(_("These are common Git commands used in various situations:")); | |
247 | ||
1542d4cd | 248 | for (i = 0; i < ARRAY_SIZE(common_cmds); i++) { |
22414770 SG |
249 | if (common_cmds[i].group != current_grp) { |
250 | printf("\n%s\n", _(common_cmd_groups[common_cmds[i].group])); | |
251 | current_grp = common_cmds[i].group; | |
252 | } | |
253 | ||
1542d4cd JH |
254 | printf(" %s ", common_cmds[i].name); |
255 | mput_char(' ', longest - strlen(common_cmds[i].name)); | |
256 | puts(_(common_cmds[i].help)); | |
257 | } | |
258 | } | |
259 | ||
940208a7 | 260 | int is_in_cmdlist(struct cmdnames *c, const char *s) |
2156435f JK |
261 | { |
262 | int i; | |
263 | for (i = 0; i < c->cnt; i++) | |
264 | if (!strcmp(s, c->names[i]->name)) | |
265 | return 1; | |
266 | return 0; | |
267 | } | |
268 | ||
f0e90716 | 269 | static int autocorrect; |
746c221a | 270 | static struct cmdnames aliases; |
f0e90716 AR |
271 | |
272 | static int git_unknown_cmd_config(const char *var, const char *value, void *cb) | |
273 | { | |
ae021d87 JK |
274 | const char *p; |
275 | ||
f0e90716 AR |
276 | if (!strcmp(var, "help.autocorrect")) |
277 | autocorrect = git_config_int(var,value); | |
746c221a | 278 | /* Also use aliases for command lookup */ |
ae021d87 JK |
279 | if (skip_prefix(var, "alias.", &p)) |
280 | add_cmdname(&aliases, p, strlen(p)); | |
f0e90716 AR |
281 | |
282 | return git_default_config(var, value, cb); | |
283 | } | |
284 | ||
8af84dad | 285 | static int levenshtein_compare(const void *p1, const void *p2) |
822a7d50 | 286 | { |
8af84dad JS |
287 | const struct cmdname *const *c1 = p1, *const *c2 = p2; |
288 | const char *s1 = (*c1)->name, *s2 = (*c2)->name; | |
289 | int l1 = (*c1)->len; | |
290 | int l2 = (*c2)->len; | |
291 | return l1 != l2 ? l1 - l2 : strcmp(s1, s2); | |
292 | } | |
293 | ||
746c221a PB |
294 | static void add_cmd_list(struct cmdnames *cmds, struct cmdnames *old) |
295 | { | |
296 | int i; | |
297 | ALLOC_GROW(cmds->names, cmds->cnt + old->cnt, cmds->alloc); | |
298 | ||
299 | for (i = 0; i < old->cnt; i++) | |
300 | cmds->names[cmds->cnt++] = old->names[i]; | |
301 | free(old->names); | |
302 | old->cnt = 0; | |
303 | old->names = NULL; | |
304 | } | |
305 | ||
06500a02 | 306 | /* An empirically derived magic number */ |
6612b9e4 EFL |
307 | #define SIMILARITY_FLOOR 7 |
308 | #define SIMILAR_ENOUGH(x) ((x) < SIMILARITY_FLOOR) | |
06500a02 | 309 | |
823e0ded MS |
310 | static const char bad_interpreter_advice[] = |
311 | N_("'%s' appears to be a git command, but we were not\n" | |
312 | "able to execute it. Maybe git-%s is broken?"); | |
313 | ||
8af84dad | 314 | const char *help_unknown_cmd(const char *cmd) |
822a7d50 | 315 | { |
8af84dad JS |
316 | int i, n, best_similarity = 0; |
317 | struct cmdnames main_cmds, other_cmds; | |
318 | ||
319 | memset(&main_cmds, 0, sizeof(main_cmds)); | |
0b74f5dc | 320 | memset(&other_cmds, 0, sizeof(other_cmds)); |
746c221a | 321 | memset(&aliases, 0, sizeof(aliases)); |
8af84dad | 322 | |
f0e90716 AR |
323 | git_config(git_unknown_cmd_config, NULL); |
324 | ||
8af84dad JS |
325 | load_command_list("git-", &main_cmds, &other_cmds); |
326 | ||
746c221a PB |
327 | add_cmd_list(&main_cmds, &aliases); |
328 | add_cmd_list(&main_cmds, &other_cmds); | |
329 | qsort(main_cmds.names, main_cmds.cnt, | |
d333ac17 | 330 | sizeof(*main_cmds.names), cmdname_compare); |
746c221a | 331 | uniq(&main_cmds); |
8af84dad | 332 | |
6612b9e4 EFL |
333 | /* This abuses cmdname->len for levenshtein distance */ |
334 | for (i = 0, n = 0; i < main_cmds.cnt; i++) { | |
335 | int cmp = 0; /* avoid compiler stupidity */ | |
336 | const char *candidate = main_cmds.names[i]->name; | |
337 | ||
823e0ded MS |
338 | /* |
339 | * An exact match means we have the command, but | |
340 | * for some reason exec'ing it gave us ENOENT; probably | |
341 | * it's a bad interpreter in the #! line. | |
342 | */ | |
343 | if (!strcmp(candidate, cmd)) | |
344 | die(_(bad_interpreter_advice), cmd, cmd); | |
345 | ||
6612b9e4 EFL |
346 | /* Does the candidate appear in common_cmds list? */ |
347 | while (n < ARRAY_SIZE(common_cmds) && | |
348 | (cmp = strcmp(common_cmds[n].name, candidate)) < 0) | |
349 | n++; | |
350 | if ((n < ARRAY_SIZE(common_cmds)) && !cmp) { | |
351 | /* Yes, this is one of the common commands */ | |
352 | n++; /* use the entry from common_cmds[] */ | |
59556548 | 353 | if (starts_with(candidate, cmd)) { |
6612b9e4 EFL |
354 | /* Give prefix match a very good score */ |
355 | main_cmds.names[i]->len = 0; | |
356 | continue; | |
357 | } | |
358 | } | |
359 | ||
8af84dad | 360 | main_cmds.names[i]->len = |
c41494f8 | 361 | levenshtein(cmd, candidate, 0, 2, 1, 3) + 1; |
6612b9e4 | 362 | } |
8af84dad JS |
363 | |
364 | qsort(main_cmds.names, main_cmds.cnt, | |
365 | sizeof(*main_cmds.names), levenshtein_compare); | |
366 | ||
367 | if (!main_cmds.cnt) | |
9665627d | 368 | die(_("Uh oh. Your system reports no Git commands at all.")); |
8af84dad | 369 | |
6612b9e4 EFL |
370 | /* skip and count prefix matches */ |
371 | for (n = 0; n < main_cmds.cnt && !main_cmds.names[n]->len; n++) | |
372 | ; /* still counting */ | |
373 | ||
374 | if (main_cmds.cnt <= n) { | |
375 | /* prefix matches with everything? that is too ambiguous */ | |
376 | best_similarity = SIMILARITY_FLOOR + 1; | |
377 | } else { | |
378 | /* count all the most similar ones */ | |
379 | for (best_similarity = main_cmds.names[n++]->len; | |
380 | (n < main_cmds.cnt && | |
381 | best_similarity == main_cmds.names[n]->len); | |
382 | n++) | |
383 | ; /* still counting */ | |
384 | } | |
06500a02 | 385 | if (autocorrect && n == 1 && SIMILAR_ENOUGH(best_similarity)) { |
8af84dad JS |
386 | const char *assumed = main_cmds.names[0]->name; |
387 | main_cmds.names[0] = NULL; | |
388 | clean_cmdnames(&main_cmds); | |
9665627d NTND |
389 | fprintf_ln(stderr, |
390 | _("WARNING: You called a Git command named '%s', " | |
391 | "which does not exist.\n" | |
392 | "Continuing under the assumption that you meant '%s'"), | |
8af84dad | 393 | cmd, assumed); |
f0e90716 | 394 | if (autocorrect > 0) { |
9665627d | 395 | fprintf_ln(stderr, _("in %0.1f seconds automatically..."), |
f0e90716 | 396 | (float)autocorrect/10.0); |
2024d317 | 397 | sleep_millisec(autocorrect * 100); |
f0e90716 | 398 | } |
8af84dad JS |
399 | return assumed; |
400 | } | |
401 | ||
9665627d | 402 | fprintf_ln(stderr, _("git: '%s' is not a git command. See 'git --help'."), cmd); |
8af84dad | 403 | |
06500a02 | 404 | if (SIMILAR_ENOUGH(best_similarity)) { |
9665627d NTND |
405 | fprintf_ln(stderr, |
406 | Q_("\nDid you mean this?", | |
407 | "\nDid you mean one of these?", | |
408 | n)); | |
8af84dad JS |
409 | |
410 | for (i = 0; i < n; i++) | |
411 | fprintf(stderr, "\t%s\n", main_cmds.names[i]->name); | |
412 | } | |
413 | ||
822a7d50 RAJ |
414 | exit(1); |
415 | } | |
416 | ||
a633fca0 | 417 | int cmd_version(int argc, const char **argv, const char *prefix) |
70827b15 | 418 | { |
f2de0b97 DA |
419 | /* |
420 | * The format of this string should be kept stable for compatibility | |
421 | * with external projects that rely on the output of "git version". | |
422 | */ | |
70827b15 LT |
423 | printf("git version %s\n", git_version_string); |
424 | return 0; | |
425 | } | |
e5618106 VV |
426 | |
427 | struct similar_ref_cb { | |
428 | const char *base_ref; | |
429 | struct string_list *similar_refs; | |
430 | }; | |
431 | ||
91d6e94e | 432 | static int append_similar_ref(const char *refname, const struct object_id *oid, |
e5618106 VV |
433 | int flags, void *cb_data) |
434 | { | |
435 | struct similar_ref_cb *cb = (struct similar_ref_cb *)(cb_data); | |
436 | char *branch = strrchr(refname, '/') + 1; | |
95b567c7 JK |
437 | const char *remote; |
438 | ||
e5618106 | 439 | /* A remote branch of the same name is deemed similar */ |
95b567c7 | 440 | if (skip_prefix(refname, "refs/remotes/", &remote) && |
e5618106 | 441 | !strcmp(branch, cb->base_ref)) |
95b567c7 | 442 | string_list_append(cb->similar_refs, remote); |
e5618106 VV |
443 | return 0; |
444 | } | |
445 | ||
446 | static struct string_list guess_refs(const char *ref) | |
447 | { | |
448 | struct similar_ref_cb ref_cb; | |
449 | struct string_list similar_refs = STRING_LIST_INIT_NODUP; | |
450 | ||
451 | ref_cb.base_ref = ref; | |
452 | ref_cb.similar_refs = &similar_refs; | |
453 | for_each_ref(append_similar_ref, &ref_cb); | |
454 | return similar_refs; | |
455 | } | |
456 | ||
457 | void help_unknown_ref(const char *ref, const char *cmd, const char *error) | |
458 | { | |
459 | int i; | |
460 | struct string_list suggested_refs = guess_refs(ref); | |
461 | ||
462 | fprintf_ln(stderr, _("%s: %s - %s"), cmd, ref, error); | |
463 | ||
464 | if (suggested_refs.nr > 0) { | |
465 | fprintf_ln(stderr, | |
466 | Q_("\nDid you mean this?", | |
467 | "\nDid you mean one of these?", | |
468 | suggested_refs.nr)); | |
469 | for (i = 0; i < suggested_refs.nr; i++) | |
470 | fprintf(stderr, "\t%s\n", suggested_refs.items[i].string); | |
471 | } | |
472 | ||
473 | string_list_clear(&suggested_refs, 0); | |
474 | exit(1); | |
475 | } |