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