all repos — cgit @ 9c8be943f72b6f1bda5a31ce401899c3dd734e98

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_url_path(ctx.cfg.virtual_root);
210		if (ctx.cfg.virtual_root[strlen(ctx.cfg.virtual_root) - 1] != '/')
211			html("/");
212		html_url_path(ctx.repo->url);
213		if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
214			html("/");
215		if (page) {
216			html_url_path(page);
217			html("/");
218			if (path)
219				html_url_path(path);
220		}
221	} else {
222		html(ctx.cfg.script_name);
223		html("?url=");
224		html_url_arg(ctx.repo->url);
225		if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
226			html("/");
227		if (page) {
228			html_url_arg(page);
229			html("/");
230			if (path)
231				html_url_arg(path);
232		}
233		delim = "&amp;";
234	}
235	if (head && strcmp(head, ctx.repo->defbranch)) {
236		html(delim);
237		html("h=");
238		html_url_arg(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_url_arg(rev);
254	}
255	html("'>");
256	html_txt(name);
257	html("</a>");
258}
259
260void cgit_summary_link(char *name, char *title, char *class, char *head)
261{
262	reporevlink(NULL, name, title, class, head, NULL, NULL);
263}
264
265void cgit_tag_link(char *name, char *title, char *class, char *head,
266		   char *rev)
267{
268	reporevlink("tag", name, title, class, head, rev, NULL);
269}
270
271void cgit_tree_link(char *name, char *title, char *class, char *head,
272		    char *rev, char *path)
273{
274	reporevlink("tree", name, title, class, head, rev, path);
275}
276
277void cgit_plain_link(char *name, char *title, char *class, char *head,
278		     char *rev, char *path)
279{
280	reporevlink("plain", name, title, class, head, rev, path);
281}
282
283void cgit_log_link(char *name, char *title, char *class, char *head,
284		   char *rev, char *path, int ofs, char *grep, char *pattern)
285{
286	char *delim;
287
288	delim = repolink(title, class, "log", head, path);
289	if (rev && strcmp(rev, ctx.qry.head)) {
290		html(delim);
291		html("id=");
292		html_url_arg(rev);
293		delim = "&";
294	}
295	if (grep && pattern) {
296		html(delim);
297		html("qt=");
298		html_url_arg(grep);
299		delim = "&";
300		html(delim);
301		html("q=");
302		html_url_arg(pattern);
303	}
304	if (ofs > 0) {
305		html(delim);
306		html("ofs=");
307		htmlf("%d", ofs);
308	}
309	html("'>");
310	html_txt(name);
311	html("</a>");
312}
313
314void cgit_commit_link(char *name, char *title, char *class, char *head,
315		      char *rev)
316{
317	if (strlen(name) > ctx.cfg.max_msg_len && ctx.cfg.max_msg_len >= 15) {
318		name[ctx.cfg.max_msg_len] = '\0';
319		name[ctx.cfg.max_msg_len - 1] = '.';
320		name[ctx.cfg.max_msg_len - 2] = '.';
321		name[ctx.cfg.max_msg_len - 3] = '.';
322	}
323	reporevlink("commit", name, title, class, head, rev, NULL);
324}
325
326void cgit_refs_link(char *name, char *title, char *class, char *head,
327		    char *rev, char *path)
328{
329	reporevlink("refs", name, title, class, head, rev, path);
330}
331
332void cgit_snapshot_link(char *name, char *title, char *class, char *head,
333			char *rev, char *archivename)
334{
335	reporevlink("snapshot", name, title, class, head, rev, archivename);
336}
337
338void cgit_diff_link(char *name, char *title, char *class, char *head,
339		    char *new_rev, char *old_rev, char *path)
340{
341	char *delim;
342
343	delim = repolink(title, class, "diff", head, path);
344	if (new_rev && strcmp(new_rev, ctx.qry.head)) {
345		html(delim);
346		html("id=");
347		html_url_arg(new_rev);
348		delim = "&amp;";
349	}
350	if (old_rev) {
351		html(delim);
352		html("id2=");
353		html_url_arg(old_rev);
354	}
355	html("'>");
356	html_txt(name);
357	html("</a>");
358}
359
360void cgit_patch_link(char *name, char *title, char *class, char *head,
361		     char *rev)
362{
363	reporevlink("patch", name, title, class, head, rev, NULL);
364}
365
366void cgit_object_link(struct object *obj)
367{
368	char *page, *shortrev, *fullrev, *name;
369
370	fullrev = sha1_to_hex(obj->sha1);
371	shortrev = xstrdup(fullrev);
372	shortrev[10] = '\0';
373	if (obj->type == OBJ_COMMIT) {
374                cgit_commit_link(fmt("commit %s...", shortrev), NULL, NULL,
375				 ctx.qry.head, fullrev);
376		return;
377	} else if (obj->type == OBJ_TREE)
378		page = "tree";
379	else if (obj->type == OBJ_TAG)
380		page = "tag";
381	else
382		page = "blob";
383	name = fmt("%s %s...", typename(obj->type), shortrev);
384	reporevlink(page, name, NULL, NULL, ctx.qry.head, fullrev, NULL);
385}
386
387void cgit_print_date(time_t secs, char *format, int local_time)
388{
389	char buf[64];
390	struct tm *time;
391
392	if (!secs)
393		return;
394	if(local_time)
395		time = localtime(&secs);
396	else
397		time = gmtime(&secs);
398	strftime(buf, sizeof(buf)-1, format, time);
399	html_txt(buf);
400}
401
402void cgit_print_age(time_t t, time_t max_relative, char *format)
403{
404	time_t now, secs;
405
406	if (!t)
407		return;
408	time(&now);
409	secs = now - t;
410
411	if (secs > max_relative && max_relative >= 0) {
412		cgit_print_date(t, format, ctx.cfg.local_time);
413		return;
414	}
415
416	if (secs < TM_HOUR * 2) {
417		htmlf("<span class='age-mins'>%.0f min.</span>",
418		      secs * 1.0 / TM_MIN);
419		return;
420	}
421	if (secs < TM_DAY * 2) {
422		htmlf("<span class='age-hours'>%.0f hours</span>",
423		      secs * 1.0 / TM_HOUR);
424		return;
425	}
426	if (secs < TM_WEEK * 2) {
427		htmlf("<span class='age-days'>%.0f days</span>",
428		      secs * 1.0 / TM_DAY);
429		return;
430	}
431	if (secs < TM_MONTH * 2) {
432		htmlf("<span class='age-weeks'>%.0f weeks</span>",
433		      secs * 1.0 / TM_WEEK);
434		return;
435	}
436	if (secs < TM_YEAR * 2) {
437		htmlf("<span class='age-months'>%.0f months</span>",
438		      secs * 1.0 / TM_MONTH);
439		return;
440	}
441	htmlf("<span class='age-years'>%.0f years</span>",
442	      secs * 1.0 / TM_YEAR);
443}
444
445void cgit_print_http_headers(struct cgit_context *ctx)
446{
447	if (ctx->page.mimetype && ctx->page.charset)
448		htmlf("Content-Type: %s; charset=%s\n", ctx->page.mimetype,
449		      ctx->page.charset);
450	else if (ctx->page.mimetype)
451		htmlf("Content-Type: %s\n", ctx->page.mimetype);
452	if (ctx->page.size)
453		htmlf("Content-Length: %ld\n", ctx->page.size);
454	if (ctx->page.filename)
455		htmlf("Content-Disposition: inline; filename=\"%s\"\n",
456		      ctx->page.filename);
457	htmlf("Last-Modified: %s\n", http_date(ctx->page.modified));
458	htmlf("Expires: %s\n", http_date(ctx->page.expires));
459	html("\n");
460}
461
462void cgit_print_docstart(struct cgit_context *ctx)
463{
464	char *host = cgit_hosturl();
465	html(cgit_doctype);
466	html("<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>\n");
467	html("<head>\n");
468	html("<title>");
469	html_txt(ctx->page.title);
470	html("</title>\n");
471	htmlf("<meta name='generator' content='cgit %s'/>\n", cgit_version);
472	if (ctx->cfg.robots && *ctx->cfg.robots)
473		htmlf("<meta name='robots' content='%s'/>\n", ctx->cfg.robots);
474	html("<link rel='stylesheet' type='text/css' href='");
475	html_attr(ctx->cfg.css);
476	html("'/>\n");
477	if (ctx->cfg.favicon) {
478		html("<link rel='shortcut icon' href='");
479		html_attr(ctx->cfg.favicon);
480		html("'/>\n");
481	}
482	if (host && ctx->repo) {
483		html("<link rel='alternate' title='Atom feed' href='http://");
484		html_attr(cgit_hosturl());
485		html_attr(cgit_fileurl(ctx->repo->url, "atom", ctx->qry.path,
486				       fmt("h=%s", ctx->qry.head)));
487		html("' type='application/atom+xml'/>");
488	}
489	html("</head>\n");
490	html("<body>\n");
491}
492
493void cgit_print_docend()
494{
495	html("</div>");
496	if (ctx.cfg.footer)
497		html_include(ctx.cfg.footer);
498	else {
499		htmlf("<div class='footer'>generated  by cgit %s at ",
500			cgit_version);
501		cgit_print_date(time(NULL), FMT_LONGDATE, ctx.cfg.local_time);
502		html("</div>\n");
503	}
504	html("</body>\n</html>\n");
505}
506
507int print_branch_option(const char *refname, const unsigned char *sha1,
508			int flags, void *cb_data)
509{
510	char *name = (char *)refname;
511	html_option(name, name, ctx.qry.head);
512	return 0;
513}
514
515int print_archive_ref(const char *refname, const unsigned char *sha1,
516		       int flags, void *cb_data)
517{
518	struct tag *tag;
519	struct taginfo *info;
520	struct object *obj;
521	char buf[256], *url;
522	unsigned char fileid[20];
523	int *header = (int *)cb_data;
524
525	if (prefixcmp(refname, "refs/archives"))
526		return 0;
527	strncpy(buf, refname+14, sizeof(buf));
528	obj = parse_object(sha1);
529	if (!obj)
530		return 1;
531	if (obj->type == OBJ_TAG) {
532		tag = lookup_tag(sha1);
533		if (!tag || parse_tag(tag) || !(info = cgit_parse_tag(tag)))
534			return 0;
535		hashcpy(fileid, tag->tagged->sha1);
536	} else if (obj->type != OBJ_BLOB) {
537		return 0;
538	} else {
539		hashcpy(fileid, sha1);
540	}
541	if (!*header) {
542		html("<h1>download</h1>\n");
543		*header = 1;
544	}
545	url = cgit_pageurl(ctx.qry.repo, "blob",
546			   fmt("id=%s&amp;path=%s", sha1_to_hex(fileid),
547			       buf));
548	html_link_open(url, NULL, "menu");
549	html_txt(strlpart(buf, 20));
550	html_link_close();
551	return 0;
552}
553
554void add_hidden_formfields(int incl_head, int incl_search, char *page)
555{
556	char *url;
557
558	if (!ctx.cfg.virtual_root) {
559		url = fmt("%s/%s", ctx.qry.repo, page);
560		if (ctx.qry.path)
561			url = fmt("%s/%s", url, ctx.qry.path);
562		html_hidden("url", url);
563	}
564
565	if (incl_head && ctx.qry.head && ctx.repo->defbranch &&
566	    strcmp(ctx.qry.head, ctx.repo->defbranch))
567		html_hidden("h", ctx.qry.head);
568
569	if (ctx.qry.sha1)
570		html_hidden("id", ctx.qry.sha1);
571	if (ctx.qry.sha2)
572		html_hidden("id2", ctx.qry.sha2);
573
574	if (incl_search) {
575		if (ctx.qry.grep)
576			html_hidden("qt", ctx.qry.grep);
577		if (ctx.qry.search)
578			html_hidden("q", ctx.qry.search);
579	}
580}
581
582char *hc(struct cgit_cmd *cmd, const char *page)
583{
584	return (strcmp(cmd->name, page) ? NULL : "active");
585}
586
587void cgit_print_pageheader(struct cgit_context *ctx)
588{
589	struct cgit_cmd *cmd = cgit_get_cmd(ctx);
590
591	html("<table id='header'>\n");
592	html("<tr>\n");
593	html("<td class='logo' rowspan='2'><a href='");
594	if (ctx->cfg.logo_link)
595		html_attr(ctx->cfg.logo_link);
596	else
597		html_attr(cgit_rooturl());
598	html("'><img src='");
599	html_attr(ctx->cfg.logo);
600	html("' alt='cgit logo'/></a></td>\n");
601
602	html("<td class='main'>");
603	if (ctx->repo) {
604		cgit_index_link("index", NULL, NULL, NULL, 0);
605		html(" : ");
606		cgit_summary_link(ctx->repo->name, ctx->repo->name, NULL, NULL);
607		html("</td><td class='form'>");
608		html("<form method='get' action=''>\n");
609		add_hidden_formfields(0, 1, ctx->qry.page);
610		html("<select name='h' onchange='this.form.submit();'>\n");
611		for_each_branch_ref(print_branch_option, ctx->qry.head);
612		html("</select> ");
613		html("<input type='submit' name='' value='switch'/>");
614		html("</form>");
615	} else
616		html_txt(ctx->cfg.root_title);
617	html("</td></tr>\n");
618
619	html("<tr><td class='sub'>");
620	if (ctx->repo) {
621		html_txt(ctx->repo->desc);
622		html("</td><td class='sub right'>");
623		html_txt(ctx->repo->owner);
624	} else {
625		if (ctx->cfg.root_desc)
626			html_txt(ctx->cfg.root_desc);
627		else if (ctx->cfg.index_info)
628			html_include(ctx->cfg.index_info);
629	}
630	html("</td></tr></table>\n");
631
632	html("<table class='tabs'><tr><td>\n");
633	if (ctx->repo) {
634		cgit_summary_link("summary", NULL, hc(cmd, "summary"),
635				  ctx->qry.head);
636		cgit_refs_link("refs", NULL, hc(cmd, "refs"), ctx->qry.head,
637			       ctx->qry.sha1, NULL);
638		cgit_log_link("log", NULL, hc(cmd, "log"), ctx->qry.head,
639			      NULL, NULL, 0, NULL, NULL);
640		cgit_tree_link("tree", NULL, hc(cmd, "tree"), ctx->qry.head,
641			       ctx->qry.sha1, NULL);
642		cgit_commit_link("commit", NULL, hc(cmd, "commit"),
643				 ctx->qry.head, ctx->qry.sha1);
644		cgit_diff_link("diff", NULL, hc(cmd, "diff"), ctx->qry.head,
645			       ctx->qry.sha1, ctx->qry.sha2, NULL);
646		if (ctx->repo->readme)
647			reporevlink("about", "about", NULL,
648				    hc(cmd, "about"), ctx->qry.head, NULL,
649				    NULL);
650		html("</td><td class='form'>");
651		html("<form class='right' method='get' action='");
652		if (ctx->cfg.virtual_root)
653			html_url_path(cgit_fileurl(ctx->qry.repo, "log",
654						   ctx->qry.path, NULL));
655		html("'>\n");
656		add_hidden_formfields(1, 0, "log");
657		html("<select name='qt'>\n");
658		html_option("grep", "log msg", ctx->qry.grep);
659		html_option("author", "author", ctx->qry.grep);
660		html_option("committer", "committer", ctx->qry.grep);
661		html("</select>\n");
662		html("<input class='txt' type='text' size='10' name='q' value='");
663		html_attr(ctx->qry.search);
664		html("'/>\n");
665		html("<input type='submit' value='search'/>\n");
666		html("</form>\n");
667	} else {
668		site_link(NULL, "index", NULL, hc(cmd, "repolist"), NULL, 0);
669		if (ctx->cfg.root_readme)
670			site_link("about", "about", NULL, hc(cmd, "about"),
671				  NULL, 0);
672		html("</td><td class='form'>");
673		html("<form method='get' action='");
674		html_attr(cgit_rooturl());
675		html("'>\n");
676		html("<input type='text' name='q' size='10' value='");
677		html_attr(ctx->qry.search);
678		html("'/>\n");
679		html("<input type='submit' value='search'/>\n");
680		html("</form>");
681	}
682	html("</td></tr></table>\n");
683	html("<div class='content'>");
684}
685
686void cgit_print_filemode(unsigned short mode)
687{
688	if (S_ISDIR(mode))
689		html("d");
690	else if (S_ISLNK(mode))
691		html("l");
692	else if (S_ISGITLINK(mode))
693		html("m");
694	else
695		html("-");
696	html_fileperm(mode >> 6);
697	html_fileperm(mode >> 3);
698	html_fileperm(mode);
699}
700
701void cgit_print_snapshot_links(const char *repo, const char *head,
702			       const char *hex, int snapshots)
703{
704	const struct cgit_snapshot_format* f;
705    	char *filename;
706
707	for (f = cgit_snapshot_formats; f->suffix; f++) {
708		if (!(snapshots & f->bit))
709			continue;
710		filename = fmt("%s-%s%s", cgit_repobasename(repo), hex,
711			       f->suffix);
712		cgit_snapshot_link(filename, NULL, NULL, NULL, NULL, filename);
713		html("<br/>");
714	}
715}