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