all repos — cgit @ ef688e16f05a5a3438e63645852c436fe33fab71

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