index : cgit

/*
 * The branch and tag listings, shown as sections of the summary page and as
 * the whole of a repository's refs page. Every row is one ref beside
 * the commit or tag object it points at, ordered newest first, with branches
 * then reordered by name unless branch-sort asks for age. A section longer
 * than its cap is cut short and ends in a link to a dedicated heads or
 * tags page, which walks the same list one offset at a time.
 */

#define USE_THE_REPOSITORY_VARIABLE

#include "cgit.h"
#include "filter.h"
#include "html.h"
#include "parsing.h"
#include "ui-refs.h"
#include "ui-shared.h"

struct refinfo {
	const char *refname;
	struct object *object;
	union {
		struct taginfo *tag;
		struct commitinfo *commit;
	};
};

struct reflist {
	struct refinfo **refs;
	int alloc;
	int count;
};

// The slice of a sorted ref list that one page shows, with end one past the
// last row. size is what a full page holds, so it also decides whether the
// list needs a pager.
struct ref_page {
	int size;
	int start;
	int end;
};

static void free_refinfo(struct refinfo *ref)
{
	free((char *)ref->refname);
	switch (ref->object->type) {
	case OBJ_TAG:
		cgit_free_taginfo(ref->tag);
		break;
	case OBJ_COMMIT:
		cgit_free_commitinfo(ref->commit);
		break;
	}
	free(ref);
}

static struct refinfo *make_refinfo(const char *refname, const struct object_id *oid)
{
	struct refinfo *ref;

	ref = xcalloc(1, sizeof(struct refinfo));
	ref->refname = xstrdup(refname);
	ref->object = parse_object(the_repository, oid);
	if (!ref->object) {
		free((char *)ref->refname);
		free(ref);
		return NULL;
	}
	switch (ref->object->type) {
	case OBJ_TAG:
		ref->tag = cgit_parse_tag((struct tag *)ref->object);
		break;
	case OBJ_COMMIT:
		ref->commit = cgit_parse_commit((struct commit *)ref->object);
		break;
	}
	return ref;
}

static void free_reflist_inner(struct reflist *list)
{
	int i;

	for (i = 0; i < list->count; i++)
		free_refinfo(list->refs[i]);
	free(list->refs);
}

/*
 * Matches git's reference iteration callback, and appends each ref it is given
 * to the struct reflist passed as cb_data.
 */
static int refs_cb(const struct reference *ref, void *cb_data)
{
	struct reflist *list = (struct reflist *)cb_data;
	struct refinfo *info = make_refinfo(ref->name, ref->oid);

	if (info) {
		ALLOC_GROW(list->refs, list->count + 1, list->alloc);
		list->refs[list->count++] = info;
	}
	return 0;
}

/*
 * The tagger date and the committer date live in a union in struct refinfo and
 * only the member matching the object type is ever filled, so assuming a ref
 * points at a commit reads past the end of the smaller struct.
 */
static timestamp_t ref_date(struct refinfo *ref)
{
	switch (ref->object->type) {
	case OBJ_TAG:
		return ref->tag ? ref->tag->tagger_date : 0;
	case OBJ_COMMIT:
		return ref->commit->committer_date;
	}
	return 0;
}

static int cmp_date(const void *a, const void *b)
{
	struct refinfo *ref1 = *(struct refinfo **)a;
	struct refinfo *ref2 = *(struct refinfo **)b;
	timestamp_t date1 = ref_date(ref1), date2 = ref_date(ref2);

	// Compared rather than subtracted, at the width the dates are stored
	// at. A commit may carry any timestamp, so a difference that does not
	// fit an int would leave qsort with a contradictory ordering.
	if (date1 < date2)
		return 1;
	if (date1 > date2)
		return -1;
	return 0;
}

static int cmp_name(const void *a, const void *b)
{
	struct refinfo *ref1 = *(struct refinfo **)a;
	struct refinfo *ref2 = *(struct refinfo **)b;

	return strcmp(ref1->refname, ref2->refname);
}

static void collect_branches(struct reflist *list)
{
	list->refs = NULL;
	list->alloc = list->count = 0;
	refs_for_each_branch_ref(get_main_ref_store(the_repository), refs_cb, list);
	if (ctx.repo->enable_remote_branches)
		refs_for_each_remote_ref(get_main_ref_store(the_repository), refs_cb, list);
}

/*
 * The age is the last cell of a ref row, so in a table wider than a ref row
 * needs, as on a summary whose log shows counts, it stretches across the
 * columns left over.
 */
static const char *age_colspan(int columns)
{
	if (columns <= REF_COLUMNS)
		return "";
	return cgit_fmt(" colspan='%d'", columns - REF_COLUMNS + 1);
}

static void print_branch_header(int columns)
{
	html(
		"<tbody class='branches'>\n"
		"<tr class='nohover'><th class='left' scope='col'>Branch</th>"
		"<th class='left' scope='col'>Commit message</th>"
		"<th class='left col-author' scope='col'>Author</th>"
	);
	htmlf("<th%s class='left' scope='col'>Age</th></tr>\n", age_colspan(columns));
}

static void print_branch(struct refinfo *ref, int columns)
{
	struct commitinfo *info = ref->commit;
	const char *name = ref->refname;

	if (!info)
		return;
	html("<tr class='branch'><td>");
	cgit_log_link(name, NULL, NULL, name, NULL, NULL, 0, NULL, NULL, ctx.qry.showmsg, 0);
	html("</td><td>");

	if (ref->object->type == OBJ_COMMIT) {
		cgit_commit_link(info->subject, NULL, NULL, name, NULL, NULL);
		html("</td><td class='col-author'>");
		// A filter must not be handed a NULL argument.
		cgit_open_filter(
			ctx.repo->email_filter, info->author_email ? info->author_email : "", "refs"
		);
		html_txt(info->author);
		cgit_close_filter(ctx.repo->email_filter);
		htmlf("</td><td%s>", age_colspan(columns));
		cgit_print_age(info->committer_date, info->committer_tz, -1);
	} else {
		// The object link sits in the message column, and the empty
		// tail cells keep the row as wide as the header.
		cgit_object_link(ref->object, 0);
		htmlf("</td><td class='col-author'></td><td%s>", age_colspan(columns));
	}
	html("</td></tr>\n");
}

static void collect_tags(struct reflist *list)
{
	list->refs = NULL;
	list->alloc = list->count = 0;
	refs_for_each_tag_ref(get_main_ref_store(the_repository), refs_cb, list);
}

static void print_tag_header(int columns)
{
	html(
		"<tbody class='tags'>\n"
		"<tr class='nohover'><th class='left' scope='col'>Tag</th>"
		"<th class='left' scope='col'>Download</th>"
		"<th class='left col-author' scope='col'>Author</th>"
	);
	htmlf("<th%s class='left' scope='col'>Age</th></tr>\n", age_colspan(columns));
}

static void print_tag(struct refinfo *ref, int columns)
{
	struct taginfo *info = NULL;
	const char *name = ref->refname;
	struct object *obj = ref->object;

	// A lightweight tag has no tag object, so the author and age columns
	// below fall back to the commit.
	if (obj->type == OBJ_TAG) {
		struct tag *tag = (struct tag *)obj;

		obj = tag->tagged;
		info = ref->tag;
		if (!info)
			return;
	}

	html("<tr class='tag'><td>");
	cgit_tag_link(name, NULL, NULL, name);
	html("</td><td>");
	if (ctx.repo->snapshots && (obj->type == OBJ_COMMIT))
		cgit_print_snapshot_links(ctx.repo, name, " ");
	else
		cgit_object_link(obj, 0);
	html("</td><td class='col-author'>");
	if (info) {
		if (info->tagger) {
			cgit_open_filter(ctx.repo->email_filter, info->tagger_email, "refs");
			html_txt(info->tagger);
			cgit_close_filter(ctx.repo->email_filter);
		}
	} else if (ref->object->type == OBJ_COMMIT) {
		cgit_open_filter(
			ctx.repo->email_filter, ref->commit->author_email ? ref->commit->author_email : "",
			"refs"
		);
		html_txt(ref->commit->author);
		cgit_close_filter(ctx.repo->email_filter);
	}
	htmlf("</td><td%s>", age_colspan(columns));
	if (info) {
		if (info->tagger_date > 0)
			cgit_print_age(info->tagger_date, info->tagger_tz, -1);
	} else if (ref->object->type == OBJ_COMMIT) {
		cgit_print_age(ref->commit->commit->date, 0, -1);
	}
	html("</td></tr>\n");
}

static void print_refs_link(const char *path, int columns)
{
	htmlf("<tr class='nohover'><td colspan='%d'>", columns);
	cgit_refs_link("[...]", NULL, NULL, ctx.qry.head, NULL, path);
	html("</td></tr>\n");
}

static void print_ref_pager(int ofs, int pagesize, int count, const char *path)
{
	char *url;

	htmlf("<tr class='nohover'><td colspan='%d' class='refs-pager'>", REF_COLUMNS);
	if (ofs > 0) {
		int prev_ofs = ofs > pagesize ? ofs - pagesize : 0;

		url = cgit_pageurl(ctx.qry.repo, cgit_fmt("refs/%s", path), cgit_fmt("ofs=%d", prev_ofs));
		html("<a href='");
		html_attr(url);
		html("'>[prev]</a> ");
		free(url);
	}
	htmlf("%d - %d of %d", ofs + 1, ofs + pagesize < count ? ofs + pagesize : count, count);
	if (ofs + pagesize < count) {
		url = cgit_pageurl(ctx.qry.repo, cgit_fmt("refs/%s", path),
			cgit_fmt("ofs=%d", ofs + pagesize));
		html(" <a href='");
		html_attr(url);
		html("'>[next]</a>");
		free(url);
	}
	html("</td></tr>\n");
}

static struct ref_page page_bounds(int pagesize, int count)
{
	struct ref_page page;

	page.size = (pagesize <= 0 || pagesize > count) ? count : pagesize;
	page.start = ctx.qry.ofs > 0 ? ctx.qry.ofs : 0;
	if (page.start > count)
		page.start = count;
	page.end = page.start + page.size < count ? page.start + page.size : count;
	return page;
}

/*
 * Unlike the capped sections, the whole list is sorted before a page is cut
 * out of it, so a branch keeps its place no matter which page it lands on.
 */
static void print_branches_page(int pagesize)
{
	struct reflist list;
	struct ref_page page;
	int i;

	print_branch_header(REF_COLUMNS);
	collect_branches(&list);

	QSORT(list.refs, list.count, cmp_date);
	if (ctx.repo->branch_sort == 0)
		QSORT(list.refs, list.count, cmp_name);

	page = page_bounds(pagesize, list.count);

	for (i = page.start; i < page.end; i++)
		print_branch(list.refs[i], REF_COLUMNS);

	if (page.size < list.count)
		print_ref_pager(page.start, page.size, list.count, "heads");
	html("</tbody>\n");

	free_reflist_inner(&list);
}

static void print_tags_page(int pagesize)
{
	struct reflist list;
	struct ref_page page;
	int i;

	collect_tags(&list);
	if (list.count == 0)
		return;
	QSORT(list.refs, list.count, cmp_date);

	page = page_bounds(pagesize, list.count);

	print_tag_header(REF_COLUMNS);
	for (i = page.start; i < page.end; i++)
		print_tag(list.refs[i], REF_COLUMNS);

	if (page.size < list.count)
		print_ref_pager(page.start, page.size, list.count, "tags");
	html("</tbody>\n");

	free_reflist_inner(&list);
}

void cgit_print_branches(int maxcount, int columns)
{
	struct reflist list;
	int i;

	print_branch_header(columns);
	collect_branches(&list);

	if (maxcount <= 0 || maxcount > list.count)
		maxcount = list.count;

	// The date sort covers the list, the name sort only the rows about to
	// be shown, so the section holds the newest branches rather than the
	// first ones by name.
	QSORT(list.refs, list.count, cmp_date);
	if (ctx.repo->branch_sort == 0)
		QSORT(list.refs, maxcount, cmp_name);

	for (i = 0; i < maxcount; i++)
		print_branch(list.refs[i], columns);

	if (maxcount < list.count)
		print_refs_link("heads", columns);
	html("</tbody>\n");

	free_reflist_inner(&list);
}

void cgit_print_tags(int maxcount, int columns)
{
	struct reflist list;
	int i;

	collect_tags(&list);
	if (list.count == 0)
		return;
	QSORT(list.refs, list.count, cmp_date);
	if (maxcount <= 0 || maxcount > list.count)
		maxcount = list.count;
	print_tag_header(columns);
	for (i = 0; i < maxcount; i++)
		print_tag(list.refs[i], columns);

	if (maxcount < list.count)
		print_refs_link("tags", columns);
	html("</tbody>\n");

	free_reflist_inner(&list);
}

void cgit_print_refs(void)
{
	cgit_print_layout_start();
	html("<table class='list refs' aria-label='Branches and tags'>\n");

	if (ctx.qry.path && starts_with(ctx.qry.path, "heads")) {
		print_branches_page(ctx.cfg.max_ref_count);
	} else if (ctx.qry.path && starts_with(ctx.qry.path, "tags")) {
		print_tags_page(ctx.cfg.max_ref_count);
	} else {
		cgit_print_branches(ctx.cfg.max_ref_count, REF_COLUMNS);
		cgit_print_tags(ctx.cfg.max_ref_count, REF_COLUMNS);
	}
	html("</table>\n");
	cgit_print_layout_end();
}