help.c 9.25 KB
Newer Older
1 2 3
#include "cache.h"
#include "builtin.h"
#include "exec_cmd.h"
4
#include "levenshtein.h"
5
#include "help.h"
6
#include "common-cmds.h"
7 8
#include "string-list.h"
#include "column.h"
9
#include "version.h"
10

11
void add_cmdname(struct cmdnames *cmds, const char *name, int len)
12
{
13
	struct cmdname *ent = xmalloc(sizeof(*ent) + len + 1);
14

15 16 17
	ent->len = len;
	memcpy(ent->name, name, len);
	ent->name[len] = 0;
18 19 20

	ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
	cmds->names[cmds->cnt++] = ent;
21 22
}

23 24 25 26 27 28 29 30 31 32
static void clean_cmdnames(struct cmdnames *cmds)
{
	int i;
	for (i = 0; i < cmds->cnt; ++i)
		free(cmds->names[i]);
	free(cmds->names);
	cmds->cnt = 0;
	cmds->alloc = 0;
}

33 34 35 36 37 38 39
static int cmdname_compare(const void *a_, const void *b_)
{
	struct cmdname *a = *(struct cmdname **)a_;
	struct cmdname *b = *(struct cmdname **)b_;
	return strcmp(a->name, b->name);
}

40 41 42 43 44 45 46
static void uniq(struct cmdnames *cmds)
{
	int i, j;

	if (!cmds->cnt)
		return;

Jeff King's avatar
Jeff King committed
47 48 49 50
	for (i = j = 1; i < cmds->cnt; i++) {
		if (!strcmp(cmds->names[i]->name, cmds->names[j-1]->name))
			free(cmds->names[i]);
		else
51
			cmds->names[j++] = cmds->names[i];
Jeff King's avatar
Jeff King committed
52
	}
53 54 55 56

	cmds->cnt = j;
}

57
void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes)
58
{
59 60 61 62 63 64 65 66
	int ci, cj, ei;
	int cmp;

	ci = cj = ei = 0;
	while (ci < cmds->cnt && ei < excludes->cnt) {
		cmp = strcmp(cmds->names[ci]->name, excludes->names[ei]->name);
		if (cmp < 0)
			cmds->names[cj++] = cmds->names[ci++];
67 68 69 70
		else if (cmp == 0) {
			ei++;
			free(cmds->names[ci++]);
		} else if (cmp > 0)
71 72 73 74 75 76 77 78 79
			ei++;
	}

	while (ci < cmds->cnt)
		cmds->names[cj++] = cmds->names[ci++];

	cmds->cnt = cj;
}

80 81
static void pretty_print_string_list(struct cmdnames *cmds,
				     unsigned int colopts)
82
{
83 84 85
	struct string_list list = STRING_LIST_INIT_NODUP;
	struct column_options copts;
	int i;
86

87 88 89 90 91 92 93 94 95 96 97 98
	for (i = 0; i < cmds->cnt; i++)
		string_list_append(&list, cmds->names[i]->name);
	/*
	 * always enable column display, we only consult column.*
	 * about layout strategy and stuff
	 */
	colopts = (colopts & ~COL_ENABLE_MASK) | COL_ENABLED;
	memset(&copts, 0, sizeof(copts));
	copts.indent = "  ";
	copts.padding = 2;
	print_columns(&list, colopts, &copts);
	string_list_clear(&list, 0);
99 100
}

101 102 103 104 105 106 107 108
static int is_executable(const char *name)
{
	struct stat st;

	if (stat(name, &st) || /* stat, not lstat */
	    !S_ISREG(st.st_mode))
		return 0;

109 110 111 112
#if defined(WIN32) || defined(__CYGWIN__)
#if defined(__CYGWIN__)
if ((st.st_mode & S_IXUSR) == 0)
#endif
李智's avatar
李智 committed
113
{	/* cannot trust the executable bit, peek into the file instead */
114 115 116 117 118 119 120 121 122 123 124 125
	char buf[3] = { 0 };
	int n;
	int fd = open(name, O_RDONLY);
	st.st_mode &= ~S_IXUSR;
	if (fd >= 0) {
		n = read(fd, buf, 2);
		if (n == 2)
			/* DOS executables start with "MZ" */
			if (!strcmp(buf, "#!") || !strcmp(buf, "MZ"))
				st.st_mode |= S_IXUSR;
		close(fd);
	}
李智's avatar
李智 committed
126
}
127 128 129 130
#endif
	return st.st_mode & S_IXUSR;
}

131
static void list_commands_in_dir(struct cmdnames *cmds,
132 133
					 const char *path,
					 const char *prefix)
134
{
135
	int prefix_len;
136
	DIR *dir = opendir(path);
137
	struct dirent *de;
138 139
	struct strbuf buf = STRBUF_INIT;
	int len;
140

141
	if (!dir)
142
		return;
143 144 145
	if (!prefix)
		prefix = "git-";
	prefix_len = strlen(prefix);
146

147 148 149
	strbuf_addf(&buf, "%s/", path);
	len = buf.len;

150 151 152
	while ((de = readdir(dir)) != NULL) {
		int entlen;

153
		if (prefixcmp(de->d_name, prefix))
154
			continue;
155

156 157 158
		strbuf_setlen(&buf, len);
		strbuf_addstr(&buf, de->d_name);
		if (!is_executable(buf.buf))
159 160
			continue;

161
		entlen = strlen(de->d_name) - prefix_len;
162
		if (has_extension(de->d_name, ".exe"))
163 164
			entlen -= 4;

165
		add_cmdname(cmds, de->d_name + prefix_len, entlen);
166 167
	}
	closedir(dir);
168
	strbuf_release(&buf);
169 170
}

171
void load_command_list(const char *prefix,
172 173
		struct cmdnames *main_cmds,
		struct cmdnames *other_cmds)
174 175 176 177
{
	const char *env_path = getenv("PATH");
	const char *exec_path = git_exec_path();

178
	if (exec_path) {
179
		list_commands_in_dir(main_cmds, exec_path, prefix);
180 181 182
		qsort(main_cmds->names, main_cmds->cnt,
		      sizeof(*main_cmds->names), cmdname_compare);
		uniq(main_cmds);
183 184
	}

185 186 187 188 189 190
	if (env_path) {
		char *paths, *path, *colon;
		path = paths = xstrdup(env_path);
		while (1) {
			if ((colon = strchr(path, PATH_SEP)))
				*colon = 0;
191 192
			if (!exec_path || strcmp(path, exec_path))
				list_commands_in_dir(other_cmds, path, prefix);
193

194 195 196 197 198
			if (!colon)
				break;
			path = colon + 1;
		}
		free(paths);
199

200 201 202 203
		qsort(other_cmds->names, other_cmds->cnt,
		      sizeof(*other_cmds->names), cmdname_compare);
		uniq(other_cmds);
	}
204
	exclude_cmds(other_cmds, main_cmds);
Jeff King's avatar
Jeff King committed
205 206
}

Junio C Hamano's avatar
Junio C Hamano committed
207
void list_commands(unsigned int colopts,
208
		   struct cmdnames *main_cmds, struct cmdnames *other_cmds)
Jeff King's avatar
Jeff King committed
209
{
210
	if (main_cmds->cnt) {
211
		const char *exec_path = git_exec_path();
212
		printf_ln(_("available git commands in '%s'"), exec_path);
213
		putchar('\n');
214
		pretty_print_string_list(main_cmds, colopts);
215 216 217
		putchar('\n');
	}

218
	if (other_cmds->cnt) {
219
		printf_ln(_("git commands available from elsewhere on your $PATH"));
220
		putchar('\n');
221
		pretty_print_string_list(other_cmds, colopts);
222 223
		putchar('\n');
	}
224 225
}

226
int is_in_cmdlist(struct cmdnames *c, const char *s)
Jeff King's avatar
Jeff King committed
227 228 229 230 231 232 233 234
{
	int i;
	for (i = 0; i < c->cnt; i++)
		if (!strcmp(s, c->names[i]->name))
			return 1;
	return 0;
}

235
static int autocorrect;
236
static struct cmdnames aliases;
237 238 239 240 241

static int git_unknown_cmd_config(const char *var, const char *value, void *cb)
{
	if (!strcmp(var, "help.autocorrect"))
		autocorrect = git_config_int(var,value);
242 243 244
	/* Also use aliases for command lookup */
	if (!prefixcmp(var, "alias."))
		add_cmdname(&aliases, var + 6, strlen(var + 6));
245 246 247 248

	return git_default_config(var, value, cb);
}

249
static int levenshtein_compare(const void *p1, const void *p2)
250
{
251 252 253 254 255 256 257
	const struct cmdname *const *c1 = p1, *const *c2 = p2;
	const char *s1 = (*c1)->name, *s2 = (*c2)->name;
	int l1 = (*c1)->len;
	int l2 = (*c2)->len;
	return l1 != l2 ? l1 - l2 : strcmp(s1, s2);
}

258 259 260 261 262 263 264 265 266 267 268 269
static void add_cmd_list(struct cmdnames *cmds, struct cmdnames *old)
{
	int i;
	ALLOC_GROW(cmds->names, cmds->cnt + old->cnt, cmds->alloc);

	for (i = 0; i < old->cnt; i++)
		cmds->names[cmds->cnt++] = old->names[i];
	free(old->names);
	old->cnt = 0;
	old->names = NULL;
}

270
/* An empirically derived magic number */
271 272
#define SIMILARITY_FLOOR 7
#define SIMILAR_ENOUGH(x) ((x) < SIMILARITY_FLOOR)
273

274 275 276 277
static const char bad_interpreter_advice[] =
	N_("'%s' appears to be a git command, but we were not\n"
	"able to execute it. Maybe git-%s is broken?");

278
const char *help_unknown_cmd(const char *cmd)
279
{
280 281 282 283
	int i, n, best_similarity = 0;
	struct cmdnames main_cmds, other_cmds;

	memset(&main_cmds, 0, sizeof(main_cmds));
284
	memset(&other_cmds, 0, sizeof(other_cmds));
285
	memset(&aliases, 0, sizeof(aliases));
286

287 288
	git_config(git_unknown_cmd_config, NULL);

289 290
	load_command_list("git-", &main_cmds, &other_cmds);

291 292 293 294 295
	add_cmd_list(&main_cmds, &aliases);
	add_cmd_list(&main_cmds, &other_cmds);
	qsort(main_cmds.names, main_cmds.cnt,
	      sizeof(main_cmds.names), cmdname_compare);
	uniq(&main_cmds);
296

297 298 299 300 301
	/* This abuses cmdname->len for levenshtein distance */
	for (i = 0, n = 0; i < main_cmds.cnt; i++) {
		int cmp = 0; /* avoid compiler stupidity */
		const char *candidate = main_cmds.names[i]->name;

302 303 304 305 306 307 308 309
		/*
		 * An exact match means we have the command, but
		 * for some reason exec'ing it gave us ENOENT; probably
		 * it's a bad interpreter in the #! line.
		 */
		if (!strcmp(candidate, cmd))
			die(_(bad_interpreter_advice), cmd, cmd);

310 311 312 313 314 315 316 317 318 319 320 321 322 323
		/* Does the candidate appear in common_cmds list? */
		while (n < ARRAY_SIZE(common_cmds) &&
		       (cmp = strcmp(common_cmds[n].name, candidate)) < 0)
			n++;
		if ((n < ARRAY_SIZE(common_cmds)) && !cmp) {
			/* Yes, this is one of the common commands */
			n++; /* use the entry from common_cmds[] */
			if (!prefixcmp(candidate, cmd)) {
				/* Give prefix match a very good score */
				main_cmds.names[i]->len = 0;
				continue;
			}
		}

324
		main_cmds.names[i]->len =
325
			levenshtein(cmd, candidate, 0, 2, 1, 3) + 1;
326
	}
327 328 329 330 331

	qsort(main_cmds.names, main_cmds.cnt,
	      sizeof(*main_cmds.names), levenshtein_compare);

	if (!main_cmds.cnt)
332
		die(_("Uh oh. Your system reports no Git commands at all."));
333

334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
	/* skip and count prefix matches */
	for (n = 0; n < main_cmds.cnt && !main_cmds.names[n]->len; n++)
		; /* still counting */

	if (main_cmds.cnt <= n) {
		/* prefix matches with everything? that is too ambiguous */
		best_similarity = SIMILARITY_FLOOR + 1;
	} else {
		/* count all the most similar ones */
		for (best_similarity = main_cmds.names[n++]->len;
		     (n < main_cmds.cnt &&
		      best_similarity == main_cmds.names[n]->len);
		     n++)
			; /* still counting */
	}
349
	if (autocorrect && n == 1 && SIMILAR_ENOUGH(best_similarity)) {
350 351 352
		const char *assumed = main_cmds.names[0]->name;
		main_cmds.names[0] = NULL;
		clean_cmdnames(&main_cmds);
353 354 355 356
		fprintf_ln(stderr,
			   _("WARNING: You called a Git command named '%s', "
			     "which does not exist.\n"
			     "Continuing under the assumption that you meant '%s'"),
357
			cmd, assumed);
358
		if (autocorrect > 0) {
359
			fprintf_ln(stderr, _("in %0.1f seconds automatically..."),
360 361 362
				(float)autocorrect/10.0);
			poll(NULL, 0, autocorrect * 100);
		}
363 364 365
		return assumed;
	}

366
	fprintf_ln(stderr, _("git: '%s' is not a git command. See 'git --help'."), cmd);
367

368
	if (SIMILAR_ENOUGH(best_similarity)) {
369 370 371 372
		fprintf_ln(stderr,
			   Q_("\nDid you mean this?",
			      "\nDid you mean one of these?",
			   n));
373 374 375 376 377

		for (i = 0; i < n; i++)
			fprintf(stderr, "\t%s\n", main_cmds.names[i]->name);
	}

378 379 380
	exit(1);
}

381
int cmd_version(int argc, const char **argv, const char *prefix)
382 383 384 385
{
	printf("git version %s\n", git_version_string);
	return 0;
}