all repos — cgit @ 204669ff4a4028a82cc48e9319632595ba3ff703

a hyperfast web frontend for git written in c

ui-shared.c (view raw)

  1/* ui-shared.c: common web output functions
  2 *
  3 * Copyright (C) 2006 Lars Hjemli
  4 *
  5 * Licensed under GNU General Public License v2
  6 *   (see COPYING for full license text)
  7 */
  8
  9#include "cgit.h"
 10#include "cmd.h"
 11#include "html.h"
 12
 13const char cgit_doctype[] =
 14"<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n"
 15"  \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
 16
 17static char *http_date(time_t t)
 18{
 19	static char day[][4] =
 20		{"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"};
 21	static char month[][4] =
 22		{"Jan", "Feb", "Mar", "Apr", "May", "Jun",
 23		 "Jul", "Aug", "Sep", "Oct", "Now", "Dec"};
 24	struct tm *tm = gmtime(&t);
 25	return fmt("%s, %02d %s %04d %02d:%02d:%02d GMT", day[tm->tm_wday],
 26		   tm->tm_mday, month[tm->tm_mon], 1900+tm->tm_year,
 27		   tm->tm_hour, tm->tm_min, tm->tm_sec);
 28}
 29
 30void cgit_print_error(char *msg)
 31{
 32	html("<div class='error'>");
 33	html_txt(msg);
 34	html("</div>\n");
 35}
 36
 37char *cgit_hosturl()
 38{
 39	char *host, *port;
 40
 41	host = getenv("HTTP_HOST");
 42	if (host) {
 43		host = xstrdup(host);
 44	} else {
 45		host = getenv("SERVER_NAME");
 46		if (!host)
 47			return NULL;
 48		port = getenv("SERVER_PORT");
 49		if (port && atoi(port) != 80)
 50			host = xstrdup(fmt("%s:%d", host, atoi(port)));
 51		else
 52			host = xstrdup(host);
 53	}
 54	return host;
 55}
 56
 57char *cgit_rooturl()
 58{
 59	if (ctx.cfg.virtual_root)
 60		return fmt("%s/", ctx.cfg.virtual_root);
 61	else
 62		return ctx.cfg.script_name;
 63}
 64
 65char *cgit_repourl(const char *reponame)
 66{
 67	if (ctx.cfg.virtual_root) {
 68		return fmt("%s/%s/", ctx.cfg.virtual_root, reponame);
 69	} else {
 70		return fmt("?r=%s", reponame);
 71	}
 72}
 73
 74char *cgit_fileurl(const char *reponame, const char *pagename,
 75		   const char *filename, const char *query)
 76{
 77	char *tmp;
 78	char *delim;
 79
 80	if (ctx.cfg.virtual_root) {
 81		tmp = fmt("%s/%s/%s/%s", ctx.cfg.virtual_root, reponame,
 82			  pagename, (filename ? filename:""));
 83		delim = "?";
 84	} else {
 85		tmp = fmt("?url=%s/%s/%s", reponame, pagename,
 86			  (filename ? filename : ""));
 87		delim = "&";
 88	}
 89	if (query)
 90		tmp = fmt("%s%s%s", tmp, delim, query);
 91	return tmp;
 92}
 93
 94char *cgit_pageurl(const char *reponame, const char *pagename,
 95		   const char *query)
 96{
 97	return cgit_fileurl(reponame,pagename,0,query);
 98}
 99
100const char *cgit_repobasename(const char *reponame)
101{
102	/* I assume we don't need to store more than one repo basename */
103	static char rvbuf[1024];
104	int p;
105	const char *rv;
106	strncpy(rvbuf,reponame,sizeof(rvbuf));
107	if(rvbuf[sizeof(rvbuf)-1])
108		die("cgit_repobasename: truncated repository name '%s'", reponame);
109	p = strlen(rvbuf)-1;
110	/* strip trailing slashes */
111	while(p && rvbuf[p]=='/') rvbuf[p--]=0;
112	/* strip trailing .git */
113	if(p>=3 && !strncmp(&rvbuf[p-3],".git",4)) {
114		p -= 3; rvbuf[p--] = 0;
115	}
116	/* strip more trailing slashes if any */
117	while( p && rvbuf[p]=='/') rvbuf[p--]=0;
118	/* find last slash in the remaining string */
119	rv = strrchr(rvbuf,'/');
120	if(rv)
121		return ++rv;
122	return rvbuf;
123}
124
125char *cgit_currurl()
126{
127	if (!ctx.cfg.virtual_root)
128		return ctx.cfg.script_name;
129	else if (ctx.qry.page)
130		return fmt("%s/%s/%s/", ctx.cfg.virtual_root, ctx.qry.repo, ctx.qry.page);
131	else if (ctx.qry.repo)
132		return fmt("%s/%s/", ctx.cfg.virtual_root, ctx.qry.repo);
133	else
134		return fmt("%s/", ctx.cfg.virtual_root);
135}
136
137static void site_url(char *page, char *search, int ofs)
138{
139	char *delim = "?";
140
141	if (ctx.cfg.virtual_root) {
142		html_attr(ctx.cfg.virtual_root);
143		if (ctx.cfg.virtual_root[strlen(ctx.cfg.virtual_root) - 1] != '/')
144			html("/");
145	} else
146		html(ctx.cfg.script_name);
147
148	if (page) {
149		htmlf("?p=%s", page);
150		delim = "&";
151	}
152	if (search) {
153		html(delim);
154		html("q=");
155		html_attr(search);
156		delim = "&";
157	}
158	if (ofs) {
159		html(delim);
160		htmlf("ofs=%d", ofs);
161	}
162}
163
164static void site_link(char *page, char *name, char *title, char *class,
165		      char *search, int ofs)
166{
167	html("<a");
168	if (title) {
169		html(" title='");
170		html_attr(title);
171		html("'");
172	}
173	if (class) {
174		html(" class='");
175		html_attr(class);
176		html("'");
177	}
178	html(" href='");
179	site_url(page, search, ofs);
180	html("'>");
181	html_txt(name);
182	html("</a>");
183}
184
185void cgit_index_link(char *name, char *title, char *class, char *pattern,
186		     int ofs)
187{
188	site_link(NULL, name, title, class, pattern, ofs);
189}
190
191static char *repolink(char *title, char *class, char *page, char *head,
192		      char *path)
193{
194	char *delim = "?";
195
196	html("<a");
197	if (title) {
198		html(" title='");
199		html_attr(title);
200		html("'");
201	}
202	if (class) {
203		html(" class='");
204		html_attr(class);
205		html("'");
206	}
207	html(" href='");
208	if (ctx.cfg.virtual_root) {
209		html_attr(ctx.cfg.virtual_root);
210		if (ctx.cfg.virtual_root[strlen(ctx.cfg.virtual_root) - 1] != '/')
211			html("/");
212		html_attr(ctx.repo->url);
213		if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
214			html("/");
215		if (page) {
216			html(page);
217			html("/");
218			if (path)
219				html_attr(path);
220		}
221	} else {
222		html(ctx.cfg.script_name);
223		html("?url=");
224		html_attr(ctx.repo->url);
225		if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
226			html("/");
227		if (page) {
228			html(page);
229			html("/");
230			if (path)
231				html_attr(path);
232		}
233		delim = "&amp;";
234	}
235	if (head && strcmp(head, ctx.repo->defbranch)) {
236		html(delim);
237		html("h=");
238		html_attr(head);
239		delim = "&amp;";
240	}
241	return fmt("%s", delim);
242}
243
244static void reporevlink(char *page, char *name, char *title, char *class,
245			char *head, char *rev, char *path)
246{
247	char *delim;
248
249	delim = repolink(title, class, page, head, path);
250	if (rev && strcmp(rev, ctx.qry.head)) {
251		html(delim);
252		html("id=");
253		html_attr(rev);
254	}
255	html("'>");
256	html_txt(name);
257	html("</a>");
258}
259
260void cgit_tree_link(char *name, char *title, char *class, char *head,
261		    char *rev, char *path)
262{
263	reporevlink("tree", name, title, class, head, rev, path);
264}
265
266void cgit_plain_link(char *name, char *title, char *class, char *head,
267		     char *rev, char *path)
268{
269	reporevlink("plain", name, title, class, head, rev, path);
270}
271
272void cgit_log_link(char *name, char *title, char *class, char *head,
273		   char *rev, char *path, int ofs, char *grep, char *pattern)
274{
275	char *delim;
276
277	delim = repolink(title, class, "log", head, path);
278	if (rev && strcmp(rev, ctx.qry.head)) {
279		html(delim);
280		html("id=");
281		html_attr(rev);
282		delim = "&";
283	}
284	if (grep && pattern) {
285		html(delim);
286		html("qt=");
287		html_attr(grep);
288		delim = "&";
289		html(delim);
290		html("q=");
291		html_attr(pattern);
292	}
293	if (ofs > 0) {
294		html(delim);
295		html("ofs=");
296		htmlf("%d", ofs);
297	}
298	html("'>");
299	html_txt(name);
300	html("</a>");
301}
302
303void cgit_commit_link(char *name, char *title, char *class, char *head,
304		      char *rev)
305{
306	if (strlen(name) > ctx.cfg.max_msg_len && ctx.cfg.max_msg_len >= 15) {
307		name[ctx.cfg.max_msg_len] = '\0';
308		name[ctx.cfg.max_msg_len - 1] = '.';
309		name[ctx.cfg.max_msg_len - 2] = '.';
310		name[ctx.cfg.max_msg_len - 3] = '.';
311	}
312	reporevlink("commit", name, title, class, head, rev, NULL);
313}
314
315void cgit_refs_link(char *name, char *title, char *class, char *head,
316		    char *rev, char *path)
317{
318	reporevlink("refs", name, title, class, head, rev, path);
319}
320
321void cgit_snapshot_link(char *name, char *title, char *class, char *head,
322			char *rev, char *archivename)
323{
324	reporevlink("snapshot", name, title, class, head, rev, archivename);
325}
326
327void cgit_diff_link(char *name, char *title, char *class, char *head,
328		    char *new_rev, char *old_rev, char *path)
329{
330	char *delim;
331
332	delim = repolink(title, class, "diff", head, path);
333	if (new_rev && strcmp(new_rev, ctx.qry.head)) {
334		html(delim);
335		html("id=");
336		html_attr(new_rev);
337		delim = "&amp;";
338	}
339	if (old_rev) {
340		html(delim);
341		html("id2=");
342		html_attr(old_rev);
343	}
344	html("'>");
345	html_txt(name);
346	html("</a>");
347}
348
349void cgit_patch_link(char *name, char *title, char *class, char *head,
350		     char *rev)
351{
352	reporevlink("patch", name, title, class, head, rev, NULL);
353}
354
355void cgit_object_link(struct object *obj)
356{
357	char *page, *arg, *url;
358
359	if (obj->type == OBJ_COMMIT) {
360                cgit_commit_link(fmt("commit %s", sha1_to_hex(obj->sha1)), NULL, NULL,
361				 ctx.qry.head, sha1_to_hex(obj->sha1));
362		return;
363	} else if (obj->type == OBJ_TREE) {
364		page = "tree";
365		arg = "id";
366	} else if (obj->type == OBJ_TAG) {
367		page = "tag";
368		arg = "id";
369	} else {
370		page = "blob";
371		arg = "id";
372	}
373
374	url = cgit_pageurl(ctx.qry.repo, page,
375			   fmt("%s=%s", arg, sha1_to_hex(obj->sha1)));
376	html_link_open(url, NULL, NULL);
377	htmlf("%s %s", typename(obj->type),
378	      sha1_to_hex(obj->sha1));
379	html_link_close();
380}
381
382void cgit_print_date(time_t secs, char *format, int local_time)
383{
384	char buf[64];
385	struct tm *time;
386
387	if (!secs)
388		return;
389	if(local_time)
390		time = localtime(&secs);
391	else
392		time = gmtime(&secs);
393	strftime(buf, sizeof(buf)-1, format, time);
394	html_txt(buf);
395}
396
397void cgit_print_age(time_t t, time_t max_relative, char *format)
398{
399	time_t now, secs;
400
401	if (!t)
402		return;
403	time(&now);
404	secs = now - t;
405
406	if (secs > max_relative && max_relative >= 0) {
407		cgit_print_date(t, format, ctx.cfg.local_time);
408		return;
409	}
410
411	if (secs < TM_HOUR * 2) {
412		htmlf("<span class='age-mins'>%.0f min.</span>",
413		      secs * 1.0 / TM_MIN);
414		return;
415	}
416	if (secs < TM_DAY * 2) {
417		htmlf("<span class='age-hours'>%.0f hours</span>",
418		      secs * 1.0 / TM_HOUR);
419		return;
420	}
421	if (secs < TM_WEEK * 2) {
422		htmlf("<span class='age-days'>%.0f days</span>",
423		      secs * 1.0 / TM_DAY);
424		return;
425	}
426	if (secs < TM_MONTH * 2) {
427		htmlf("<span class='age-weeks'>%.0f weeks</span>",
428		      secs * 1.0 / TM_WEEK);
429		return;
430	}
431	if (secs < TM_YEAR * 2) {
432		htmlf("<span class='age-months'>%.0f months</span>",
433		      secs * 1.0 / TM_MONTH);
434		return;
435	}
436	htmlf("<span class='age-years'>%.0f years</span>",
437	      secs * 1.0 / TM_YEAR);
438}
439
440void cgit_print_http_headers(struct cgit_context *ctx)
441{
442	if (ctx->page.mimetype && ctx->page.charset)
443		htmlf("Content-Type: %s; charset=%s\n", ctx->page.mimetype,
444		      ctx->page.charset);
445	else if (ctx->page.mimetype)
446		htmlf("Content-Type: %s\n", ctx->page.mimetype);
447	if (ctx->page.size)
448		htmlf("Content-Length: %ld\n", ctx->page.size);
449	if (ctx->page.filename)
450		htmlf("Content-Disposition: inline; filename=\"%s\"\n",
451		      ctx->page.filename);
452	htmlf("Last-Modified: %s\n", http_date(ctx->page.modified));
453	htmlf("Expires: %s\n", http_date(ctx->page.expires));
454	html("\n");
455}
456
457void cgit_print_docstart(struct cgit_context *ctx)
458{
459	char *host = cgit_hosturl();
460	html(cgit_doctype);
461	html("<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>\n");
462	html("<head>\n");
463	html("<title>");
464	html_txt(ctx->page.title);
465	html("</title>\n");
466	htmlf("<meta name='generator' content='cgit %s'/>\n", cgit_version);
467	if (ctx->cfg.robots && *ctx->cfg.robots)
468		htmlf("<meta name='robots' content='%s'/>\n", ctx->cfg.robots);
469	html("<link rel='stylesheet' type='text/css' href='");
470	html_attr(ctx->cfg.css);
471	html("'/>\n");
472	if (ctx->cfg.favicon) {
473		html("<link rel='shortcut icon' href='");
474		html_attr(ctx->cfg.favicon);
475		html("'/>\n");
476	}
477	if (host && ctx->repo) {
478		html("<link rel='alternate' title='Atom feed' href='http://");
479		html_attr(cgit_hosturl());
480		html_attr(cgit_fileurl(ctx->repo->url, "atom", ctx->qry.path,
481				       fmt("h=%s", ctx->qry.head)));
482		html("' type='application/atom+xml'/>");
483	}
484	html("</head>\n");
485	html("<body>\n");
486}
487
488void cgit_print_docend()
489{
490	html("</div>");
491	if (ctx.cfg.footer)
492		html_include(ctx.cfg.footer);
493	else {
494		html("<div class='footer'>generated ");
495		cgit_print_date(time(NULL), FMT_LONGDATE, ctx.cfg.local_time);
496		htmlf(" by cgit %s", cgit_version);
497		html("</div>\n");
498	}
499	html("</body>\n</html>\n");
500}
501
502int print_branch_option(const char *refname, const unsigned char *sha1,
503			int flags, void *cb_data)
504{
505	char *name = (char *)refname;
506	html_option(name, name, ctx.qry.head);
507	return 0;
508}
509
510int print_archive_ref(const char *refname, const unsigned char *sha1,
511		       int flags, void *cb_data)
512{
513	struct tag *tag;
514	struct taginfo *info;
515	struct object *obj;
516	char buf[256], *url;
517	unsigned char fileid[20];
518	int *header = (int *)cb_data;
519
520	if (prefixcmp(refname, "refs/archives"))
521		return 0;
522	strncpy(buf, refname+14, sizeof(buf));
523	obj = parse_object(sha1);
524	if (!obj)
525		return 1;
526	if (obj->type == OBJ_TAG) {
527		tag = lookup_tag(sha1);
528		if (!tag || parse_tag(tag) || !(info = cgit_parse_tag(tag)))
529			return 0;
530		hashcpy(fileid, tag->tagged->sha1);
531	} else if (obj->type != OBJ_BLOB) {
532		return 0;
533	} else {
534		hashcpy(fileid, sha1);
535	}
536	if (!*header) {
537		html("<h1>download</h1>\n");
538		*header = 1;
539	}
540	url = cgit_pageurl(ctx.qry.repo, "blob",
541			   fmt("id=%s&amp;path=%s", sha1_to_hex(fileid),
542			       buf));
543	html_link_open(url, NULL, "menu");
544	html_txt(strlpart(buf, 20));
545	html_link_close();
546	return 0;
547}
548
549void add_hidden_formfields(int incl_head, int incl_search, char *page)
550{
551	char *url;
552
553	if (!ctx.cfg.virtual_root) {
554		url = fmt("%s/%s", ctx.qry.repo, page);
555		if (ctx.qry.path)
556			url = fmt("%s/%s", url, ctx.qry.path);
557		html_hidden("url", url);
558	}
559
560	if (incl_head && ctx.qry.head && ctx.repo->defbranch &&
561	    strcmp(ctx.qry.head, ctx.repo->defbranch))
562		html_hidden("h", ctx.qry.head);
563
564	if (ctx.qry.sha1)
565		html_hidden("id", ctx.qry.sha1);
566	if (ctx.qry.sha2)
567		html_hidden("id2", ctx.qry.sha2);
568
569	if (incl_search) {
570		if (ctx.qry.grep)
571			html_hidden("qt", ctx.qry.grep);
572		if (ctx.qry.search)
573			html_hidden("q", ctx.qry.search);
574	}
575}
576
577char *hc(struct cgit_cmd *cmd, const char *page)
578{
579	return (strcmp(cmd->name, page) ? NULL : "active");
580}
581
582void cgit_print_pageheader(struct cgit_context *ctx)
583{
584	struct cgit_cmd *cmd = cgit_get_cmd(ctx);
585
586	html("<table id='header'>\n");
587	html("<tr>\n");
588	html("<td class='logo' rowspan='2'><a href='");
589	if (ctx->cfg.logo_link)
590		html_attr(ctx->cfg.logo_link);
591	else
592		html_attr(cgit_rooturl());
593	html("'><img src='");
594	html_attr(ctx->cfg.logo);
595	html("' alt='cgit logo'/></a></td>\n");
596
597	html("<td class='main'>");
598	if (ctx->repo) {
599		cgit_index_link("index", NULL, NULL, NULL, 0);
600		html(" : ");
601		reporevlink(NULL, ctx->repo->name, NULL, hc(cmd, "summary"),
602			    ctx->qry.head, NULL, NULL);
603		html("</td><td class='form'>");
604		html("<form method='get' action=''>\n");
605		add_hidden_formfields(0, 1, ctx->qry.page);
606		html("<select name='h' onchange='this.form.submit();'>\n");
607		for_each_branch_ref(print_branch_option, ctx->qry.head);
608		html("</select> ");
609		html("<input type='submit' name='' value='switch'/>");
610		html("</form>");
611	} else
612		html_txt(ctx->cfg.root_title);
613	html("</td></tr>\n");
614
615	html("<tr><td class='sub'>");
616	if (ctx->repo) {
617		html_txt(ctx->repo->desc);
618		html("</td><td class='sub right'>");
619		html_txt(ctx->repo->owner);
620	} else {
621		if (ctx->cfg.root_desc)
622			html_txt(ctx->cfg.root_desc);
623		else if (ctx->cfg.index_info)
624			html_include(ctx->cfg.index_info);
625	}
626	html("</td></tr></table>\n");
627
628	html("<table class='tabs'><tr><td>\n");
629	if (ctx->repo) {
630		reporevlink(NULL, "summary", NULL, hc(cmd, "summary"),
631			    ctx->qry.head, NULL, NULL);
632		cgit_refs_link("refs", NULL, hc(cmd, "refs"), ctx->qry.head,
633			       ctx->qry.sha1, NULL);
634		cgit_log_link("log", NULL, hc(cmd, "log"), ctx->qry.head,
635			      NULL, NULL, 0, NULL, NULL);
636		cgit_tree_link("tree", NULL, hc(cmd, "tree"), ctx->qry.head,
637			       ctx->qry.sha1, NULL);
638		cgit_commit_link("commit", NULL, hc(cmd, "commit"),
639				 ctx->qry.head, ctx->qry.sha1);
640		cgit_diff_link("diff", NULL, hc(cmd, "diff"), ctx->qry.head,
641			       ctx->qry.sha1, ctx->qry.sha2, NULL);
642		if (ctx->repo->readme)
643			reporevlink("about", "about", NULL,
644				    hc(cmd, "about"), ctx->qry.head, NULL,
645				    NULL);
646		html("</td><td class='form'>");
647		html("<form class='right' method='get' action='");
648		if (ctx->cfg.virtual_root)
649			html_attr(cgit_fileurl(ctx->qry.repo, "log",
650					       ctx->qry.path, NULL));
651		html("'>\n");
652		add_hidden_formfields(1, 0, "log");
653		html("<select name='qt'>\n");
654		html_option("grep", "log msg", ctx->qry.grep);
655		html_option("author", "author", ctx->qry.grep);
656		html_option("committer", "committer", ctx->qry.grep);
657		html("</select>\n");
658		html("<input class='txt' type='text' size='10' name='q' value='");
659		html_attr(ctx->qry.search);
660		html("'/>\n");
661		html("<input type='submit' value='search'/>\n");
662		html("</form>\n");
663	} else {
664		site_link(NULL, "index", NULL, hc(cmd, "repolist"), NULL, 0);
665		if (ctx->cfg.root_readme)
666			site_link("about", "about", NULL, hc(cmd, "about"),
667				  NULL, 0);
668		html("</td><td class='form'>");
669		html("<form method='get' action='");
670		html_attr(cgit_rooturl());
671		html("'>\n");
672		html("<input type='text' name='q' size='10' value='");
673		html_attr(ctx->qry.search);
674		html("'/>\n");
675		html("<input type='submit' value='search'/>\n");
676		html("</form>");
677	}
678	html("</td></tr></table>\n");
679	html("<div class='content'>");
680}
681
682void cgit_print_filemode(unsigned short mode)
683{
684	if (S_ISDIR(mode))
685		html("d");
686	else if (S_ISLNK(mode))
687		html("l");
688	else if (S_ISGITLINK(mode))
689		html("m");
690	else
691		html("-");
692	html_fileperm(mode >> 6);
693	html_fileperm(mode >> 3);
694	html_fileperm(mode);
695}
696
697void cgit_print_snapshot_links(const char *repo, const char *head,
698			       const char *hex, int snapshots)
699{
700	const struct cgit_snapshot_format* f;
701    	char *filename;
702
703	for (f = cgit_snapshot_formats; f->suffix; f++) {
704		if (!(snapshots & f->bit))
705			continue;
706		filename = fmt("%s-%s%s", cgit_repobasename(repo), hex,
707			       f->suffix);
708		cgit_snapshot_link(filename, NULL, NULL, (char *)head,
709				   (char *)hex, filename);
710		html("<br/>");
711	}
712}