]>
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" |
64949984 | 10 | |
940208a7 | 11 | void add_cmdname(struct cmdnames *cmds, const char *name, int len) |
70827b15 | 12 | { |
940208a7 | 13 | struct cmdname *ent = xmalloc(sizeof(*ent) + len + 1); |
1eb05690 | 14 | |
70827b15 LT |
15 | ent->len = len; |
16 | memcpy(ent->name, name, len); | |
17 | ent->name[len] = 0; | |
1eb05690 SP |
18 | |
19 | ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc); | |
20 | cmds->names[cmds->cnt++] = ent; | |
70827b15 LT |
21 | } |
22 | ||
8af84dad JS |
23 | static void clean_cmdnames(struct cmdnames *cmds) |
24 | { | |
25 | int i; | |
26 | for (i = 0; i < cmds->cnt; ++i) | |
27 | free(cmds->names[i]); | |
28 | free(cmds->names); | |
29 | cmds->cnt = 0; | |
30 | cmds->alloc = 0; | |
31 | } | |
32 | ||
70827b15 LT |
33 | static int cmdname_compare(const void *a_, const void *b_) |
34 | { | |
35 | struct cmdname *a = *(struct cmdname **)a_; | |
36 | struct cmdname *b = *(struct cmdname **)b_; | |
37 | return strcmp(a->name, b->name); | |
38 | } | |
39 | ||
1eb05690 SP |
40 | static void uniq(struct cmdnames *cmds) |
41 | { | |
42 | int i, j; | |
43 | ||
44 | if (!cmds->cnt) | |
45 | return; | |
46 | ||
4a15758f JK |
47 | for (i = j = 1; i < cmds->cnt; i++) { |
48 | if (!strcmp(cmds->names[i]->name, cmds->names[j-1]->name)) | |
49 | free(cmds->names[i]); | |
50 | else | |
1eb05690 | 51 | cmds->names[j++] = cmds->names[i]; |
4a15758f | 52 | } |
1eb05690 SP |
53 | |
54 | cmds->cnt = j; | |
55 | } | |
56 | ||
940208a7 | 57 | void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes) |
f3fa1838 | 58 | { |
1eb05690 SP |
59 | int ci, cj, ei; |
60 | int cmp; | |
61 | ||
62 | ci = cj = ei = 0; | |
63 | while (ci < cmds->cnt && ei < excludes->cnt) { | |
64 | cmp = strcmp(cmds->names[ci]->name, excludes->names[ei]->name); | |
65 | if (cmp < 0) | |
66 | cmds->names[cj++] = cmds->names[ci++]; | |
67 | else if (cmp == 0) | |
68 | ci++, ei++; | |
69 | else if (cmp > 0) | |
70 | ei++; | |
71 | } | |
72 | ||
73 | while (ci < cmds->cnt) | |
74 | cmds->names[cj++] = cmds->names[ci++]; | |
75 | ||
76 | cmds->cnt = cj; | |
77 | } | |
78 | ||
dbfae689 NTND |
79 | static void pretty_print_string_list(struct cmdnames *cmds, |
80 | unsigned int colopts) | |
70827b15 | 81 | { |
dbfae689 NTND |
82 | struct string_list list = STRING_LIST_INIT_NODUP; |
83 | struct column_options copts; | |
84 | int i; | |
70827b15 | 85 | |
dbfae689 NTND |
86 | for (i = 0; i < cmds->cnt; i++) |
87 | string_list_append(&list, cmds->names[i]->name); | |
88 | /* | |
89 | * always enable column display, we only consult column.* | |
90 | * about layout strategy and stuff | |
91 | */ | |
92 | colopts = (colopts & ~COL_ENABLE_MASK) | COL_ENABLED; | |
93 | memset(&copts, 0, sizeof(copts)); | |
94 | copts.indent = " "; | |
95 | copts.padding = 2; | |
96 | print_columns(&list, colopts, &copts); | |
97 | string_list_clear(&list, 0); | |
70827b15 LT |
98 | } |
99 | ||
cc3b7a97 JS |
100 | static int is_executable(const char *name) |
101 | { | |
102 | struct stat st; | |
103 | ||
104 | if (stat(name, &st) || /* stat, not lstat */ | |
105 | !S_ISREG(st.st_mode)) | |
106 | return 0; | |
107 | ||
b8a97333 RJ |
108 | #if defined(WIN32) || defined(__CYGWIN__) |
109 | #if defined(__CYGWIN__) | |
110 | if ((st.st_mode & S_IXUSR) == 0) | |
111 | #endif | |
0d30ad71 | 112 | { /* cannot trust the executable bit, peek into the file instead */ |
cc3b7a97 JS |
113 | char buf[3] = { 0 }; |
114 | int n; | |
115 | int fd = open(name, O_RDONLY); | |
116 | st.st_mode &= ~S_IXUSR; | |
117 | if (fd >= 0) { | |
118 | n = read(fd, buf, 2); | |
119 | if (n == 2) | |
120 | /* DOS executables start with "MZ" */ | |
121 | if (!strcmp(buf, "#!") || !strcmp(buf, "MZ")) | |
122 | st.st_mode |= S_IXUSR; | |
123 | close(fd); | |
124 | } | |
0d30ad71 | 125 | } |
cc3b7a97 JS |
126 | #endif |
127 | return st.st_mode & S_IXUSR; | |
128 | } | |
129 | ||
e321180e | 130 | static void list_commands_in_dir(struct cmdnames *cmds, |
940208a7 MV |
131 | const char *path, |
132 | const char *prefix) | |
70827b15 | 133 | { |
940208a7 | 134 | int prefix_len; |
1eb05690 | 135 | DIR *dir = opendir(path); |
70827b15 | 136 | struct dirent *de; |
f5d600e2 JS |
137 | struct strbuf buf = STRBUF_INIT; |
138 | int len; | |
70827b15 | 139 | |
f5d600e2 | 140 | if (!dir) |
e321180e | 141 | return; |
940208a7 MV |
142 | if (!prefix) |
143 | prefix = "git-"; | |
144 | prefix_len = strlen(prefix); | |
70827b15 | 145 | |
f5d600e2 JS |
146 | strbuf_addf(&buf, "%s/", path); |
147 | len = buf.len; | |
148 | ||
70827b15 | 149 | while ((de = readdir(dir)) != NULL) { |
70827b15 LT |
150 | int entlen; |
151 | ||
edb6ddc5 | 152 | if (prefixcmp(de->d_name, prefix)) |
70827b15 | 153 | continue; |
0966003c | 154 | |
f5d600e2 JS |
155 | strbuf_setlen(&buf, len); |
156 | strbuf_addstr(&buf, de->d_name); | |
157 | if (!is_executable(buf.buf)) | |
70827b15 LT |
158 | continue; |
159 | ||
edb6ddc5 | 160 | entlen = strlen(de->d_name) - prefix_len; |
5bb1cda5 | 161 | if (has_extension(de->d_name, ".exe")) |
70827b15 LT |
162 | entlen -= 4; |
163 | ||
1eb05690 | 164 | add_cmdname(cmds, de->d_name + prefix_len, entlen); |
70827b15 LT |
165 | } |
166 | closedir(dir); | |
f5d600e2 | 167 | strbuf_release(&buf); |
1eb05690 SP |
168 | } |
169 | ||
e321180e | 170 | void load_command_list(const char *prefix, |
940208a7 MV |
171 | struct cmdnames *main_cmds, |
172 | struct cmdnames *other_cmds) | |
1eb05690 | 173 | { |
1eb05690 | 174 | const char *env_path = getenv("PATH"); |
1eb05690 SP |
175 | const char *exec_path = git_exec_path(); |
176 | ||
1f08e5ce | 177 | if (exec_path) { |
e321180e | 178 | list_commands_in_dir(main_cmds, exec_path, prefix); |
1f08e5ce AR |
179 | qsort(main_cmds->names, main_cmds->cnt, |
180 | sizeof(*main_cmds->names), cmdname_compare); | |
181 | uniq(main_cmds); | |
1eb05690 SP |
182 | } |
183 | ||
1f08e5ce AR |
184 | if (env_path) { |
185 | char *paths, *path, *colon; | |
186 | path = paths = xstrdup(env_path); | |
187 | while (1) { | |
188 | if ((colon = strchr(path, PATH_SEP))) | |
189 | *colon = 0; | |
746c221a PB |
190 | if (!exec_path || strcmp(path, exec_path)) |
191 | list_commands_in_dir(other_cmds, path, prefix); | |
1eb05690 | 192 | |
1f08e5ce AR |
193 | if (!colon) |
194 | break; | |
195 | path = colon + 1; | |
196 | } | |
197 | free(paths); | |
1eb05690 | 198 | |
1f08e5ce AR |
199 | qsort(other_cmds->names, other_cmds->cnt, |
200 | sizeof(*other_cmds->names), cmdname_compare); | |
201 | uniq(other_cmds); | |
202 | } | |
940208a7 | 203 | exclude_cmds(other_cmds, main_cmds); |
2156435f JK |
204 | } |
205 | ||
f4ed0af6 | 206 | void list_commands(unsigned int colopts, |
dbfae689 | 207 | struct cmdnames *main_cmds, struct cmdnames *other_cmds) |
2156435f | 208 | { |
940208a7 | 209 | if (main_cmds->cnt) { |
61c5d431 | 210 | const char *exec_path = git_exec_path(); |
4470ef94 | 211 | printf_ln(_("available git commands in '%s'"), exec_path); |
1eb05690 | 212 | putchar('\n'); |
dbfae689 | 213 | pretty_print_string_list(main_cmds, colopts); |
1eb05690 SP |
214 | putchar('\n'); |
215 | } | |
216 | ||
940208a7 | 217 | if (other_cmds->cnt) { |
4470ef94 | 218 | printf_ln(_("git commands available from elsewhere on your $PATH")); |
940208a7 | 219 | putchar('\n'); |
dbfae689 | 220 | pretty_print_string_list(other_cmds, colopts); |
1eb05690 SP |
221 | putchar('\n'); |
222 | } | |
70827b15 LT |
223 | } |
224 | ||
940208a7 | 225 | int is_in_cmdlist(struct cmdnames *c, const char *s) |
2156435f JK |
226 | { |
227 | int i; | |
228 | for (i = 0; i < c->cnt; i++) | |
229 | if (!strcmp(s, c->names[i]->name)) | |
230 | return 1; | |
231 | return 0; | |
232 | } | |
233 | ||
f0e90716 | 234 | static int autocorrect; |
746c221a | 235 | static struct cmdnames aliases; |
f0e90716 AR |
236 | |
237 | static int git_unknown_cmd_config(const char *var, const char *value, void *cb) | |
238 | { | |
239 | if (!strcmp(var, "help.autocorrect")) | |
240 | autocorrect = git_config_int(var,value); | |
746c221a PB |
241 | /* Also use aliases for command lookup */ |
242 | if (!prefixcmp(var, "alias.")) | |
243 | add_cmdname(&aliases, var + 6, strlen(var + 6)); | |
f0e90716 AR |
244 | |
245 | return git_default_config(var, value, cb); | |
246 | } | |
247 | ||
8af84dad | 248 | static int levenshtein_compare(const void *p1, const void *p2) |
822a7d50 | 249 | { |
8af84dad JS |
250 | const struct cmdname *const *c1 = p1, *const *c2 = p2; |
251 | const char *s1 = (*c1)->name, *s2 = (*c2)->name; | |
252 | int l1 = (*c1)->len; | |
253 | int l2 = (*c2)->len; | |
254 | return l1 != l2 ? l1 - l2 : strcmp(s1, s2); | |
255 | } | |
256 | ||
746c221a PB |
257 | static void add_cmd_list(struct cmdnames *cmds, struct cmdnames *old) |
258 | { | |
259 | int i; | |
260 | ALLOC_GROW(cmds->names, cmds->cnt + old->cnt, cmds->alloc); | |
261 | ||
262 | for (i = 0; i < old->cnt; i++) | |
263 | cmds->names[cmds->cnt++] = old->names[i]; | |
264 | free(old->names); | |
265 | old->cnt = 0; | |
266 | old->names = NULL; | |
267 | } | |
268 | ||
06500a02 | 269 | /* An empirically derived magic number */ |
6612b9e4 EFL |
270 | #define SIMILARITY_FLOOR 7 |
271 | #define SIMILAR_ENOUGH(x) ((x) < SIMILARITY_FLOOR) | |
06500a02 | 272 | |
823e0ded MS |
273 | static const char bad_interpreter_advice[] = |
274 | N_("'%s' appears to be a git command, but we were not\n" | |
275 | "able to execute it. Maybe git-%s is broken?"); | |
276 | ||
8af84dad | 277 | const char *help_unknown_cmd(const char *cmd) |
822a7d50 | 278 | { |
8af84dad JS |
279 | int i, n, best_similarity = 0; |
280 | struct cmdnames main_cmds, other_cmds; | |
281 | ||
282 | memset(&main_cmds, 0, sizeof(main_cmds)); | |
0b74f5dc | 283 | memset(&other_cmds, 0, sizeof(other_cmds)); |
746c221a | 284 | memset(&aliases, 0, sizeof(aliases)); |
8af84dad | 285 | |
f0e90716 AR |
286 | git_config(git_unknown_cmd_config, NULL); |
287 | ||
8af84dad JS |
288 | load_command_list("git-", &main_cmds, &other_cmds); |
289 | ||
746c221a PB |
290 | add_cmd_list(&main_cmds, &aliases); |
291 | add_cmd_list(&main_cmds, &other_cmds); | |
292 | qsort(main_cmds.names, main_cmds.cnt, | |
293 | sizeof(main_cmds.names), cmdname_compare); | |
294 | uniq(&main_cmds); | |
8af84dad | 295 | |
6612b9e4 EFL |
296 | /* This abuses cmdname->len for levenshtein distance */ |
297 | for (i = 0, n = 0; i < main_cmds.cnt; i++) { | |
298 | int cmp = 0; /* avoid compiler stupidity */ | |
299 | const char *candidate = main_cmds.names[i]->name; | |
300 | ||
823e0ded MS |
301 | /* |
302 | * An exact match means we have the command, but | |
303 | * for some reason exec'ing it gave us ENOENT; probably | |
304 | * it's a bad interpreter in the #! line. | |
305 | */ | |
306 | if (!strcmp(candidate, cmd)) | |
307 | die(_(bad_interpreter_advice), cmd, cmd); | |
308 | ||
6612b9e4 EFL |
309 | /* Does the candidate appear in common_cmds list? */ |
310 | while (n < ARRAY_SIZE(common_cmds) && | |
311 | (cmp = strcmp(common_cmds[n].name, candidate)) < 0) | |
312 | n++; | |
313 | if ((n < ARRAY_SIZE(common_cmds)) && !cmp) { | |
314 | /* Yes, this is one of the common commands */ | |
315 | n++; /* use the entry from common_cmds[] */ | |
316 | if (!prefixcmp(candidate, cmd)) { | |
317 | /* Give prefix match a very good score */ | |
318 | main_cmds.names[i]->len = 0; | |
319 | continue; | |
320 | } | |
321 | } | |
322 | ||
8af84dad | 323 | main_cmds.names[i]->len = |
c41494f8 | 324 | levenshtein(cmd, candidate, 0, 2, 1, 3) + 1; |
6612b9e4 | 325 | } |
8af84dad JS |
326 | |
327 | qsort(main_cmds.names, main_cmds.cnt, | |
328 | sizeof(*main_cmds.names), levenshtein_compare); | |
329 | ||
330 | if (!main_cmds.cnt) | |
9665627d | 331 | die(_("Uh oh. Your system reports no Git commands at all.")); |
8af84dad | 332 | |
6612b9e4 EFL |
333 | /* skip and count prefix matches */ |
334 | for (n = 0; n < main_cmds.cnt && !main_cmds.names[n]->len; n++) | |
335 | ; /* still counting */ | |
336 | ||
337 | if (main_cmds.cnt <= n) { | |
338 | /* prefix matches with everything? that is too ambiguous */ | |
339 | best_similarity = SIMILARITY_FLOOR + 1; | |
340 | } else { | |
341 | /* count all the most similar ones */ | |
342 | for (best_similarity = main_cmds.names[n++]->len; | |
343 | (n < main_cmds.cnt && | |
344 | best_similarity == main_cmds.names[n]->len); | |
345 | n++) | |
346 | ; /* still counting */ | |
347 | } | |
06500a02 | 348 | if (autocorrect && n == 1 && SIMILAR_ENOUGH(best_similarity)) { |
8af84dad JS |
349 | const char *assumed = main_cmds.names[0]->name; |
350 | main_cmds.names[0] = NULL; | |
351 | clean_cmdnames(&main_cmds); | |
9665627d NTND |
352 | fprintf_ln(stderr, |
353 | _("WARNING: You called a Git command named '%s', " | |
354 | "which does not exist.\n" | |
355 | "Continuing under the assumption that you meant '%s'"), | |
8af84dad | 356 | cmd, assumed); |
f0e90716 | 357 | if (autocorrect > 0) { |
9665627d | 358 | fprintf_ln(stderr, _("in %0.1f seconds automatically..."), |
f0e90716 AR |
359 | (float)autocorrect/10.0); |
360 | poll(NULL, 0, autocorrect * 100); | |
361 | } | |
8af84dad JS |
362 | return assumed; |
363 | } | |
364 | ||
9665627d | 365 | fprintf_ln(stderr, _("git: '%s' is not a git command. See 'git --help'."), cmd); |
8af84dad | 366 | |
06500a02 | 367 | if (SIMILAR_ENOUGH(best_similarity)) { |
9665627d NTND |
368 | fprintf_ln(stderr, |
369 | Q_("\nDid you mean this?", | |
370 | "\nDid you mean one of these?", | |
371 | n)); | |
8af84dad JS |
372 | |
373 | for (i = 0; i < n; i++) | |
374 | fprintf(stderr, "\t%s\n", main_cmds.names[i]->name); | |
375 | } | |
376 | ||
822a7d50 RJ |
377 | exit(1); |
378 | } | |
379 | ||
a633fca0 | 380 | int cmd_version(int argc, const char **argv, const char *prefix) |
70827b15 LT |
381 | { |
382 | printf("git version %s\n", git_version_string); | |
383 | return 0; | |
384 | } |