🌐 AI搜索 & 代理 主页
blob: 7af65e205ecdf1a01dce009cbf0ada15de68c844 [file] [log] [blame]
Linus Torvalds70827b12006-04-21 17:27:341#include "cache.h"
2#include "builtin.h"
3#include "exec_cmd.h"
Johannes Schindelin8af84da2008-08-31 13:50:234#include "levenshtein.h"
Miklos Vajna940208a2008-07-29 23:16:585#include "help.h"
Erik Faye-Lund6612b9e2010-11-26 16:00:396#include "common-cmds.h"
Nguyễn Thái Ngọc Duydbfae682012-04-13 10:54:377#include "string-list.h"
8#include "column.h"
Jeff King816fb462012-06-02 18:51:429#include "version.h"
Vikrant Varmae5618102013-05-04 00:04:1910#include "refs.h"
Christian Couder64949982008-03-07 07:46:2811
Miklos Vajna940208a2008-07-29 23:16:5812void add_cmdname(struct cmdnames *cmds, const char *name, int len)
Linus Torvalds70827b12006-04-21 17:27:3413{
Miklos Vajna940208a2008-07-29 23:16:5814 struct cmdname *ent = xmalloc(sizeof(*ent) + len + 1);
Scott R Parish1eb05692007-10-29 03:30:5215
Linus Torvalds70827b12006-04-21 17:27:3416 ent->len = len;
17 memcpy(ent->name, name, len);
18 ent->name[len] = 0;
Scott R Parish1eb05692007-10-29 03:30:5219
20 ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
21 cmds->names[cmds->cnt++] = ent;
Linus Torvalds70827b12006-04-21 17:27:3422}
23
Johannes Schindelin8af84da2008-08-31 13:50:2324static 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
Linus Torvalds70827b12006-04-21 17:27:3434static 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
Scott R Parish1eb05692007-10-29 03:30:5241static void uniq(struct cmdnames *cmds)
42{
43 int i, j;
44
45 if (!cmds->cnt)
46 return;
47
Jeff King4a157582012-07-25 16:16:1948 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
Scott R Parish1eb05692007-10-29 03:30:5252 cmds->names[j++] = cmds->names[i];
Jeff King4a157582012-07-25 16:16:1953 }
Scott R Parish1eb05692007-10-29 03:30:5254
55 cmds->cnt = j;
56}
57
Miklos Vajna940208a2008-07-29 23:16:5858void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes)
Junio C Hamanof3fa1832007-11-08 23:35:3259{
Scott R Parish1eb05692007-10-29 03:30:5260 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++];
Junio C Hamano6a17f582012-07-25 18:01:1268 else if (cmp == 0) {
69 ei++;
70 free(cmds->names[ci++]);
71 } else if (cmp > 0)
Scott R Parish1eb05692007-10-29 03:30:5272 ei++;
73 }
74
75 while (ci < cmds->cnt)
76 cmds->names[cj++] = cmds->names[ci++];
77
78 cmds->cnt = cj;
79}
80
Ralf Thielowd10cb3d2014-02-28 19:27:2981static void pretty_print_cmdnames(struct cmdnames *cmds, unsigned int colopts)
Linus Torvalds70827b12006-04-21 17:27:3482{
Nguyễn Thái Ngọc Duydbfae682012-04-13 10:54:3783 struct string_list list = STRING_LIST_INIT_NODUP;
84 struct column_options copts;
85 int i;
Linus Torvalds70827b12006-04-21 17:27:3486
Nguyễn Thái Ngọc Duydbfae682012-04-13 10:54:3787 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);
Linus Torvalds70827b12006-04-21 17:27:3499}
100
Johannes Sixtcc3b7a92008-01-14 13:05:33101static 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
Ramsay Jonesf66450a2013-06-22 19:42:47109#if defined(GIT_WINDOWS_NATIVE)
Frank Li0d30ad72009-09-16 08:20:17110{ /* cannot trust the executable bit, peek into the file instead */
Johannes Sixtcc3b7a92008-01-14 13:05:33111 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 }
Frank Li0d30ad72009-09-16 08:20:17123}
Johannes Sixtcc3b7a92008-01-14 13:05:33124#endif
125 return st.st_mode & S_IXUSR;
126}
127
Alex Riesene3211802008-08-28 17:15:33128static void list_commands_in_dir(struct cmdnames *cmds,
Miklos Vajna940208a2008-07-29 23:16:58129 const char *path,
130 const char *prefix)
Linus Torvalds70827b12006-04-21 17:27:34131{
Scott R Parish1eb05692007-10-29 03:30:52132 DIR *dir = opendir(path);
Linus Torvalds70827b12006-04-21 17:27:34133 struct dirent *de;
Johannes Schindelinf5d600e2008-07-27 20:34:14134 struct strbuf buf = STRBUF_INIT;
135 int len;
Linus Torvalds70827b12006-04-21 17:27:34136
Johannes Schindelinf5d600e2008-07-27 20:34:14137 if (!dir)
Alex Riesene3211802008-08-28 17:15:33138 return;
Miklos Vajna940208a2008-07-29 23:16:58139 if (!prefix)
140 prefix = "git-";
Linus Torvalds70827b12006-04-21 17:27:34141
Johannes Schindelinf5d600e2008-07-27 20:34:14142 strbuf_addf(&buf, "%s/", path);
143 len = buf.len;
144
Linus Torvalds70827b12006-04-21 17:27:34145 while ((de = readdir(dir)) != NULL) {
Jeff Kingde8118e2014-06-18 19:57:17146 const char *ent;
Jeff King26936bf2014-06-30 16:58:51147 size_t entlen;
Linus Torvalds70827b12006-04-21 17:27:34148
Jeff Kingde8118e2014-06-18 19:57:17149 if (!skip_prefix(de->d_name, prefix, &ent))
Linus Torvalds70827b12006-04-21 17:27:34150 continue;
Scott R Parish09660032007-10-27 08:36:52151
Johannes Schindelinf5d600e2008-07-27 20:34:14152 strbuf_setlen(&buf, len);
153 strbuf_addstr(&buf, de->d_name);
154 if (!is_executable(buf.buf))
Linus Torvalds70827b12006-04-21 17:27:34155 continue;
156
Jeff Kingde8118e2014-06-18 19:57:17157 entlen = strlen(ent);
Junio C Hamano6e409472014-07-16 18:25:59158 strip_suffix(ent, ".exe", &entlen);
Linus Torvalds70827b12006-04-21 17:27:34159
Jeff Kingde8118e2014-06-18 19:57:17160 add_cmdname(cmds, ent, entlen);
Linus Torvalds70827b12006-04-21 17:27:34161 }
162 closedir(dir);
Johannes Schindelinf5d600e2008-07-27 20:34:14163 strbuf_release(&buf);
Scott R Parish1eb05692007-10-29 03:30:52164}
165
Alex Riesene3211802008-08-28 17:15:33166void load_command_list(const char *prefix,
Miklos Vajna940208a2008-07-29 23:16:58167 struct cmdnames *main_cmds,
168 struct cmdnames *other_cmds)
Scott R Parish1eb05692007-10-29 03:30:52169{
Scott R Parish1eb05692007-10-29 03:30:52170 const char *env_path = getenv("PATH");
Scott R Parish1eb05692007-10-29 03:30:52171 const char *exec_path = git_exec_path();
172
Alex Riesen1f08e5c2008-08-28 17:19:07173 if (exec_path) {
Alex Riesene3211802008-08-28 17:15:33174 list_commands_in_dir(main_cmds, exec_path, prefix);
Alex Riesen1f08e5c2008-08-28 17:19:07175 qsort(main_cmds->names, main_cmds->cnt,
176 sizeof(*main_cmds->names), cmdname_compare);
177 uniq(main_cmds);
Scott R Parish1eb05692007-10-29 03:30:52178 }
179
Alex Riesen1f08e5c2008-08-28 17:19:07180 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;
Pieter de Bie746c2212008-09-10 15:54:28186 if (!exec_path || strcmp(path, exec_path))
187 list_commands_in_dir(other_cmds, path, prefix);
Scott R Parish1eb05692007-10-29 03:30:52188
Alex Riesen1f08e5c2008-08-28 17:19:07189 if (!colon)
190 break;
191 path = colon + 1;
192 }
193 free(paths);
194
195 qsort(other_cmds->names, other_cmds->cnt,
196 sizeof(*other_cmds->names), cmdname_compare);
197 uniq(other_cmds);
Scott R Parish1eb05692007-10-29 03:30:52198 }
Miklos Vajna940208a2008-07-29 23:16:58199 exclude_cmds(other_cmds, main_cmds);
Jeff King21564352008-02-24 22:17:37200}
201
Junio C Hamanof4ed0af2012-05-03 22:13:31202void list_commands(unsigned int colopts,
Nguyễn Thái Ngọc Duydbfae682012-04-13 10:54:37203 struct cmdnames *main_cmds, struct cmdnames *other_cmds)
Jeff King21564352008-02-24 22:17:37204{
Miklos Vajna940208a2008-07-29 23:16:58205 if (main_cmds->cnt) {
Alex Riesen61c5d432008-08-28 17:19:42206 const char *exec_path = git_exec_path();
Nguyễn Thái Ngọc Duy4470ef92012-04-25 11:21:53207 printf_ln(_("available git commands in '%s'"), exec_path);
Scott R Parish1eb05692007-10-29 03:30:52208 putchar('\n');
Ralf Thielowd10cb3d2014-02-28 19:27:29209 pretty_print_cmdnames(main_cmds, colopts);
Scott R Parish1eb05692007-10-29 03:30:52210 putchar('\n');
211 }
212
Miklos Vajna940208a2008-07-29 23:16:58213 if (other_cmds->cnt) {
Nguyễn Thái Ngọc Duy4470ef92012-04-25 11:21:53214 printf_ln(_("git commands available from elsewhere on your $PATH"));
Miklos Vajna940208a2008-07-29 23:16:58215 putchar('\n');
Ralf Thielowd10cb3d2014-02-28 19:27:29216 pretty_print_cmdnames(other_cmds, colopts);
Scott R Parish1eb05692007-10-29 03:30:52217 putchar('\n');
218 }
Linus Torvalds70827b12006-04-21 17:27:34219}
220
Junio C Hamano1542d4c2013-01-19 06:35:04221void list_common_cmds_help(void)
222{
223 int i, longest = 0;
224
225 for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
226 if (longest < strlen(common_cmds[i].name))
227 longest = strlen(common_cmds[i].name);
228 }
229
230 puts(_("The most commonly used git commands are:"));
231 for (i = 0; i < ARRAY_SIZE(common_cmds); i++) {
232 printf(" %s ", common_cmds[i].name);
233 mput_char(' ', longest - strlen(common_cmds[i].name));
234 puts(_(common_cmds[i].help));
235 }
236}
237
Miklos Vajna940208a2008-07-29 23:16:58238int is_in_cmdlist(struct cmdnames *c, const char *s)
Jeff King21564352008-02-24 22:17:37239{
240 int i;
241 for (i = 0; i < c->cnt; i++)
242 if (!strcmp(s, c->names[i]->name))
243 return 1;
244 return 0;
245}
246
Alex Riesenf0e90712008-08-31 13:54:58247static int autocorrect;
Pieter de Bie746c2212008-09-10 15:54:28248static struct cmdnames aliases;
Alex Riesenf0e90712008-08-31 13:54:58249
250static int git_unknown_cmd_config(const char *var, const char *value, void *cb)
Ramsay Allan Jones822a7d52006-07-30 21:42:25251{
Jeff Kingae021d82014-06-18 19:47:50252 const char *p;
253
Alex Riesenf0e90712008-08-31 13:54:58254 if (!strcmp(var, "help.autocorrect"))
255 autocorrect = git_config_int(var,value);
Pieter de Bie746c2212008-09-10 15:54:28256 /* Also use aliases for command lookup */
Jeff Kingae021d82014-06-18 19:47:50257 if (skip_prefix(var, "alias.", &p))
258 add_cmdname(&aliases, p, strlen(p));
Alex Riesenf0e90712008-08-31 13:54:58259
260 return git_default_config(var, value, cb);
261}
262
Johannes Schindelin8af84da2008-08-31 13:50:23263static int levenshtein_compare(const void *p1, const void *p2)
Ramsay Allan Jones822a7d52006-07-30 21:42:25264{
Johannes Schindelin8af84da2008-08-31 13:50:23265 const struct cmdname *const *c1 = p1, *const *c2 = p2;
266 const char *s1 = (*c1)->name, *s2 = (*c2)->name;
267 int l1 = (*c1)->len;
268 int l2 = (*c2)->len;
269 return l1 != l2 ? l1 - l2 : strcmp(s1, s2);
270}
271
Pieter de Bie746c2212008-09-10 15:54:28272static void add_cmd_list(struct cmdnames *cmds, struct cmdnames *old)
273{
274 int i;
275 ALLOC_GROW(cmds->names, cmds->cnt + old->cnt, cmds->alloc);
276
277 for (i = 0; i < old->cnt; i++)
278 cmds->names[cmds->cnt++] = old->names[i];
279 free(old->names);
280 old->cnt = 0;
281 old->names = NULL;
282}
283
Johannes Sixt06500a02009-12-15 07:57:18284/* An empirically derived magic number */
Erik Faye-Lund6612b9e2010-11-26 16:00:39285#define SIMILARITY_FLOOR 7
286#define SIMILAR_ENOUGH(x) ((x) < SIMILARITY_FLOOR)
Johannes Sixt06500a02009-12-15 07:57:18287
Michael Schubert823e0de2011-07-08 10:08:49288static const char bad_interpreter_advice[] =
289 N_("'%s' appears to be a git command, but we were not\n"
290 "able to execute it. Maybe git-%s is broken?");
291
Johannes Schindelin8af84da2008-08-31 13:50:23292const char *help_unknown_cmd(const char *cmd)
293{
294 int i, n, best_similarity = 0;
295 struct cmdnames main_cmds, other_cmds;
296
297 memset(&main_cmds, 0, sizeof(main_cmds));
Johan Herland0b74f5d2009-08-11 10:10:21298 memset(&other_cmds, 0, sizeof(other_cmds));
Pieter de Bie746c2212008-09-10 15:54:28299 memset(&aliases, 0, sizeof(aliases));
Johannes Schindelin8af84da2008-08-31 13:50:23300
Alex Riesenf0e90712008-08-31 13:54:58301 git_config(git_unknown_cmd_config, NULL);
302
Johannes Schindelin8af84da2008-08-31 13:50:23303 load_command_list("git-", &main_cmds, &other_cmds);
304
Pieter de Bie746c2212008-09-10 15:54:28305 add_cmd_list(&main_cmds, &aliases);
306 add_cmd_list(&main_cmds, &other_cmds);
307 qsort(main_cmds.names, main_cmds.cnt,
308 sizeof(main_cmds.names), cmdname_compare);
309 uniq(&main_cmds);
Johannes Schindelin8af84da2008-08-31 13:50:23310
Erik Faye-Lund6612b9e2010-11-26 16:00:39311 /* This abuses cmdname->len for levenshtein distance */
312 for (i = 0, n = 0; i < main_cmds.cnt; i++) {
313 int cmp = 0; /* avoid compiler stupidity */
314 const char *candidate = main_cmds.names[i]->name;
315
Michael Schubert823e0de2011-07-08 10:08:49316 /*
317 * An exact match means we have the command, but
318 * for some reason exec'ing it gave us ENOENT; probably
319 * it's a bad interpreter in the #! line.
320 */
321 if (!strcmp(candidate, cmd))
322 die(_(bad_interpreter_advice), cmd, cmd);
323
Erik Faye-Lund6612b9e2010-11-26 16:00:39324 /* Does the candidate appear in common_cmds list? */
325 while (n < ARRAY_SIZE(common_cmds) &&
326 (cmp = strcmp(common_cmds[n].name, candidate)) < 0)
327 n++;
328 if ((n < ARRAY_SIZE(common_cmds)) && !cmp) {
329 /* Yes, this is one of the common commands */
330 n++; /* use the entry from common_cmds[] */
Christian Couder59556542013-11-30 20:55:40331 if (starts_with(candidate, cmd)) {
Erik Faye-Lund6612b9e2010-11-26 16:00:39332 /* Give prefix match a very good score */
333 main_cmds.names[i]->len = 0;
334 continue;
335 }
336 }
337
Johannes Schindelin8af84da2008-08-31 13:50:23338 main_cmds.names[i]->len =
Matthieu Moyc41494f2012-05-27 16:02:58339 levenshtein(cmd, candidate, 0, 2, 1, 3) + 1;
Erik Faye-Lund6612b9e2010-11-26 16:00:39340 }
Johannes Schindelin8af84da2008-08-31 13:50:23341
342 qsort(main_cmds.names, main_cmds.cnt,
343 sizeof(*main_cmds.names), levenshtein_compare);
344
345 if (!main_cmds.cnt)
Nguyễn Thái Ngọc Duy96656272012-04-23 12:30:24346 die(_("Uh oh. Your system reports no Git commands at all."));
Johannes Schindelin8af84da2008-08-31 13:50:23347
Erik Faye-Lund6612b9e2010-11-26 16:00:39348 /* skip and count prefix matches */
349 for (n = 0; n < main_cmds.cnt && !main_cmds.names[n]->len; n++)
350 ; /* still counting */
351
352 if (main_cmds.cnt <= n) {
353 /* prefix matches with everything? that is too ambiguous */
354 best_similarity = SIMILARITY_FLOOR + 1;
355 } else {
356 /* count all the most similar ones */
357 for (best_similarity = main_cmds.names[n++]->len;
358 (n < main_cmds.cnt &&
359 best_similarity == main_cmds.names[n]->len);
360 n++)
361 ; /* still counting */
362 }
Johannes Sixt06500a02009-12-15 07:57:18363 if (autocorrect && n == 1 && SIMILAR_ENOUGH(best_similarity)) {
Johannes Schindelin8af84da2008-08-31 13:50:23364 const char *assumed = main_cmds.names[0]->name;
365 main_cmds.names[0] = NULL;
366 clean_cmdnames(&main_cmds);
Nguyễn Thái Ngọc Duy96656272012-04-23 12:30:24367 fprintf_ln(stderr,
368 _("WARNING: You called a Git command named '%s', "
369 "which does not exist.\n"
370 "Continuing under the assumption that you meant '%s'"),
Johannes Schindelin8af84da2008-08-31 13:50:23371 cmd, assumed);
Alex Riesenf0e90712008-08-31 13:54:58372 if (autocorrect > 0) {
Nguyễn Thái Ngọc Duy96656272012-04-23 12:30:24373 fprintf_ln(stderr, _("in %0.1f seconds automatically..."),
Alex Riesenf0e90712008-08-31 13:54:58374 (float)autocorrect/10.0);
375 poll(NULL, 0, autocorrect * 100);
376 }
Johannes Schindelin8af84da2008-08-31 13:50:23377 return assumed;
378 }
379
Nguyễn Thái Ngọc Duy96656272012-04-23 12:30:24380 fprintf_ln(stderr, _("git: '%s' is not a git command. See 'git --help'."), cmd);
Johannes Schindelin8af84da2008-08-31 13:50:23381
Johannes Sixt06500a02009-12-15 07:57:18382 if (SIMILAR_ENOUGH(best_similarity)) {
Nguyễn Thái Ngọc Duy96656272012-04-23 12:30:24383 fprintf_ln(stderr,
384 Q_("\nDid you mean this?",
385 "\nDid you mean one of these?",
386 n));
Johannes Schindelin8af84da2008-08-31 13:50:23387
388 for (i = 0; i < n; i++)
389 fprintf(stderr, "\t%s\n", main_cmds.names[i]->name);
390 }
391
Ramsay Allan Jones822a7d52006-07-30 21:42:25392 exit(1);
393}
394
Linus Torvaldsa633fca2006-07-29 05:44:25395int cmd_version(int argc, const char **argv, const char *prefix)
Linus Torvalds70827b12006-04-21 17:27:34396{
David Aguilarf2de0b92013-04-16 20:33:25397 /*
398 * The format of this string should be kept stable for compatibility
399 * with external projects that rely on the output of "git version".
400 */
Linus Torvalds70827b12006-04-21 17:27:34401 printf("git version %s\n", git_version_string);
402 return 0;
403}
Vikrant Varmae5618102013-05-04 00:04:19404
405struct similar_ref_cb {
406 const char *base_ref;
407 struct string_list *similar_refs;
408};
409
410static int append_similar_ref(const char *refname, const unsigned char *sha1,
411 int flags, void *cb_data)
412{
413 struct similar_ref_cb *cb = (struct similar_ref_cb *)(cb_data);
414 char *branch = strrchr(refname, '/') + 1;
Jeff King95b567c2014-06-18 19:48:29415 const char *remote;
416
Vikrant Varmae5618102013-05-04 00:04:19417 /* A remote branch of the same name is deemed similar */
Jeff King95b567c2014-06-18 19:48:29418 if (skip_prefix(refname, "refs/remotes/", &remote) &&
Vikrant Varmae5618102013-05-04 00:04:19419 !strcmp(branch, cb->base_ref))
Jeff King95b567c2014-06-18 19:48:29420 string_list_append(cb->similar_refs, remote);
Vikrant Varmae5618102013-05-04 00:04:19421 return 0;
422}
423
424static struct string_list guess_refs(const char *ref)
425{
426 struct similar_ref_cb ref_cb;
427 struct string_list similar_refs = STRING_LIST_INIT_NODUP;
428
429 ref_cb.base_ref = ref;
430 ref_cb.similar_refs = &similar_refs;
431 for_each_ref(append_similar_ref, &ref_cb);
432 return similar_refs;
433}
434
435void help_unknown_ref(const char *ref, const char *cmd, const char *error)
436{
437 int i;
438 struct string_list suggested_refs = guess_refs(ref);
439
440 fprintf_ln(stderr, _("%s: %s - %s"), cmd, ref, error);
441
442 if (suggested_refs.nr > 0) {
443 fprintf_ln(stderr,
444 Q_("\nDid you mean this?",
445 "\nDid you mean one of these?",
446 suggested_refs.nr));
447 for (i = 0; i < suggested_refs.nr; i++)
448 fprintf(stderr, "\t%s\n", suggested_refs.items[i].string);
449 }
450
451 string_list_clear(&suggested_refs, 0);
452 exit(1);
453}