all repos — cgit @ 499b23979cd29513df16e4c2acce934932e09f7a

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