300cd38a9fc2afa61d4390a8fee590997bb6e590
1#include "cache.h"
2#include "builtin.h"
3#include "exec_cmd.h"
4#include "levenshtein.h"
5#include "help.h"
6
7/* most GUI terminals set COLUMNS (although some don't export it) */
8static int term_columns(void)
9{
10 char *col_string = getenv("COLUMNS");
11 int n_cols;
12
13 if (col_string && (n_cols = atoi(col_string)) > 0)
14 return n_cols;
15
16#ifdef TIOCGWINSZ
17 {
18 struct winsize ws;
19 if (!ioctl(1, TIOCGWINSZ, &ws)) {
20 if (ws.ws_col)
21 return ws.ws_col;
22 }
23 }
24#endif
25
26 return 80;
27}
28
29void add_cmdname(struct cmdnames *cmds, const char *name, int len)
30{
31 struct cmdname *ent = xmalloc(sizeof(*ent) + len + 1);
32
33 ent->len = len;
34 memcpy(ent->name, name, len);
35 ent->name[len] = 0;
36
37 ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
38 cmds->names[cmds->cnt++] = ent;
39}
40
41static void clean_cmdnames(struct cmdnames *cmds)
42{
43 int i;
44 for (i = 0; i < cmds->cnt; ++i)
45 free(cmds->names[i]);
46 free(cmds->names);
47 cmds->cnt = 0;
48 cmds->alloc = 0;
49}
50
51static int cmdname_compare(const void *a_, const void *b_)
52{
53 struct cmdname *a = *(struct cmdname **)a_;
54 struct cmdname *b = *(struct cmdname **)b_;
55 return strcmp(a->name, b->name);
56}
57
58static void uniq(struct cmdnames *cmds)
59{
60 int i, j;
61
62 if (!cmds->cnt)
63 return;
64
65 for (i = j = 1; i < cmds->cnt; i++)
66 if (strcmp(cmds->names[i]->name, cmds->names[i-1]->name))
67 cmds->names[j++] = cmds->names[i];
68
69 cmds->cnt = j;
70}
71
72void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes)
73{
74 int ci, cj, ei;
75 int cmp;
76
77 ci = cj = ei = 0;
78 while (ci < cmds->cnt && ei < excludes->cnt) {
79 cmp = strcmp(cmds->names[ci]->name, excludes->names[ei]->name);
80 if (cmp < 0)
81 cmds->names[cj++] = cmds->names[ci++];
82 else if (cmp == 0)
83 ci++, ei++;
84 else if (cmp > 0)
85 ei++;
86 }
87
88 while (ci < cmds->cnt)
89 cmds->names[cj++] = cmds->names[ci++];
90
91 cmds->cnt = cj;
92}
93
94static void pretty_print_string_list(struct cmdnames *cmds, int longest)
95{
96 int cols = 1, rows;
97 int space = longest + 1; /* min 1 SP between words */
98 int max_cols = term_columns() - 1; /* don't print *on* the edge */
99 int i, j;
100
101 if (space < max_cols)
102 cols = max_cols / space;
103 rows = (cmds->cnt + cols - 1) / cols;
104
105 for (i = 0; i < rows; i++) {
106 printf(" ");
107
108 for (j = 0; j < cols; j++) {
109 int n = j * rows + i;
110 int size = space;
111 if (n >= cmds->cnt)
112 break;
113 if (j == cols-1 || n + rows >= cmds->cnt)
114 size = 1;
115 printf("%-*s", size, cmds->names[n]->name);
116 }
117 putchar('\n');
118 }
119}
120
121static int is_executable(const char *name)
122{
123 struct stat st;
124
125 if (stat(name, &st) || /* stat, not lstat */
126 !S_ISREG(st.st_mode))
127 return 0;
128
129#ifdef __MINGW32__
130 /* cannot trust the executable bit, peek into the file instead */
131 char buf[3] = { 0 };
132 int n;
133 int fd = open(name, O_RDONLY);
134 st.st_mode &= ~S_IXUSR;
135 if (fd >= 0) {
136 n = read(fd, buf, 2);
137 if (n == 2)
138 /* DOS executables start with "MZ" */
139 if (!strcmp(buf, "#!") || !strcmp(buf, "MZ"))
140 st.st_mode |= S_IXUSR;
141 close(fd);
142 }
143#endif
144 return st.st_mode & S_IXUSR;
145}
146
147static void list_commands_in_dir(struct cmdnames *cmds,
148 const char *path,
149 const char *prefix)
150{
151 int prefix_len;
152 DIR *dir = opendir(path);
153 struct dirent *de;
154 struct strbuf buf = STRBUF_INIT;
155 int len;
156
157 if (!dir)
158 return;
159 if (!prefix)
160 prefix = "git-";
161 prefix_len = strlen(prefix);
162
163 strbuf_addf(&buf, "%s/", path);
164 len = buf.len;
165
166 while ((de = readdir(dir)) != NULL) {
167 int entlen;
168
169 if (prefixcmp(de->d_name, prefix))
170 continue;
171
172 strbuf_setlen(&buf, len);
173 strbuf_addstr(&buf, de->d_name);
174 if (!is_executable(buf.buf))
175 continue;
176
177 entlen = strlen(de->d_name) - prefix_len;
178 if (has_extension(de->d_name, ".exe"))
179 entlen -= 4;
180
181 add_cmdname(cmds, de->d_name + prefix_len, entlen);
182 }
183 closedir(dir);
184 strbuf_release(&buf);
185}
186
187void load_command_list(const char *prefix,
188 struct cmdnames *main_cmds,
189 struct cmdnames *other_cmds)
190{
191 const char *env_path = getenv("PATH");
192 const char *exec_path = git_exec_path();
193
194 if (exec_path) {
195 list_commands_in_dir(main_cmds, exec_path, prefix);
196 qsort(main_cmds->names, main_cmds->cnt,
197 sizeof(*main_cmds->names), cmdname_compare);
198 uniq(main_cmds);
199 }
200
201 if (env_path) {
202 char *paths, *path, *colon;
203 path = paths = xstrdup(env_path);
204 while (1) {
205 if ((colon = strchr(path, PATH_SEP)))
206 *colon = 0;
207
208 list_commands_in_dir(other_cmds, path, prefix);
209
210 if (!colon)
211 break;
212 path = colon + 1;
213 }
214 free(paths);
215
216 qsort(other_cmds->names, other_cmds->cnt,
217 sizeof(*other_cmds->names), cmdname_compare);
218 uniq(other_cmds);
219 }
220 exclude_cmds(other_cmds, main_cmds);
221}
222
223void list_commands(const char *title, struct cmdnames *main_cmds,
224 struct cmdnames *other_cmds)
225{
226 int i, longest = 0;
227
228 for (i = 0; i < main_cmds->cnt; i++)
229 if (longest < main_cmds->names[i]->len)
230 longest = main_cmds->names[i]->len;
231 for (i = 0; i < other_cmds->cnt; i++)
232 if (longest < other_cmds->names[i]->len)
233 longest = other_cmds->names[i]->len;
234
235 if (main_cmds->cnt) {
236 const char *exec_path = git_exec_path();
237 printf("available %s in '%s'\n", title, exec_path);
238 printf("----------------");
239 mput_char('-', strlen(title) + strlen(exec_path));
240 putchar('\n');
241 pretty_print_string_list(main_cmds, longest);
242 putchar('\n');
243 }
244
245 if (other_cmds->cnt) {
246 printf("%s available from elsewhere on your $PATH\n", title);
247 printf("---------------------------------------");
248 mput_char('-', strlen(title));
249 putchar('\n');
250 pretty_print_string_list(other_cmds, longest);
251 putchar('\n');
252 }
253}
254
255int is_in_cmdlist(struct cmdnames *c, const char *s)
256{
257 int i;
258 for (i = 0; i < c->cnt; i++)
259 if (!strcmp(s, c->names[i]->name))
260 return 1;
261 return 0;
262}
263
264static int autocorrect;
265
266static int git_unknown_cmd_config(const char *var, const char *value, void *cb)
267{
268 if (!strcmp(var, "help.autocorrect"))
269 autocorrect = git_config_int(var,value);
270
271 return git_default_config(var, value, cb);
272}
273
274static int levenshtein_compare(const void *p1, const void *p2)
275{
276 const struct cmdname *const *c1 = p1, *const *c2 = p2;
277 const char *s1 = (*c1)->name, *s2 = (*c2)->name;
278 int l1 = (*c1)->len;
279 int l2 = (*c2)->len;
280 return l1 != l2 ? l1 - l2 : strcmp(s1, s2);
281}
282
283const char *help_unknown_cmd(const char *cmd)
284{
285 int i, n, best_similarity = 0;
286 struct cmdnames main_cmds, other_cmds;
287
288 memset(&main_cmds, 0, sizeof(main_cmds));
289 memset(&other_cmds, 0, sizeof(main_cmds));
290
291 git_config(git_unknown_cmd_config, NULL);
292
293 load_command_list("git-", &main_cmds, &other_cmds);
294
295 ALLOC_GROW(main_cmds.names, main_cmds.cnt + other_cmds.cnt,
296 main_cmds.alloc);
297 memcpy(main_cmds.names + main_cmds.cnt, other_cmds.names,
298 other_cmds.cnt * sizeof(other_cmds.names[0]));
299 main_cmds.cnt += other_cmds.cnt;
300 free(other_cmds.names);
301
302 /* This reuses cmdname->len for similarity index */
303 for (i = 0; i < main_cmds.cnt; ++i)
304 main_cmds.names[i]->len =
305 levenshtein(cmd, main_cmds.names[i]->name, 0, 2, 1, 4);
306
307 qsort(main_cmds.names, main_cmds.cnt,
308 sizeof(*main_cmds.names), levenshtein_compare);
309
310 if (!main_cmds.cnt)
311 die ("Uh oh. Your system reports no Git commands at all.");
312
313 best_similarity = main_cmds.names[0]->len;
314 n = 1;
315 while (n < main_cmds.cnt && best_similarity == main_cmds.names[n]->len)
316 ++n;
317 if (autocorrect && n == 1) {
318 const char *assumed = main_cmds.names[0]->name;
319 main_cmds.names[0] = NULL;
320 clean_cmdnames(&main_cmds);
321 fprintf(stderr, "WARNING: You called a Git program named '%s', "
322 "which does not exist.\n"
323 "Continuing under the assumption that you meant '%s'\n",
324 cmd, assumed);
325 if (autocorrect > 0) {
326 fprintf(stderr, "in %0.1f seconds automatically...\n",
327 (float)autocorrect/10.0);
328 poll(NULL, 0, autocorrect * 100);
329 }
330 return assumed;
331 }
332
333 fprintf(stderr, "git: '%s' is not a git-command. See 'git --help'.\n", cmd);
334
335 if (best_similarity < 6) {
336 fprintf(stderr, "\nDid you mean %s?\n",
337 n < 2 ? "this": "one of these");
338
339 for (i = 0; i < n; i++)
340 fprintf(stderr, "\t%s\n", main_cmds.names[i]->name);
341 }
342
343 exit(1);
344}
345
346int cmd_version(int argc, const char **argv, const char *prefix)
347{
348 printf("git version %s\n", git_version_string);
349 return 0;
350}