all repos — cgit @ 65b7b876aaaf50fc15060533359d6561f4f1819a

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