all repos — cgit @ 5fe88a9c81517b1a8a93d930c738cbb6f71dec2a

a hyperfast web frontend for git written in c

ui-log.c (view raw)

  1/* ui-log.c: functions for log output
  2 *
  3 * Copyright (C) 2006-2014 cgit Development Team <cgit@lists.zx2c4.com>
  4 *
  5 * Licensed under GNU General Public License v2
  6 *   (see COPYING for full license text)
  7 */
  8
  9#include "cgit.h"
 10#include "ui-log.h"
 11#include "html.h"
 12#include "ui-shared.h"
 13#include "argv-array.h"
 14
 15static int files, add_lines, rem_lines, lines_counted;
 16
 17/*
 18 * The list of available column colors in the commit graph.
 19 */
 20static const char *column_colors_html[] = {
 21	"<span class='column1'>",
 22	"<span class='column2'>",
 23	"<span class='column3'>",
 24	"<span class='column4'>",
 25	"<span class='column5'>",
 26	"<span class='column6'>",
 27	"</span>",
 28};
 29
 30#define COLUMN_COLORS_HTML_MAX (ARRAY_SIZE(column_colors_html) - 1)
 31
 32static void count_lines(char *line, int size)
 33{
 34	if (size <= 0)
 35		return;
 36
 37	if (line[0] == '+')
 38		add_lines++;
 39
 40	else if (line[0] == '-')
 41		rem_lines++;
 42}
 43
 44static void inspect_files(struct diff_filepair *pair)
 45{
 46	unsigned long old_size = 0;
 47	unsigned long new_size = 0;
 48	int binary = 0;
 49
 50	files++;
 51	if (ctx.repo->enable_log_linecount)
 52		cgit_diff_files(&pair->one->oid, &pair->two->oid, &old_size,
 53				&new_size, &binary, 0, ctx.qry.ignorews,
 54				count_lines);
 55}
 56
 57void show_commit_decorations(struct commit *commit)
 58{
 59	const struct name_decoration *deco;
 60	static char buf[1024];
 61
 62	buf[sizeof(buf) - 1] = 0;
 63	deco = get_name_decoration(&commit->object);
 64	if (!deco)
 65		return;
 66	html("<span class='decoration'>");
 67	while (deco) {
 68		strncpy(buf, prettify_refname(deco->name), sizeof(buf) - 1);
 69		switch(deco->type) {
 70		case DECORATION_NONE:
 71			/* If the git-core doesn't recognize it,
 72			 * don't display anything. */
 73			break;
 74		case DECORATION_REF_LOCAL:
 75			cgit_log_link(buf, NULL, "branch-deco", buf, NULL,
 76				ctx.qry.vpath, 0, NULL, NULL,
 77				ctx.qry.showmsg, 0);
 78			break;
 79		case DECORATION_REF_TAG:
 80			cgit_tag_link(buf, NULL, "tag-deco", buf);
 81			break;
 82		case DECORATION_REF_REMOTE:
 83			if (!ctx.repo->enable_remote_branches)
 84				break;
 85			cgit_log_link(buf, NULL, "remote-deco", NULL,
 86				oid_to_hex(&commit->object.oid),
 87				ctx.qry.vpath, 0, NULL, NULL,
 88				ctx.qry.showmsg, 0);
 89			break;
 90		default:
 91			cgit_commit_link(buf, NULL, "deco", ctx.qry.head,
 92					oid_to_hex(&commit->object.oid),
 93					ctx.qry.vpath);
 94			break;
 95		}
 96		deco = deco->next;
 97	}
 98	html("</span>");
 99}
100
101static void handle_rename(struct diff_filepair *pair)
102{
103	/*
104	 * After we have seen a rename, we generate links to the previous
105	 * name of the file so that commit & diff views get fed the path
106	 * that is correct for the commit they are showing, avoiding the
107	 * need to walk the entire history leading back to every commit we
108	 * show in order detect renames.
109	 */
110	if (0 != strcmp(ctx.qry.vpath, pair->two->path)) {
111		free(ctx.qry.vpath);
112		ctx.qry.vpath = xstrdup(pair->two->path);
113	}
114	inspect_files(pair);
115}
116
117static int show_commit(struct commit *commit, struct rev_info *revs)
118{
119	struct commit_list *parents = commit->parents;
120	struct commit *parent;
121	int found = 0, saved_fmt;
122	unsigned saved_flags = revs->diffopt.flags;
123
124
125	/* Always show if we're not in "follow" mode with a single file. */
126	if (!ctx.qry.follow)
127		return 1;
128
129	/*
130	 * In "follow" mode, we don't show merges.  This is consistent with
131	 * "git log --follow -- <file>".
132	 */
133	if (parents && parents->next)
134		return 0;
135
136	/*
137	 * If this is the root commit, do what rev_info tells us.
138	 */
139	if (!parents)
140		return revs->show_root_diff;
141
142	/* When we get here we have precisely one parent. */
143	parent = parents->item;
144	/* If we can't parse the commit, let print_commit() report an error. */
145	if (parse_commit(parent))
146		return 1;
147
148	files = 0;
149	add_lines = 0;
150	rem_lines = 0;
151
152	DIFF_OPT_SET(&revs->diffopt, RECURSIVE);
153	diff_tree_sha1(parent->tree->object.oid.hash,
154		       commit->tree->object.oid.hash,
155		       "", &revs->diffopt);
156	diffcore_std(&revs->diffopt);
157
158	found = !diff_queue_is_empty();
159	saved_fmt = revs->diffopt.output_format;
160	revs->diffopt.output_format = DIFF_FORMAT_CALLBACK;
161	revs->diffopt.format_callback = cgit_diff_tree_cb;
162	revs->diffopt.format_callback_data = handle_rename;
163	diff_flush(&revs->diffopt);
164	revs->diffopt.output_format = saved_fmt;
165	revs->diffopt.flags = saved_flags;
166
167	lines_counted = 1;
168	return found;
169}
170
171static void print_commit(struct commit *commit, struct rev_info *revs)
172{
173	struct commitinfo *info;
174	int columns = revs->graph ? 4 : 3;
175	struct strbuf graphbuf = STRBUF_INIT;
176	struct strbuf msgbuf = STRBUF_INIT;
177
178	if (ctx.repo->enable_log_filecount)
179		columns++;
180	if (ctx.repo->enable_log_linecount)
181		columns++;
182
183	if (revs->graph) {
184		/* Advance graph until current commit */
185		while (!graph_next_line(revs->graph, &graphbuf)) {
186			/* Print graph segment in otherwise empty table row */
187			html("<tr class='nohover'><td class='commitgraph'>");
188			html(graphbuf.buf);
189			htmlf("</td><td colspan='%d' /></tr>\n", columns);
190			strbuf_setlen(&graphbuf, 0);
191		}
192		/* Current commit's graph segment is now ready in graphbuf */
193	}
194
195	info = cgit_parse_commit(commit);
196	htmlf("<tr%s>", ctx.qry.showmsg ? " class='logheader'" : "");
197
198	if (revs->graph) {
199		/* Print graph segment for current commit */
200		html("<td class='commitgraph'>");
201		html(graphbuf.buf);
202		html("</td>");
203		strbuf_setlen(&graphbuf, 0);
204	}
205	else {
206		html("<td>");
207		cgit_print_age(info->committer_date, info->committer_tz, TM_WEEK * 2);
208		html("</td>");
209	}
210
211	htmlf("<td%s>", ctx.qry.showmsg ? " class='logsubject'" : "");
212	if (ctx.qry.showmsg) {
213		/* line-wrap long commit subjects instead of truncating them */
214		size_t subject_len = strlen(info->subject);
215
216		if (subject_len > ctx.cfg.max_msg_len &&
217		    ctx.cfg.max_msg_len >= 15) {
218			/* symbol for signaling line-wrap (in PAGE_ENCODING) */
219			const char wrap_symbol[] = { ' ', 0xE2, 0x86, 0xB5, 0 };
220			int i = ctx.cfg.max_msg_len - strlen(wrap_symbol);
221
222			/* Rewind i to preceding space character */
223			while (i > 0 && !isspace(info->subject[i]))
224				--i;
225			if (!i) /* Oops, zero spaces. Reset i */
226				i = ctx.cfg.max_msg_len - strlen(wrap_symbol);
227
228			/* add remainder starting at i to msgbuf */
229			strbuf_add(&msgbuf, info->subject + i, subject_len - i);
230			strbuf_trim(&msgbuf);
231			strbuf_add(&msgbuf, "\n\n", 2);
232
233			/* Place wrap_symbol at position i in info->subject */
234			strcpy(info->subject + i, wrap_symbol);
235		}
236	}
237	cgit_commit_link(info->subject, NULL, NULL, ctx.qry.head,
238			 oid_to_hex(&commit->object.oid), ctx.qry.vpath);
239	show_commit_decorations(commit);
240	html("</td><td>");
241	cgit_open_filter(ctx.repo->email_filter, info->author_email, "log");
242	html_txt(info->author);
243	cgit_close_filter(ctx.repo->email_filter);
244
245	if (revs->graph) {
246		html("</td><td>");
247		cgit_print_age(info->committer_date, info->committer_tz, TM_WEEK * 2);
248	}
249
250	if (!lines_counted && (ctx.repo->enable_log_filecount ||
251			       ctx.repo->enable_log_linecount)) {
252		files = 0;
253		add_lines = 0;
254		rem_lines = 0;
255		cgit_diff_commit(commit, inspect_files, ctx.qry.vpath);
256	}
257
258	if (ctx.repo->enable_log_filecount)
259		htmlf("</td><td>%d", files);
260	if (ctx.repo->enable_log_linecount)
261		htmlf("</td><td><span class='deletions'>-%d</span>/"
262			"<span class='insertions'>+%d</span>", rem_lines, add_lines);
263
264	html("</td></tr>\n");
265
266	if (revs->graph || ctx.qry.showmsg) { /* Print a second table row */
267		html("<tr class='nohover'>");
268
269		if (ctx.qry.showmsg) {
270			/* Concatenate commit message + notes in msgbuf */
271			if (info->msg && *(info->msg)) {
272				strbuf_addstr(&msgbuf, info->msg);
273				strbuf_addch(&msgbuf, '\n');
274			}
275			format_display_notes(commit->object.oid.hash,
276					     &msgbuf, PAGE_ENCODING, 0);
277			strbuf_addch(&msgbuf, '\n');
278			strbuf_ltrim(&msgbuf);
279		}
280
281		if (revs->graph) {
282			int lines = 0;
283
284			/* Calculate graph padding */
285			if (ctx.qry.showmsg) {
286				/* Count #lines in commit message + notes */
287				const char *p = msgbuf.buf;
288				lines = 1;
289				while ((p = strchr(p, '\n'))) {
290					p++;
291					lines++;
292				}
293			}
294
295			/* Print graph padding */
296			html("<td class='commitgraph'>");
297			while (lines > 0 || !graph_is_commit_finished(revs->graph)) {
298				if (graphbuf.len)
299					html("\n");
300				strbuf_setlen(&graphbuf, 0);
301				graph_next_line(revs->graph, &graphbuf);
302				html(graphbuf.buf);
303				lines--;
304			}
305			html("</td>\n");
306		}
307		else
308			html("<td/>"); /* Empty 'Age' column */
309
310		/* Print msgbuf into remainder of table row */
311		htmlf("<td colspan='%d'%s>\n", columns - (revs->graph ? 1 : 0),
312			ctx.qry.showmsg ? " class='logmsg'" : "");
313		html_txt(msgbuf.buf);
314		html("</td></tr>\n");
315	}
316
317	strbuf_release(&msgbuf);
318	strbuf_release(&graphbuf);
319	cgit_free_commitinfo(info);
320}
321
322static const char *disambiguate_ref(const char *ref, int *must_free_result)
323{
324	struct object_id oid;
325	struct strbuf longref = STRBUF_INIT;
326
327	strbuf_addf(&longref, "refs/heads/%s", ref);
328	if (get_oid(longref.buf, &oid) == 0) {
329		*must_free_result = 1;
330		return strbuf_detach(&longref, NULL);
331	}
332
333	*must_free_result = 0;
334	strbuf_release(&longref);
335	return ref;
336}
337
338static char *next_token(char **src)
339{
340	char *result;
341
342	if (!src || !*src)
343		return NULL;
344	while (isspace(**src))
345		(*src)++;
346	if (!**src)
347		return NULL;
348	result = *src;
349	while (**src) {
350		if (isspace(**src)) {
351			**src = '\0';
352			(*src)++;
353			break;
354		}
355		(*src)++;
356	}
357	return result;
358}
359
360void cgit_print_log(const char *tip, int ofs, int cnt, char *grep, char *pattern,
361		    char *path, int pager, int commit_graph, int commit_sort)
362{
363	struct rev_info rev;
364	struct commit *commit;
365	struct argv_array rev_argv = ARGV_ARRAY_INIT;
366	int i, columns = commit_graph ? 4 : 3;
367	int must_free_tip = 0;
368
369	/* rev_argv.argv[0] will be ignored by setup_revisions */
370	argv_array_push(&rev_argv, "log_rev_setup");
371
372	if (!tip)
373		tip = ctx.qry.head;
374	tip = disambiguate_ref(tip, &must_free_tip);
375	argv_array_push(&rev_argv, tip);
376
377	if (grep && pattern && *pattern) {
378		pattern = xstrdup(pattern);
379		if (!strcmp(grep, "grep") || !strcmp(grep, "author") ||
380		    !strcmp(grep, "committer")) {
381			argv_array_pushf(&rev_argv, "--%s=%s", grep, pattern);
382		} else if (!strcmp(grep, "range")) {
383			char *arg;
384			/* Split the pattern at whitespace and add each token
385			 * as a revision expression. Do not accept other
386			 * rev-list options. Also, replace the previously
387			 * pushed tip (it's no longer relevant).
388			 */
389			argv_array_pop(&rev_argv);
390			while ((arg = next_token(&pattern))) {
391				if (*arg == '-') {
392					fprintf(stderr, "Bad range expr: %s\n",
393						arg);
394					break;
395				}
396				argv_array_push(&rev_argv, arg);
397			}
398		}
399	}
400
401	if (!path || !ctx.cfg.enable_follow_links) {
402		/*
403		 * If we don't have a path, "follow" is a no-op so make sure
404		 * the variable is set to false to avoid needing to check
405		 * both this and whether we have a path everywhere.
406		 */
407		ctx.qry.follow = 0;
408	}
409
410	if (commit_graph && !ctx.qry.follow) {
411		argv_array_push(&rev_argv, "--graph");
412		argv_array_push(&rev_argv, "--color");
413		graph_set_column_colors(column_colors_html,
414					COLUMN_COLORS_HTML_MAX);
415	}
416
417	if (commit_sort == 1)
418		argv_array_push(&rev_argv, "--date-order");
419	else if (commit_sort == 2)
420		argv_array_push(&rev_argv, "--topo-order");
421
422	if (path && ctx.qry.follow)
423		argv_array_push(&rev_argv, "--follow");
424	argv_array_push(&rev_argv, "--");
425	if (path)
426		argv_array_push(&rev_argv, path);
427
428	init_revisions(&rev, NULL);
429	rev.abbrev = DEFAULT_ABBREV;
430	rev.commit_format = CMIT_FMT_DEFAULT;
431	rev.verbose_header = 1;
432	rev.show_root_diff = 0;
433	rev.ignore_missing = 1;
434	rev.simplify_history = 1;
435	setup_revisions(rev_argv.argc, rev_argv.argv, &rev, NULL);
436	load_ref_decorations(DECORATE_FULL_REFS);
437	rev.show_decorations = 1;
438	rev.grep_filter.regflags |= REG_ICASE;
439
440	rev.diffopt.detect_rename = 1;
441	rev.diffopt.rename_limit = ctx.cfg.renamelimit;
442	if (ctx.qry.ignorews)
443		DIFF_XDL_SET(&rev.diffopt, IGNORE_WHITESPACE);
444
445	compile_grep_patterns(&rev.grep_filter);
446	prepare_revision_walk(&rev);
447
448	if (pager) {
449		cgit_print_layout_start();
450		html("<table class='list nowrap'>");
451	}
452
453	html("<tr class='nohover'>");
454	if (commit_graph)
455		html("<th></th>");
456	else
457		html("<th class='left'>Age</th>");
458	html("<th class='left'>Commit message");
459	if (pager) {
460		html(" (");
461		cgit_log_link(ctx.qry.showmsg ? "Collapse" : "Expand", NULL,
462			      NULL, ctx.qry.head, ctx.qry.sha1,
463			      ctx.qry.vpath, ctx.qry.ofs, ctx.qry.grep,
464			      ctx.qry.search, ctx.qry.showmsg ? 0 : 1,
465			      ctx.qry.follow);
466		html(")");
467	}
468	html("</th><th class='left'>Author</th>");
469	if (rev.graph)
470		html("<th class='left'>Age</th>");
471	if (ctx.repo->enable_log_filecount) {
472		html("<th class='left'>Files</th>");
473		columns++;
474	}
475	if (ctx.repo->enable_log_linecount) {
476		html("<th class='left'>Lines</th>");
477		columns++;
478	}
479	html("</tr>\n");
480
481	if (ofs<0)
482		ofs = 0;
483
484	for (i = 0; i < ofs && (commit = get_revision(&rev)) != NULL; /* nop */) {
485		if (show_commit(commit, &rev))
486			i++;
487		free_commit_buffer(commit);
488		free_commit_list(commit->parents);
489		commit->parents = NULL;
490	}
491
492	for (i = 0; i < cnt && (commit = get_revision(&rev)) != NULL; /* nop */) {
493		/*
494		 * In "follow" mode, we must count the files and lines the
495		 * first time we invoke diff on a given commit, and we need
496		 * to do that to see if the commit touches the path we care
497		 * about, so we do it in show_commit.  Hence we must clear
498		 * lines_counted here.
499		 *
500		 * This has the side effect of avoiding running diff twice
501		 * when we are both following renames and showing file
502		 * and/or line counts.
503		 */
504		lines_counted = 0;
505		if (show_commit(commit, &rev)) {
506			i++;
507			print_commit(commit, &rev);
508		}
509		free_commit_buffer(commit);
510		free_commit_list(commit->parents);
511		commit->parents = NULL;
512	}
513	if (pager) {
514		html("</table><ul class='pager'>");
515		if (ofs > 0) {
516			html("<li>");
517			cgit_log_link("[prev]", NULL, NULL, ctx.qry.head,
518				      ctx.qry.sha1, ctx.qry.vpath,
519				      ofs - cnt, ctx.qry.grep,
520				      ctx.qry.search, ctx.qry.showmsg,
521				      ctx.qry.follow);
522			html("</li>");
523		}
524		if ((commit = get_revision(&rev)) != NULL) {
525			html("<li>");
526			cgit_log_link("[next]", NULL, NULL, ctx.qry.head,
527				      ctx.qry.sha1, ctx.qry.vpath,
528				      ofs + cnt, ctx.qry.grep,
529				      ctx.qry.search, ctx.qry.showmsg,
530				      ctx.qry.follow);
531			html("</li>");
532		}
533		html("</ul>");
534		cgit_print_layout_end();
535	} else if ((commit = get_revision(&rev)) != NULL) {
536		htmlf("<tr class='nohover'><td colspan='%d'>", columns);
537		cgit_log_link("[...]", NULL, NULL, ctx.qry.head, NULL,
538			      ctx.qry.vpath, 0, NULL, NULL, ctx.qry.showmsg,
539			      ctx.qry.follow);
540		html("</td></tr>\n");
541	}
542
543	/* If we allocated tip then it is safe to cast away const. */
544	if (must_free_tip)
545		free((char*) tip);
546}