index : cgit

/*
 * The output layer every cgit page is built with, holding the escaping rules
 * for page text, attribute values, URL paths and query arguments along with
 * the small formatting helpers the rest of the code prints through. What is
 * written here is gathered into one buffer and handed to stdout in whole
 * blocks, because a page is made of a great many small fragments and a write
 * apiece spent more time in the kernel than rendering the page did. cgit
 * shares stdout with the filters it runs and with git itself, so that buffer
 * has to be emptied wherever another writer takes over.
 */

#include "cgit.h"
#include "html.h"

#define HTML_WRITE_BUFSIZE (64 * 1024)

// The percent encoding for each byte, with NULL marking the bytes a URL may
// carry as themselves. Those are the letters, the digits, and !$()*,-./:;@[]_~
static const char *url_escape_table[256] = {
	"%00", "%01", "%02", "%03", "%04", "%05", "%06", "%07",
	"%08", "%09", "%0a", "%0b", "%0c", "%0d", "%0e", "%0f",
	"%10", "%11", "%12", "%13", "%14", "%15", "%16", "%17",
	"%18", "%19", "%1a", "%1b", "%1c", "%1d", "%1e", "%1f",
	"%20", NULL,  "%22", "%23", NULL,  "%25", "%26", "%27",
	NULL,  NULL,  NULL,  "%2b", NULL,  NULL,  NULL,  NULL,
	NULL,  NULL,  NULL,  NULL,  NULL,  NULL,  NULL,  NULL,
	NULL,  NULL,  NULL,  NULL,  "%3c", "%3d", "%3e", "%3f",
	NULL,  NULL,  NULL,  NULL,  NULL,  NULL,  NULL,  NULL,
	NULL,  NULL,  NULL,  NULL,  NULL,  NULL,  NULL,  NULL,
	NULL,  NULL,  NULL,  NULL,  NULL,  NULL,  NULL,  NULL,
	NULL,  NULL,  NULL,  NULL,  "%5c", NULL,  "%5e", NULL,
	"%60", NULL,  NULL,  NULL,  NULL,  NULL,  NULL,  NULL,
	NULL,  NULL,  NULL,  NULL,  NULL,  NULL,  NULL,  NULL,
	NULL,  NULL,  NULL,  NULL,  NULL,  NULL,  NULL,  NULL,
	NULL,  NULL,  NULL,  "%7b", "%7c", "%7d", NULL,  "%7f",
	"%80", "%81", "%82", "%83", "%84", "%85", "%86", "%87",
	"%88", "%89", "%8a", "%8b", "%8c", "%8d", "%8e", "%8f",
	"%90", "%91", "%92", "%93", "%94", "%95", "%96", "%97",
	"%98", "%99", "%9a", "%9b", "%9c", "%9d", "%9e", "%9f",
	"%a0", "%a1", "%a2", "%a3", "%a4", "%a5", "%a6", "%a7",
	"%a8", "%a9", "%aa", "%ab", "%ac", "%ad", "%ae", "%af",
	"%b0", "%b1", "%b2", "%b3", "%b4", "%b5", "%b6", "%b7",
	"%b8", "%b9", "%ba", "%bb", "%bc", "%bd", "%be", "%bf",
	"%c0", "%c1", "%c2", "%c3", "%c4", "%c5", "%c6", "%c7",
	"%c8", "%c9", "%ca", "%cb", "%cc", "%cd", "%ce", "%cf",
	"%d0", "%d1", "%d2", "%d3", "%d4", "%d5", "%d6", "%d7",
	"%d8", "%d9", "%da", "%db", "%dc", "%dd", "%de", "%df",
	"%e0", "%e1", "%e2", "%e3", "%e4", "%e5", "%e6", "%e7",
	"%e8", "%e9", "%ea", "%eb", "%ec", "%ed", "%ee", "%ef",
	"%f0", "%f1", "%f2", "%f3", "%f4", "%f5", "%f6", "%f7",
	"%f8", "%f9", "%fa", "%fb", "%fc", "%fd", "%fe", "%ff"
};

static char out_buf[HTML_WRITE_BUFSIZE];
static size_t out_len;
static struct strbuf *capture;

static void write_out(const char *data, size_t size)
{
	// A blob, a snapshot or a patch reaches this with a size well past what
	// one write can move onto a pipe, so a short write is ordinary rather
	// than an error and has to be resumed instead of reported.
	if (write_in_full(STDOUT_FILENO, data, size) < 0)
		die_errno("write error on html output");
}

/*
 * Format into one of a rotating set of static buffers, so that a few results
 * can be alive at once, for example as several arguments to one call. The slot
 * count has to stay a power of two for the wrap below.
 */
char *cgit_fmt(const char *format, ...)
{
	static char buf[8][1024];
	static int slot;
	int len;
	va_list args;

	slot++;
	slot &= ARRAY_SIZE(buf) - 1;

	va_start(args, format);
	len = vsnprintf(buf[slot], sizeof(buf[slot]), format, args);
	va_end(args);
	if (len < 0 || (size_t)len >= sizeof(buf[slot])) {
		fprintf(stderr, "[html.c] string truncated: %s\n", format);
		exit(1);
	}
	return buf[slot];
}

char *cgit_fmtalloc(const char *format, ...)
{
	struct strbuf sb = STRBUF_INIT;
	va_list args;

	va_start(args, format);
	strbuf_vaddf(&sb, format, args);
	va_end(args);

	return strbuf_detach(&sb, NULL);
}

void html_flush(void)
{
	size_t len = out_len;

	if (!len)
		return;
	// Clear the length first, because write_out can die and the error page
	// it produces would otherwise try to flush the same bytes again.
	out_len = 0;
	write_out(out_buf, len);
}

void html_capture_begin(struct strbuf *sb)
{
	html_flush();
	capture = sb;
}

void html_capture_end(void)
{
	capture = NULL;
}

void html_raw(const char *data, size_t size)
{
	if (capture) {
		strbuf_add(capture, data, size);
		return;
	}
	if (size >= HTML_WRITE_BUFSIZE) {
		html_flush();
		write_out(data, size);
		return;
	}
	if (out_len + size > HTML_WRITE_BUFSIZE)
		html_flush();
	memcpy(out_buf + out_len, data, size);
	out_len += size;
}

void html(const char *txt)
{
	html_raw(txt, strlen(txt));
}

void htmlf(const char *format, ...)
{
	va_list args;
	struct strbuf sb = STRBUF_INIT;

	va_start(args, format);
	strbuf_vaddf(&sb, format, args);
	va_end(args);
	html(sb.buf);
	strbuf_release(&sb);
}

void html_txtf(const char *format, ...)
{
	va_list args;

	va_start(args, format);
	html_vtxtf(format, args);
	va_end(args);
}

void html_vtxtf(const char *format, va_list ap)
{
	va_list copy;
	struct strbuf sb = STRBUF_INIT;

	va_copy(copy, ap);
	strbuf_vaddf(&sb, format, copy);
	va_end(copy);
	html_txt(sb.buf);
	strbuf_release(&sb);
}

void html_txt(const char *txt)
{
	if (txt)
		html_ntxt(txt, strlen(txt));
}

ssize_t html_ntxt(const char *txt, size_t len)
{
	const char *p = txt;
	ssize_t left;

	if (len > SSIZE_MAX)
		return -1;

	left = (ssize_t) len;
	while (p && *p && left--) {
		int c = *p;
		if (c == '<' || c == '>' || c == '&') {
			html_raw(txt, p - txt);
			if (c == '>')
				html("&gt;");
			else if (c == '<')
				html("&lt;");
			else if (c == '&')
				html("&amp;");
			txt = p + 1;
		}
		p++;
	}
	if (p != txt)
		html_raw(txt, p - txt);
	return left;
}

void html_attrf(const char *format, ...)
{
	va_list args;
	struct strbuf sb = STRBUF_INIT;

	va_start(args, format);
	strbuf_vaddf(&sb, format, args);
	va_end(args);

	html_attr(sb.buf);
	strbuf_release(&sb);
}

void html_attr(const char *txt)
{
	const char *p = txt;
	while (p && *p) {
		int c = *p;
		if (c == '<' || c == '>' || c == '\'' || c == '\"' || c == '&') {
			html_raw(txt, p - txt);
			if (c == '>')
				html("&gt;");
			else if (c == '<')
				html("&lt;");
			else if (c == '\'')
				html("&#x27;");
			else if (c == '"')
				html("&quot;");
			else if (c == '&')
				html("&amp;");
			txt = p + 1;
		}
		p++;
	}
	if (p != txt)
		html(txt);
}

void html_url_path(const char *txt)
{
	const char *p = txt;
	while (p && *p) {
		unsigned char c = *p;
		const char *esc = url_escape_table[c];
		// The table is shared with the query string case, where a plus
		// means a space and an ampersand separates parameters. Neither
		// carries that meaning in a path.
		if (esc && c != '+' && c != '&') {
			html_raw(txt, p - txt);
			html(esc);
			txt = p + 1;
		}
		p++;
	}
	if (p != txt)
		html(txt);
}

void html_url_arg(const char *txt)
{
	const char *p = txt;
	while (p && *p) {
		unsigned char c = *p;
		const char *esc = url_escape_table[c];
		if (c == ' ')
			esc = "+";
		if (esc) {
			html_raw(txt, p - txt);
			html(esc);
			txt = p + 1;
		}
		p++;
	}
	if (p != txt)
		html(txt);
}

void html_header_arg_in_quotes(const char *txt)
{
	const char *p = txt;
	while (p && *p) {
		unsigned char c = *p;
		const char *esc = NULL;
		if (c == '\\')
			esc = "\\\\";
		else if (c == '\r')
			esc = "\\r";
		else if (c == '\n')
			esc = "\\n";
		else if (c == '"')
			esc = "\\\"";
		if (esc) {
			html_raw(txt, p - txt);
			html(esc);
			txt = p + 1;
		}
		p++;
	}
	if (p != txt)
		html(txt);
}

void html_hidden(const char *name, const char *value)
{
	html("<input type='hidden' name='");
	html_attr(name);
	html("' value='");
	html_attr(value);
	html("'/>");
}

void html_option(const char *value, const char *text,
		 const char *selected_value)
{
	html("<option value='");
	html_attr(value);
	html("'");
	if (selected_value && !strcmp(selected_value, value))
		html(" selected='selected'");
	html(">");
	html_txt(text);
	html("</option>\n");
}

void html_intoption(int value, const char *text, int selected_value)
{
	htmlf("<option value='%d'%s>", value,
	      value == selected_value ? " selected='selected'" : "");
	html_txt(text);
	html("</option>");
}

void html_link_open(const char *url, const char *title, const char *class)
{
	html("<a href='");
	html_attr(url);
	if (title) {
		html("' title='");
		html_attr(title);
	}
	if (class) {
		html("' class='");
		html_attr(class);
	}
	html("'>");
}

void html_link_close(void)
{
	html("</a>");
}

/*
 * Render one permission triplet, so a caller prints a whole mode by passing it
 * shifted right by six, then by three, then unshifted.
 */
void html_fileperm(unsigned short mode)
{
	htmlf("%c%c%c", (mode & 4 ? 'r' : '-'),
	      (mode & 2 ? 'w' : '-'), (mode & 1 ? 'x' : '-'));
}

int html_include(const char *filename)
{
	FILE *f;
	char buf[4096];
	size_t len;

	if (!(f = fopen(filename, "r"))) {
		fprintf(stderr, "[cgit] Failed to include file %s: %s (%d).\n",
			filename, strerror(errno), errno);
		return -1;
	}
	while ((len = fread(buf, 1, sizeof(buf), f)) > 0)
		html_raw(buf, len);
	fclose(f);
	return 0;
}

void http_parse_querystring(const char *txt,
			    void (*fn)(const char *name, const char *value))
{
	const char *p = txt;

	while (p && *p) {
		char *name = url_decode_parameter_name(&p);
		if (*name) {
			char *value = url_decode_parameter_value(&p);
			fn(name, value);
			free(value);
		}
		free(name);
	}
}