help.c 8.45 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

7
/* most GUI terminals set COLUMNS (although some don't export it) */
8 9 10
static int term_columns(void)
{
	char *col_string = getenv("COLUMNS");
11
	int n_cols;
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28

	if (col_string && (n_cols = atoi(col_string)) > 0)
		return n_cols;

#ifdef TIOCGWINSZ
	{
		struct winsize ws;
		if (!ioctl(1, TIOCGWINSZ, &ws)) {
			if (ws.ws_col)
				return ws.ws_col;
		}
	}
#endif

	return 80;
}

29
void add_cmdname(struct cmdnames *cmds, const char *name, int len)
30
{
31
	struct cmdname *ent = xmalloc(sizeof(*ent) + len + 1);
32

33 34 35
	ent->len = len;
	memcpy(ent->name, name, len);
	ent->name[len] = 0;
36 37 38

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

41 42 43 44 45 46 47 48 49 50
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;
}

51 52 53 54 55 56 57
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);
}

58 59 60 61 62 63 64 65 66 67 68 69 70 71
static void uniq(struct cmdnames *cmds)
{
	int i, j;

	if (!cmds->cnt)
		return;

	for (i = j = 1; i < cmds->cnt; i++)
		if (strcmp(cmds->names[i]->name, cmds->names[i-1]->name))
			cmds->names[j++] = cmds->names[i];

	cmds->cnt = j;
}

72
void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes)
73
{
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
	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++];
		else if (cmp == 0)
			ci++, ei++;
		else if (cmp > 0)
			ei++;
	}

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

	cmds->cnt = cj;
}

static void pretty_print_string_list(struct cmdnames *cmds, int longest)
95 96 97 98 99 100 101 102
{
	int cols = 1, rows;
	int space = longest + 1; /* min 1 SP between words */
	int max_cols = term_columns() - 1; /* don't print *on* the edge */
	int i, j;

	if (space < max_cols)
		cols = max_cols / space;
103
	rows = DIV_ROUND_UP(cmds->cnt, cols);
104 105 106 107 108 109 110

	for (i = 0; i < rows; i++) {
		printf("  ");

		for (j = 0; j < cols; j++) {
			int n = j * rows + i;
			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 118 119 120
		}
		putchar('\n');
	}
}

121 122 123 124 125 126 127 128
static int is_executable(const char *name)
{
	struct stat st;

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

129
#ifdef WIN32
李智's avatar
李智 committed
130
{	/* cannot trust the executable bit, peek into the file instead */
131 132 133 134 135 136 137 138 139 140 141 142
	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
143
}
144 145 146 147
#endif
	return st.st_mode & S_IXUSR;
}

148
static void list_commands_in_dir(struct cmdnames *cmds,
149 150
					 const char *path,
					 const char *prefix)
151
{
152
	int prefix_len;
153
	DIR *dir = opendir(path);
154
	struct dirent *de;
155 156
	struct strbuf buf = STRBUF_INIT;
	int len;
157

158
	if (!dir)
159
		return;
160 161 162
	if (!prefix)
		prefix = "git-";
	prefix_len = strlen(prefix);
163

164 165 166
	strbuf_addf(&buf, "%s/", path);
	len = buf.len;

167 168 169
	while ((de = readdir(dir)) != NULL) {
		int entlen;

170
		if (prefixcmp(de->d_name, prefix))
171
			continue;
172

173 174 175
		strbuf_setlen(&buf, len);
		strbuf_addstr(&buf, de->d_name);
		if (!is_executable(buf.buf))
176 177
			continue;

178
		entlen = strlen(de->d_name) - prefix_len;
179
		if (has_extension(de->d_name, ".exe"))
180 181
			entlen -= 4;

182
		add_cmdname(cmds, de->d_name + prefix_len, entlen);
183 184
	}
	closedir(dir);
185
	strbuf_release(&buf);
186 187
}

188
void load_command_list(const char *prefix,
189 190
		struct cmdnames *main_cmds,
		struct cmdnames *other_cmds)
191 192 193 194
{
	const char *env_path = getenv("PATH");
	const char *exec_path = git_exec_path();

195
	if (exec_path) {
196
		list_commands_in_dir(main_cmds, exec_path, prefix);
197 198 199
		qsort(main_cmds->names, main_cmds->cnt,
		      sizeof(*main_cmds->names), cmdname_compare);
		uniq(main_cmds);
200 201
	}

202 203 204 205 206 207
	if (env_path) {
		char *paths, *path, *colon;
		path = paths = xstrdup(env_path);
		while (1) {
			if ((colon = strchr(path, PATH_SEP)))
				*colon = 0;
208 209
			if (!exec_path || strcmp(path, exec_path))
				list_commands_in_dir(other_cmds, path, prefix);
210

211 212 213 214 215
			if (!colon)
				break;
			path = colon + 1;
		}
		free(paths);
216

217 218 219 220
		qsort(other_cmds->names, other_cmds->cnt,
		      sizeof(*other_cmds->names), cmdname_compare);
		uniq(other_cmds);
	}
221
	exclude_cmds(other_cmds, main_cmds);
Jeff King's avatar
Jeff King committed
222 223
}

224 225
void list_commands(const char *title, struct cmdnames *main_cmds,
		   struct cmdnames *other_cmds)
Jeff King's avatar
Jeff King committed
226
{
227 228 229 230 231 232 233 234
	int i, longest = 0;

	for (i = 0; i < main_cmds->cnt; i++)
		if (longest < main_cmds->names[i]->len)
			longest = main_cmds->names[i]->len;
	for (i = 0; i < other_cmds->cnt; i++)
		if (longest < other_cmds->names[i]->len)
			longest = other_cmds->names[i]->len;
Jeff King's avatar
Jeff King committed
235

236
	if (main_cmds->cnt) {
237
		const char *exec_path = git_exec_path();
238 239 240
		printf("available %s in '%s'\n", title, exec_path);
		printf("----------------");
		mput_char('-', strlen(title) + strlen(exec_path));
241
		putchar('\n');
242
		pretty_print_string_list(main_cmds, longest);
243 244 245
		putchar('\n');
	}

246 247 248 249 250 251
	if (other_cmds->cnt) {
		printf("%s available from elsewhere on your $PATH\n", title);
		printf("---------------------------------------");
		mput_char('-', strlen(title));
		putchar('\n');
		pretty_print_string_list(other_cmds, longest);
252 253
		putchar('\n');
	}
254 255
}

256
int is_in_cmdlist(struct cmdnames *c, const char *s)
Jeff King's avatar
Jeff King committed
257 258 259 260 261 262 263 264
{
	int i;
	for (i = 0; i < c->cnt; i++)
		if (!strcmp(s, c->names[i]->name))
			return 1;
	return 0;
}

265
static int autocorrect;
266
static struct cmdnames aliases;
267 268 269 270 271

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);
272 273 274
	/* Also use aliases for command lookup */
	if (!prefixcmp(var, "alias."))
		add_cmdname(&aliases, var + 6, strlen(var + 6));
275 276 277 278

	return git_default_config(var, value, cb);
}

279
static int levenshtein_compare(const void *p1, const void *p2)
280
{
281 282 283 284 285 286 287
	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);
}

288 289 290 291 292 293 294 295 296 297 298 299
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;
}

300 301 302
/* An empirically derived magic number */
#define SIMILAR_ENOUGH(x) ((x) < 6)

303
const char *help_unknown_cmd(const char *cmd)
304
{
305 306 307 308
	int i, n, best_similarity = 0;
	struct cmdnames main_cmds, other_cmds;

	memset(&main_cmds, 0, sizeof(main_cmds));
309
	memset(&other_cmds, 0, sizeof(other_cmds));
310
	memset(&aliases, 0, sizeof(aliases));
311

312 313
	git_config(git_unknown_cmd_config, NULL);

314 315
	load_command_list("git-", &main_cmds, &other_cmds);

316 317 318 319 320
	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);
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336

	/* This reuses cmdname->len for similarity index */
	for (i = 0; i < main_cmds.cnt; ++i)
		main_cmds.names[i]->len =
			levenshtein(cmd, main_cmds.names[i]->name, 0, 2, 1, 4);

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

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

	best_similarity = main_cmds.names[0]->len;
	n = 1;
	while (n < main_cmds.cnt && best_similarity == main_cmds.names[n]->len)
		++n;
337
	if (autocorrect && n == 1 && SIMILAR_ENOUGH(best_similarity)) {
338 339 340
		const char *assumed = main_cmds.names[0]->name;
		main_cmds.names[0] = NULL;
		clean_cmdnames(&main_cmds);
341
		fprintf(stderr, "WARNING: You called a Git command named '%s', "
342 343 344
			"which does not exist.\n"
			"Continuing under the assumption that you meant '%s'\n",
			cmd, assumed);
345 346 347 348 349
		if (autocorrect > 0) {
			fprintf(stderr, "in %0.1f seconds automatically...\n",
				(float)autocorrect/10.0);
			poll(NULL, 0, autocorrect * 100);
		}
350 351 352
		return assumed;
	}

353
	fprintf(stderr, "git: '%s' is not a git command. See 'git --help'.\n", cmd);
354

355
	if (SIMILAR_ENOUGH(best_similarity)) {
356 357 358 359 360 361 362
		fprintf(stderr, "\nDid you mean %s?\n",
			n < 2 ? "this": "one of these");

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

363 364 365
	exit(1);
}

366
int cmd_version(int argc, const char **argv, const char *prefix)
367 368 369 370
{
	printf("git version %s\n", git_version_string);
	return 0;
}